Retrieve information about A specific approval By its unique identifier.
Retrieve information about a specific approval by its unique identifier. There is no method-level security on this method because no single permission gives usersaccess to approvals in general. However, there is a programmatic check to ascertain that theuser has a specific relationship to the approval that enables them to see it.
Request
URI
GET
https://{api_host}/approval-service/api/info/approvals/{approvalId}
COPY
Path Parameters
string
approvalId
Required
The approval id
Responses
200
successful operation
Returns ApprovalInfo of type(s) */*
{
"requestedFor": "string",
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": 0
},
"quoteProvided": false,
"lease": {
"unit": "string",
"amount": 0
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": 0
}
}
},
"requestInstanceId": "string",
"requestedItemName": "string",
"requestReasons": "string",
"requestingServiceId": "string",
"requestDescription": "string",
"requestedItemDescription": "string",
"requestedBy": "string",
"requestRef": "string",
"subTenantId": "string",
"requestClassId": "string",
"id": "string",
"state": "string",
"requestedItemApprovals": [
{
"phase": {
"name": "string",
"description": "string",
"id": "string"
},
"requestedFor": "string",
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": 0
},
"quoteProvided": false,
"lease": {
"unit": "string",
"amount": 0
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": 0
}
}
},
"requestInstanceId": "string",
"hasSourceDetailsForm": false,
"requestedItemName": "string",
"requestReasons": "string",
"requestingServiceId": "string",
"requestDescription": "string",
"requestedItemDescription": "string",
"currentLevel": {
"mode": "string",
"completionTime": "string",
"request": [
{
"completionAction": "string",
"assignDate": "string",
"workItemNumber": 0,
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"completionDate": "string",
"businessJustification": "string",
"id": "string",
"workItemId": "string",
"state": "string",
"completedBy": "string"
}
],
"level": {
"name": "string",
"description": "string",
"id": "string"
},
"currentApprover": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"startTime": "string",
"id": "string",
"state": "string"
},
"requestedBy": "string",
"completionTime": "string",
"pastLevel": [
{
"mode": "string",
"completionTime": "string",
"request": [
{
"completionAction": "string",
"assignDate": "string",
"workItemNumber": 0,
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"completionDate": "string",
"businessJustification": "string",
"id": "string",
"workItemId": "string",
"state": "string",
"completedBy": "string"
}
],
"level": {
"name": "string",
"description": "string",
"id": "string"
},
"currentApprover": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"startTime": "string",
"id": "string",
"state": "string"
}
],
"requestRef": "string",
"subTenantId": "string",
"policyType": {
"name": "string",
"description": "string",
"id": "string"
},
"requestClassId": "string",
"startTime": "string",
"futureLevel": [
{
"mode": "string",
"completionTime": "string",
"request": [
{
"completionAction": "string",
"assignDate": "string",
"workItemNumber": 0,
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"completionDate": "string",
"businessJustification": "string",
"id": "string",
"workItemId": "string",
"state": "string",
"completedBy": "string"
}
],
"level": {
"name": "string",
"description": "string",
"id": "string"
},
"currentApprover": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"startTime": "string",
"id": "string",
"state": "string"
}
],
"id": "string",
"state": "string",
"policy": {
"name": "string",
"description": "string",
"id": "string"
}
}
]
}string
requestedFor
Optional
requestedFor
string
requestInstanceId
Required
requestInstanceId
string
requestedItemName
Required
requestedItemName
string
requestReasons
Optional
requestReasons
string
requestingServiceId
Required
requestingServiceId
string
requestDescription
Optional
requestDescription
string
requestedItemDescription
Optional
requestedItemDescription
string
requestedBy
Optional
requestedBy
string
requestRef
Optional
requestRef
string
subTenantId
Optional
subTenantId
string
requestClassId
Required
requestClassId
string
id
Optional
id
string
state
Optional
state
Possible values are : UNINITIATED, PENDING, APPROVED, REJECTED, IN_ERROR,
Approval Info Operations
GET
Retrieve A read-only form providing detailed information about the source Of A specific approval.
GET
Retrieve A read-only form providing detailed information about the source Of An approval associated with A specific approval request.
GET
Retrieve information about A specific approval By its unique identifier.
GET
Retrieve information about A specific approval request By its unique identifier.
POST
Retrieves A paged list Of permissible values for A specific field On the approval source details form, accessed via An approval request.
POST
Retrieves A paged list Of permissible values for A specific field On the approval source details form.
POST
Retrieves the updated state Of one Or more layout elements In response To change In one Or more layout fields' values.
POST
Retrieves the updated state Of one Or more layout elements In response To change In one Or more layout fields' values.