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.

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

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)      

Additional resources