DocumentToArticleAssociations

This entity represents documents associated with Knowledgebase articles in Autotask.

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

Entity Path:

/atservicesrest/v1.0/DocumentArticleAssociations
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.

Conditions and requirements

General

  • Documentation Management must be enabled in Autotask at > Admin > Extensions & Integrations > Installed Modules > Documentation for document management endpoints to function.

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

  • To manage ticket associations, your API user must have edit access to the selected document.

  • DocumentID and ArticleID combinations must be unique.

Special field attributes

The articleID and associatedDocumentID combination must be unique. You cannot create the same association more than once via the API.

Article and document associations are stored in a way that their relationship is defined twice - once for the articleID to associatedDocumentID association and once for the associatedDocumentID to articleID association. A Delete action on an {id} will delete both association records, as one can't exist without the other.

In most scenarios this situation won't be seen by or impact the API. However, there is a circumstance in which two records instead of one record per association can be returned.

Two records:

GET .../ArticleToDocumentAssociations/query?search={ "filter":[{"op" : "exist", "field" : "id" }]}

One record:

GET .../ArticleToDocumentAssociations/{id}
GET KnowledgeBaseArticles/{parentId}/DocumentAssociations

Field definitions

Field Name Datatype Read-Only Is Required Reference Name Picklist
associatedArticleID integer   KnowledgeBaseArticles  
documentID

integer

 

Documents

 
id

long

 

 

Additional resources