TicketChecklistLibraries

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 ChecklistLibraryChecklistItems to query all the checklist items you wish to add and then use the TicketChecklistItems entity to create the items on the ticket with a specified Position value.

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

Entity Path:

/atservicesrest/v1.0/TicketChecklistLibraries

Parent Entity:

Tickets

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 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      
ticketID integer   Tickets  

Additional resources