TicketChangeRequestApproval

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

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.

Entity details

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

Entity Name: TicketChangeRequestApproval
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 Active resource.
  • A single ChangeRequestApproval record must have 1 ResourceID or 1ContactID. 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 Active 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 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
ApproveRejectDateTime Approve Reject DateTime datetime      
ApproveRejectNote Approve Reject Note string (2000)        
ContactID Contact ID integer     Contact  
id Change Request Ticket Vote ID integer    
IsApproved Is Approved boolean        
ResourceID Resource ID integer     Resource  
TicketID Ticket ID integer   Ticket