TicketChangeRequestApprovals

This entity describes a record of approval for a ticket change request. The change request approval process is part of the Autotask Change Management feature set. Change Management features are only available in the Autotask UI when the Change Management module is enabled.

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

Entity Path:

/atservicesrest/v1.0/TicketChangeRequestApprovals
Parent Entity: Tickets
Can Create:
Can Update:  
Can Query:
Can Delete:
Can Have UDFs:  

Conditions and requirements

  • ticketID must be a valid ID for a ticket where ticketType = ChangeRequest.
  • Users can update data on behalf of another user.
  • resourceID must be a valid ID for an isActive resource.
  • A single ChangeRequestApproval record must have 1 resourceID or 1 contactID. The record cannot have both a resource and contact.
  • When a new resourceID is added by the user, the new resource will be added as an Other Resource Approver.

If the resource is an Other Resource Approver and is not a member of the Change Approval Board, then that Resource Approver can be deleted from the ticket. Deleting the resource will also delete all associated vote data.

  • If the Resource indicated by the Resource ID is a member of the Change Approval Board assigned to the associated ticket (ticketID), that Resource cannot be deleted from the ticket.

  • contactID must be a valid ID for an isActive contact.

  • If the contactID is not the ticket contact, primary account contact, or parent account primary contact, then the contact will be added as an Other Contact Approver.

If the contact is an Other Contact Approver and is not a member of the Change Approval Board (ticket contact, primary account contact, or parent account primary contact), then that Contact Approver can be deleted from the ticket. Deleting the contact will also delete all associated vote data.

  • If the contactID is associated a Contact who is member of the Change Approval Board assigned to the associated ticket (ticketID), the contactID cannot be deleted from the ticket.

  • approveRejectDateTime is read-only and set when isApproved is set to approve or reject.

This Field cannot have a value if isApproved is null.

  • approveRejectNote cannot have a value if isApproved is null.

  • isApproved can equal one of the following options:

null = has not yet been approved or rejected (default state)

true = approved

false = rejected

NOTE  The only time isApproved can be null is when a Resource or Contact is being added to the ticket as an approver. If the Resource or Contact is already an approver, then isApproved cannot be null.

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
approveRejectDateTime datetime      
approveRejectNote string (2000)        
contactID integer     Contacts  
id integer    
isApproved boolean        
resourceID integer     Resources  
ticketID integer   Tickets  

Additional resources