DocumentCategories

This entity represents the categories for documents 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: DocumentCategory

Entity Path:

/atservicesrest/v1.0/DocumentCategories
Can Create:
Can Update:
Can Query:
Can Delete:
Can Have UDFs:  

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 None
Children Documents
URLs DocumentCategories/{id} (GET, DELETE)
DocumentCategories/query (GET, POST)
DocumentCategories/query/count (GET, POST)
DocumentCategories/ (POST, PUT, PATCH)
DocumentCategories/entityInformation (GET)
DocumentCategories/entityInformation/fields (GET)

Conditions and requirements

General

  • Knowledgebase must be enabled in Autotask at > Admin > Features & Settings > Application-Wide (Shared) Features > Knowledgebase for the API entity to function.

  • Documentation Management must be enabled in Autotask for document management endpoints to function.

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

  • Up to three levels of parent categories are allowed or three sub-levels under "All Articles"

  • Delete of a category causes any associated articles to be associated with the parent.

  • Name and parentCategoryID combinations must be unique.

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
description string (1000)        

id

long

 

 
name string (50)      
parentCategoryID integer   DocumentCategories

Additional resources