ChecklistLibraries

The ChecklistLibraries 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.

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

Entity Path:

/atservicesrest/v1.0/ChecklistLibraries

Can Create:
Can Update:
Can Query:
Can Delete:
Can Have UDFs:  

IMPORTANT  Requests to this entity require special handling. Refer to the Entity URLs and relationships section of this article for details.

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

Field Name Datatype
Read-Only Is Required Reference Name Picklist
description string (500)        
entityType integer    
id long    
isActive boolean      
name string (100)      

Additional resources