KnowledgeBaseArticles
This entity represents articles created by Knowledgebase users 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: | KnowledgeBaseArticle |
|
Entity Path: |
/atservicesrest/v1.0/KnowledgeBaseArticle |
| 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 | KnowledgeBaseCategories |
| Children |
ArticlePlainTextContent, ArticleAttachments, ArticleTagAssociations, ArticleTicketAssociations, ArticleToArticleAssociations, ArticleToDocumentAssociations, ArticleConfigurationItemCategoryAssociations, ArticleNotes |
| URLs |
KnowledgeBaseArticles/{id} (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 Add, Edit and Delete object permissions for Articles to make changes to this entity.
-
Knowledgebase articles are created in a Published status when generated via the API. To create or update children of this entity, your API User must have Approve object permissions for Articles.
-
Approval status and draft content are not visible via the API.
-
The API will only return Knowledgebase articles in a published status.
-
The API will not allow delete or update of an article if there is a version of the same article in any draft status.
-
Global Articles are not accessible via the API.
-
The API will always return the most recent version of a Knowledgebase article.
Special field attributes
| Field | Conditions and Requirements |
|---|---|
| content |
IMPORTANT Updates to the content field will remove any Rich Text formatting and embedded images that it contains. |
| lastModifiedByResourceID, lastModifiedDateTime | These fields will always match the most recent version in the entity's history. |
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 |
|---|---|---|---|---|---|
| articleCategoryID | integer |
|
|
KnowledgeBaseCategories | |
| createdByResourceID | integer |
|
Resources | ||
| createdDateTime | datetime |
|
|||
| errorCodes | string (200) | ||||
| id | long |
|
|
||
| isActive | boolean | ||||
| keywords | string (300) | ||||
| lastModifiedByResourceID | integer |
|
Resources | ||
| lastModifiedDateTime | datetime |
|
|||
| publish | integer |
|
|
||
| referenceLink | string (500) | ||||
| title | string (200) |
|
