ArticleToArticleAssociations

This entity represents associations between Knowledgebase articles within 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: ArticleToArticleAssociation

Entity Path:

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

Parent KnowledgeBaseArticles
URLs:

ArticleToArticleAssociations/{id} (GET)
ArticleToArticleAssociations/query (GET, POST)
ArticleToArticleAssociations/query/count (GET, POST)
ArticleToArticleAssociations/entityInformation (GET)
ArticleToArticleAssociations/entityInformation/fields (GET)

Conditions and requirements

General

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

  • Global Articles are not accessible via the API.

Special field attributes

The articleID and associatedArticleID combination must be unique. You cannot create the same association more than once via the API. A Delete action on an {id} will delete both association records, as one can't exist without the other.

Article and document associations are stored in a way that their relationship is defined twice - once for the articleID to associatedArticleID association and once for the associatedArticleID to articleID association.

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 .../ArticleToArticleAssociations/query?search={ "filter":[{"op" : "exist", "field" : "id" }]}

One record:

GET .../ArticleToArticleAssociations/{id}
GET KnowledgeBaseArticles/{parentId}/ArticleAssociations

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:

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
articleID integer   KnowledgeBaseArticles  

associatedArticleID

integer

 

KnowledgeBaseArticles

 

id

long

 

 

Additional resources