ChecklistLibraryChecklistItems

This entity describes list items added to a check list on an Autotask ticket or task. A checklist is an optional feature on the ticket or task detail page. It displays a numbered list of items to complete as work is done. The check list is visible only when items are added to it. This entity allows checklist items to be added, deleted, and updated via the API. A checklist can have no more than 40 checklist items.

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: ChecklistLibraryChecklistItems

Entity Path:

/atservicesrest/v1.0/ChecklistLibraryChecklistItems
Parent Entity: ChecklistLibraries
Can Create:
Can Update:
Can Query:
Can Delete:
Can Have UDFs:  

Conditions and requirements

  • There is a limit of 40 checklist items per checklist. Exceeding the maximum number of checklist items returns an error.
  • Security level permissions to Admin > Features & Settings > Application-wide (Shared) Features are required. Refer to The Checklist Library.
  • Task OR Ticket checklist permissions (or both) to add/edit or delete Library Checklists are required. Refer to Ticket Checklist permissions and Projects permissions.
  • On create or update, Position inserts the item or the batch above the current item. On create, if Position is blank, the checklist item is added to the end of the list. On update, if Position is blank, it will be ignored and the checklist item remains in the 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
checklistLibraryID integer ChecklistLibraries  
id long    
isImportant boolean        
itemName string (600)      
knowledgebaseArticleID integer      
position integer        

Additional resources