ChecklistLibraryChecklistItem

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

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 100 checklist items.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: ChecklistLibraryChecklistItem
Can Create:
Can Update:
Can Query:
Can Delete:
Can Have UDFs:  

Conditions and requirements

  • There is a limit of 100 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 field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

Field Name Label Datatype
 Read Only Is Required Reference Name Picklist
ChecklistLibraryID Checklist Library ID integer ChecklistLibrary  
id Checklist Library Checklist Item ID long    
Important Important boolean        
ItemName Name string (600)      
KnowledgebaseArticleID Knowledgebase Article ID integer      
Position Position integer