ArticleAttachments

This entity contains attachments for Knowledgebase articles 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: ArticleAttachment

Entity Path:

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

IMPORTANT  Requests to this entity require special handling. Refer to the Entity URLs and relationships section of this article for details.

Fields that cannot be queried

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

  • creatorType
  • data
  • fileSize

Conditions and requirements

General

  • 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.

  • Your API user must have the Can access Knowledgebase security permission to use this entity.

  • Your API user must have Article Edit object permissions set to All or Mine to make changes to this entity.

  • Your API user must have Add, Edit, and Delete object permissions for Attachments to make changes to this entity.

  • The API will respect the attachment requirements described in the Overview section of the AttachmentInfo (REST API) entity article.

  • Global Articles are not accessible via the API.

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

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)  

contentType

string (100)

 

 

 

errorCodes

string (200)

 

 

 

 

fullPath

string (255)

 

 

id

long

 

 

impersonatorCreatorResourceID

integer

 

Resources

 

opportunityID

long

Opportunities

 

parentAttachmentID

integer

 

AttachmentInfo (REST API)

 

parentID

long

 

 

 

title

string (255)

 

 

 

Additional resources