AttachmentInfo (REST API)

The AttachmentInfo entity describes an attachment in Autotask. Refer to the Overview section of this article to learn more about working with attachments in the Autotask REST API. For the SOAP API version of this entity, review AttachmentInfo (SOAP 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.

BEFORE YOU BEGIN  This entity is unique. You can only query it. To create or delete attachments, you must use the child collection URL for each attachment type. You can also query by using a child collection URL.

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: AttachmentInfo

Entity Path:

/atservicesrest/v1.0/AttachmentInfo

Can Create:  
Can Update:  
Can Query:
Can Delete:  
Can Have UDFs:  

Overview

Fields that cannot be queried

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

  • fileSize

Conditions and requirements

General

  • Queries that specify IDs of entities with child data will return attachments associated with those children. For example, a query that specifies a ticketID value will return all attachments that are parented to that ticket, plus any attachments that are parented to child TicketNotes, TimeEntries, and Attachments.
  • If your query supplies both an entityID and a parentID, the entityID will take precedence.

Contact impersonation validation rules for creating entities

  1. The API user security level has access to contact impersonation for attachments.
  2. Publish must always be ALL.
  3. Contacts can only create attachments for Tickets or Project/Task/Ticket Notes that they have created.
  4. The contact is active.
  5. The contact's account is active.

NOTE  To retrieve a specific attachment of a resource, your query must specify the Attachment ID of the Attachments child endpoint or the appropriate <EntityName>Attachments endpoint (such as TicketAttachments, ResourceAttachments, and so forth). Refer to Retrieving an attachment of a resource for additional details.

Field definitions

Field Name Datatype Read-Only Is Required Reference Name Picklist

articleID

integer

 

KnowledgeBaseArticles

 

attachDate datetime      
attachedByContactID long     Contacts  
attachedByResourceID long   Resources  
attachmentType string
(30)
 

companyID

integer

 

Companies

 

companyNoteID

integer

 

CompanyNotes

 

contentType string
(100)
     

contractID

integer

 

Contracts

 

contractNoteID

integer

 

ContractNoteAttachments

 

creatorType

integer

 

 

documentID

integer

 

Documents

 

expenseReportID

integer

 

ExpenseReports

 

fileSize long      
fullPath string (255)    
id long    
impersonatorCreatorResourceID integer   Resources

 

installedProductID

integer

 

ConfigurationItems

 

installedProductNoteID

integer

 

ConfigurationItemNotes

 

opportunityID long   Opportunities  

parentAttachmentID

integer

 

Multiple; varies based on parent.

 

parentID long    
parentType integer  

projectID

integer

 

Projects

 

projectNoteID

integer

 

ProjectNotes

 

publish integer  

resourceID

integer

 

Resources

 

salesOrderID

integer

 

SalesOrders

 

taskID

integer

 

Tasks

 

taskNoteID

integer

 

TaskNotes

 

ticketID

integer

 

Tickets

 

ticketNoteID

integer

 

TicketNotes

 

timeEntryID

integer

 

TimeEntries

 

title string (255)    

Additional resources