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.
Entity URLs and relationships
- 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 |
| URLs | DocumentArticleAssociations/{id} (GET) DocumentArticleAssociations/query (GET, POST) DocumentArticleAssociations/query/count (GET, POST) DocumentArticleAssociations/entityInformation (GET) DocumentArticleAssociations/entityInformation/fields (GET) |
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
About this table
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 |
|---|---|---|---|---|---|
| associatedArticleID | integer |
|
KnowledgeBaseArticles | ||
| documentID |
integer |
|
|
|
|
| id |
long |
|
|
|
|
