DocumentChecklistItems

This entity contains checklist items related to 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: DocumentChecklistItem

Entity Path:

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

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 DocumentChecklistItems​/query (GET) DocumentChecklistItems​/query (POST)
DocumentChecklistItems​/{id} (GET) DocumentChecklistItems​/query​/count (GET) DocumentChecklistItems​/query​/count (POST) ​DocumentChecklistItems​/entityInformation (GET) DocumentChecklistItems​/entityInformation​/fields (GET) DocumentChecklistItems​/entityInformation​/userDefinedFields (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 Edit object permissions for Documents & Document References to make changes to this entity.

  • There is a limit of 40 items per checklist. Exceeding the maximum number of items will return an error.

  • Checklist items cannot be moved from one document to another via the API.

Special field attributes

Field Conditions and Requirements
Position On create, if Position is blank, checklist items will be added to the end of the list. On update, if Position is blank, checklist items will remain in their current position.

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
documentID integer Documents  

id

long

 

 

isImportant

boolean

 

 

 

 

itemName

string (600)

 

 

 

position

integer

 

 

 

 

Additional resources