TicketChecklistItem

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

This entity describes list items added to a check list on an Autotask ticket. A checklist is an optional feature on the ticket 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 check list items to be added, deleted, and updated via the API. A checklist can have no more than 40 checklist items.

Entity details

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

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

Conditions and requirements

  • A ticket can have only one checklist.
  • There is a limit of 40 TicketChecklistItems per TicketID.
  • TicketChecklistItem respects Security Level permissions to view tickets and to create, update, delete, and "uncomplete" TicketChecklistItems.
  • On create, if Position is blank, TicketChecklistItem is added to the end of the list. On update, if Position is blank, it will be ignored and TicketChecklistItem remains in the current position.
  • TicketID is read only; a TicketChecklistItem cannot be moved from one ticket to another via the API.

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
Completed Completed boolean        
CompletedByResourceID Completed By Resource ID integer   Resource  
CompletedDateTime Completed Date datetime      
id Ticket Checklist Item ID Int64    
Important Important boolean        
ItemName Name string (600)      
KnowledgebaseArticleID Knowledgebase Article ID integer      
Position Position Int32        
TicketID Ticket integer Ticket