Attachment DTO v17

Attachment represents a binary file together with name, description and a reference to any other object. This object gets usually linked to activities where one can attach photos and audio notes or even pdf documents and other documents (depending on the client).

For information on default max attachment size, refer to the following guide.

Field Name Type Required Constraint Reference Description
category String Optional length >= 1 & length <= 255

Allowed values are defined into Enumerations having enumType = ATTACHMENT_CATEGORY.
For learning about Enumerations, please check this.
Provides a way of grouping attachments into categories.
description String Optional length >= 1 Contains description of the given attachment.
fileContent byte Optional The field is no longer supported on the database. The field is no longer supported on the database. The binary content (base64 encoded) of the attachment.
fileName String Required length >= 1 & length <= 255 Name of the attached file.
object ObjectRef Required Referenced object for this attachment, standard referenced objects are activities.
ordinal Integer Optional Provides a way of ordering attachments.
sourceObject ObjectRef Optional Source object out of which this attachment was created, e.g. a checklist instance for attachment containing checklist report.
title String Optional length >= 1 & length <= 255 Attachment title.
type ContentType Optional Allowed values { PNG, TIFF, GIF, JPG, JPEG, TXT, RTF, HTML, HTM, XML, PDF, DOC, XLS, PPT, PPTX, XLSX, DOCX, MP4, AAC, MSG, ZIP, TIF, DWG, DWF, DXF, MOV, M4V, THREEGP, BMP, ICO, CUR, XBM, CALENDAR } Type of the attachment (is also used to load the appropriate viewer on the client devices).
syncWithErp Boolean Optional Flag determining if attachment should be send to ERP/SAP system, default value is true.