ChecklistLibrary

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.

The ChecklistLibrary entity describes a modular component that can be added to any ticket or task. It outlines the steps that must be performed to complete the ticket or task, and tracks the resource and date/time each step was completed.

Entity details

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

Entity Name: ChecklistLibrary
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.

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
Active Active boolean      
Description Description string (500)        
EntityType Entity integer    
id Checklist Library ID long    
Name Name string (100)