TicketChecklistLibrary

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will be deactivated.

This entity allows all items in a checklist library to be added to a ticket. If a ticket already has checklist items, the checklist library is appended to the end of the list of checklist items.

NOTE  If you need to add the checklist in a different order on the ticket, you should use ChecklistLibraryChecklistItem to query all the checklist items you wish to add and then use the TicketChecklistItem entity to create the items on the ticket with a specified Position value.

Entity details

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

Entity Name: TicketChecklistLibrary
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.
  • Ticket checklist permissions to add/edit or delete Library Checklists are required. Refer to Ticket Checklist permissions.
  • Trying to add an inactive checklist will return an error message.

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 TicketChecklist Library ID long      
TicketID Ticket ID integer   Ticket