Changes to Attachment entities
This article explains the changes introduced to SOAP and REST Attachment entities with the release of Autotask 2021.1. It provides detail about current and future improvements, as well as links to related knowledge resources.
Index
What changed, and why?
Attachment entity changes
Previously, queries to Autotask attachment endpoints could return any attachments associated with any object and could be very inefficient across entity types.
To address this issue, we have added object ID fields to all attachment entities. Now, calls to an attachment endpoint will require the inclusion of the object you wish to query. For example, a request to the TicketAttachments entity will require a value for the ticketID field.
This improvement will enhance API performance and the granularity of the information returned to your integrations. For more information, refer to the next sections of this article.
Bug fix for Attachment entity queries
With this release, we have corrected a defect that prevented all attachments for a child entity from appearing in the parent query.
For example, tickets, ticket notes, and time entries can all have attachments, but in previous versions of Autotask, an AttachmentInfo or TicketAttachments query would return only the attachments directly attached to the ticket.
Now, the query will return all of the attachment information for the ticket, the child ticket notes, and the child time entries.
We have added the following fields to the REST entities listed.
Entities updated | Field Name | Datatype | Read-Only | Is Required | Reference Name | Picklist |
---|---|---|---|---|---|---|
AttachmentInfo, ArticleAttachments |
articleID |
integer |
|
|
|
|
companyID |
integer |
|
|
|
||
companyNoteID |
integer |
|
|
|
||
configurationItemID |
integer |
|
|
|
||
configurationItemNoteID |
integer |
|
|
|
||
contractID |
integer |
|
|
|
||
contractNoteID |
integer |
|
|
|
||
AttachmentInfo, DocumentAttachments |
documentID |
integer |
|
|
|
|
AttachmentInfo, ExpenseReportAttachments |
expenseReportID |
integer |
|
|
|
|
AttachmentInfo |
installedProductID |
integer |
|
|
|
|
AttachmentInfo |
installedProductNoteID |
integer |
|
|
|
|
opportunityID |
integer |
|
|
|
||
AttachmentInfo, TicketAttachments, TaskAttachments, CompanyAttachments, ConfigurationItemAttachments |
parentAttachmentID |
integer |
|
|
Multiple; varies based on parent. |
|
projectID |
integer |
|
|
|
||
projectNoteID |
integer |
|
|
|
||
AttachmentInfo, ResourceAttachments |
resourceID |
integer |
|
|
|
|
AttachmentInfo, SalesOrderAttachments, CompanyAttachments, CompanyNoteAttachments |
salesOrderID |
integer |
|
|
|
|
AttachmentInfo, TimeEntryAttachments, TaskAttachments, TaskNoteAttachments |
taskID |
integer |
|
|
|
|
AttachmentInfo, TaskAttachments, TaskNoteAttachments |
taskNoteID |
integer |
|
|
|
|
AttachmentInfo, TicketAttachments, TicketNoteAttchments, TimeEntryAttachments |
ticketID |
integer |
|
|
|
|
ticketNoteID |
integer |
|
|
|
||
AttachmentInfo, TicketAttachments, TimeEntryAttachments, TaskAttachments |
timeEntryID |
integer |
|
|
|
We have added the following fields to the AttachmentInfo (SOAP API) entity.
Field Name | Label | Datatype | Read Only | Is Required | Reference Name | Picklist |
---|---|---|---|---|---|---|
AccountID |
Account ID |
integer |
|
|
Account |
|
AccountNoteID |
Account Note ID |
integer |
|
|
AccountNote |
|
ContractID |
Contract ID |
integer |
|
|
Contract |
|
ContractNoteID |
Contract Note ID |
integer |
|
|
ContractNote |
|
ExpenseReportID |
Expense Report ID |
integer |
|
|
ExpenseReport |
|
InstalledProductID |
Asset ID |
integer |
|
|
InstalledProduct |
|
InstalledProductNoteID |
Asset Note ID |
integer |
|
|
InstalledProductNote |
|
ParentAttachmentID |
Parent Attachment ID |
integer |
|
|
Multiple; varies based on parent. |
|
ProjectID |
Project ID |
integer |
|
|
Project |
|
ProjectNoteID |
Project Note ID |
integer |
|
|
ProjectNote |
|
ResourceID |
Resource ID |
integer |
|
|
Resource |
|
SalesOrderID |
Sales Order ID |
integer |
|
|
SalesOrder |
|
TaskID |
Task ID |
integer |
|
|
Task |
|
TaskNoteID |
Task Note ID |
integer |
|
|
TaskNote |
|
TicketID |
Ticket ID |
integer |
|
|
Ticket |
|
TicketNoteID |
Ticket Note ID |
integer |
|
|
TicketNote |
|
TimeEntryID |
Time Entry ID |
integer |
|
|
TimeEntry |
|
Improvements to the behavior of the AttachmentInfo (REST API) entity have rendered the AttachmentNestedAttachments endpoint unnecessary. The 2021.1 release removed it.
Do I need to make any changes to my integrations?
Yes. We will remove the ParentID field in an upcoming maintenance release, and it will no longer be queryable. To prevent service disruption, we recommend that you update your integrations to use the new syntax and fields. For more information about working with attachments, refer to AttachmentInfo (REST API) AttachmentInfo (SOAP API), and Working with attachments in the REST API.