DocumentAttachments
This entity contains attachments for documents in Autotask.
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: | DocumentAttachment |
Entity Path: |
/atservicesrest/v1.0/DocumentAttachments |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
If this entity has a Parent relationship, you must perform all Create, Update, and Delete actions on the parent entity. If this entity is a child of a parent, you can leverage our Swagger instance to find the URLs you should use in your API calls. For more information, refer to Finding resource and child access URLs of REST API entities. To learn how to access Swagger, refer to Using Swagger UI to explore REST API requests.
Parent | Documents |
Children | None |
URLs | DocumentAttachments/{id} (GET, DELETE) DocumentAttachments/query (GET, POST) DocumentAttachments/query/count (GET, POST) DocumentAttachments/ (POST, PUT, PATCH) DocumentAttachments/entityInformation (GET) DocumentAttachments/entityInformation/fields (GET) Documents/{parentId}/Attachments(GET, POST) Documents/{parentId}/Attachments/{id} (GET, DELETE) Documents/{parentId}/Attachments/entityInformation (GET) Documents/{parentId}/Attachments/entityInformation/fields (GET) |
Fields that cannot be queried
The following fields from this entity will return an error when queried.
- creatorType
- data
- fileSize
Conditions and requirements
General
-
Knowledgebase must be enabled in Autotask at > Admin > Features & Settings > Application-Wide (Shared) Features > Knowledgebase for the API entity to function.
-
Documentation Management must be enabled in Autotask for document management endpoints to function.
-
Your API user must have Add and Delete object permissions for Document Attachments to make changes to this entity.
-
Content is stored in the DocumentContent child collection.
-
The API will respect the attachment requirements described in the Overview section of the AttachmentInfo (REST API) entity article.
-
If your query supplies both an entityID and a parentID, the entityID will take precedence.
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:
- The entityInformation REST API call
- Making basic query calls to the REST API
- Advanced query features of the REST API
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 |
|
|
|
|
attachedByResourceID | long | Resources | |||
attachmentType | string (30) | ||||
contentType |
string (100) |
|
|
|
|
documentID |
integer |
|
|
|
|
errorCodes |
string (200) |
|
|
|
|
fullPath |
string (255) |
|
|
|
|
impersonatorCreatorResourceID |
integer |
|
|
|
|
opportunityID |
long |
|
|
|
|
parentAttachmentID |
integer |
|
|
|
|
parentID |
long |
|
|
|
|
title |
string (255) |
|
|
|
|