TicketAttachments

This entity contains the attachments for the Tickets entity. For more information about attachments, including call syntax, thresholds and limits, and a full list of attachment entities, refer to Working with attachments in the REST API.

IMPORTANT  Attachment behavior in the API has changed. To avoid service disruption, review our Changes to Attachment entities article for important information about this recent update.

NOTE  You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.

Entity details

Entity Name: TicketAttachments

Entity Path:

/atservicesrest/v1.0/TicketAttachments
Can Create:
Can Update:  
Can Query:
Can Delete:
Can Have UDFs:  

Fields that cannot be queried

The following fields from this entity will return an error when queried.

  • creatorType
  • data
  • fileSize

Conditions and requirements

General

  • The Data field is required when you create an attachment with attachmentType = FILE_ATTACHMENT.

  • Query results will include attachments parented to TicketNotes, TimeEntries, and TicketAttachments parented to tickets with IDs referenced in the request.

  • If your query supplies both an entityID and a parentID, the entityID will take precedence.

Special field attributes

Field definitions

The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:

To learn how to query picklist endpoints, refer to Understanding picklists.

Notes

  • For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.
  • If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
  • You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name Datatype Read-Only Is Required Reference Name Picklist
attachDate datetime      
attachedByContactID long   Contacts  
attachedByResourceID long   Resources  
attachmentType string  
contentType string      
fullPath string    
id long    
impersonatorCreatorResourceID integer   Resources
opportunityID long   Opportunities  

parentAttachmentID

integer

 

Multiple; varies based on parent.

 
parentID long      
publish integer  

ticketID

integer

 

TicketAttachments

 

ticketNoteID

integer

 

TicketNotes

 

timeEntryID

integer

 

TimeEntries

 
title string    

Additional resources