Skip to main content

Approval2

Properties

NameTypeDescriptionNotes
id(optional) stringThe Approval ID[default to undefined]
tenantId(optional) stringThe Tenant ID of the Approval[default to undefined]
type(optional) stringThe type of the approval, such as ENTITLEMENT_DESCRIPTIONS, CUSTOM_ACCESS_REQUEST_APPROVAL, GENERIC_APPROVAL[default to undefined]
approvers(optional) Array<Approvalidentity>Object representation of an approver of an approval[default to undefined]
createdDate(optional) stringDate the approval was created[default to undefined]
dueDate(optional) stringDate the approval is due[default to undefined]
escalationStep(optional) stringStep in the escalation process. If set to 0, the approval is not escalated. If set to 1, the approval is escalated to the first approver in the escalation chain.[default to undefined]
serialStep(optional) numberThe serial step of the approval in the approval chain. For example, serialStep 1 is the first approval to action in an approval request chain. Parallel approvals are set to 0.[default to undefined]
isEscalated(optional) booleanWhether or not the approval has been escalated. Will reset to false when the approval is actioned on.[default to false]
name(optional) Array<Approvalname>The name of the approval for a given locale[default to undefined]
batchRequest(optional) Approvalbatch[default to undefined]
approvalConfig(optional) Approvalconfig[default to undefined]
description(optional) Array<Approvaldescription>The description of the approval for a given locale[default to undefined]
medium(optional) stringSignifies what medium to use when sending notifications (currently only email is utilized)[default to undefined]
priority(optional) stringThe priority of the approval[default to undefined]
requester(optional) Approvalidentity[default to undefined]
requestee(optional) Approvalidentity[default to undefined]
comments(optional) Array<Approvalcomment3>Object representation of a comment on the approval[default to undefined]
approvedBy(optional) Array<Approvalidentityrecord>Array of approvers who have approved the approval[default to undefined]
rejectedBy(optional) Array<Approvalidentityrecord>Array of approvers who have rejected the approval[default to undefined]
assignedTo(optional) Array<Approvalidentity>Array of identities that the approval request is currently assigned to/waiting on. For parallel approvals, this is set to all approvers left to approve.[default to undefined]
completedDate(optional) stringDate the approval was completed[default to undefined]
approvalCriteria(optional) Approval2ApprovalCriteria[default to undefined]
additionalAttributes(optional) stringJson string representing additional attributes known about the object to be approved.[default to undefined]
referenceData(optional) Array<Approvalreference>Reference data related to the approval[default to undefined]
reassignmentHistory(optional) Array<Approvalreassignmenthistory>History of whom the approval request was assigned to[default to undefined]
staticAttributes(optional)Field that can include any static additional info that may be needed by the service that the approval request originated from[default to undefined]
modifiedDate(optional) stringDate/time that the approval request was last updated[default to undefined]
requestedTarget(optional) Array<Approvalrequestedtarget>RequestedTarget used to specify the actual object or target the approval request is for[default to undefined]