Evaluates A request for the given approval policy.
Evaluates a request for the given approval policy. This is an asynchronous call. The service creates a new {@link Approval} that would contain the result of the evaluation and returns it to the client and then asynchronously triggers the evaluation. Clients can check the status of the evaluation by retrieving this Approval instance. The service also has a callback mechanism to notify the clients when the evaluation is complete.
Request
URI
POST
https://{api_host}/approval-service/api/evaluations
COPY
Request Body
ApprovalPolicyEvaluationSpec of type(s) application/json
Required
{
"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",
"requestedItems": [
{
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": 0
},
"quoteProvided": false,
"lease": {
"unit": "string",
"amount": 0
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": 0
}
}
},
"requestInstanceId": "string",
"policyId": "string",
"phaseId": "string",
"requestedItemName": "string",
"requestClassId": "string",
"requestedItemDescription": "string"
}
],
"requestingServiceId": "string",
"requestDescription": "string",
"requestedItemDescription": "string",
"requestedBy": "string",
"requestRef": "string",
"subTenantId": "string",
"requestClassId": "string"
}string
requestedFor
Optional
requestedFor
string
requestInstanceId
Required
requestInstanceId
string
requestedItemName
Optional
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
Responses
200
successful operation
Returns Approval 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",
"version": 0,
"requestDescription": "string",
"requestedItemDescription": "string",
"completionTime": "string",
"requestedBy": "string",
"requestRef": "string",
"subTenantId": "string",
"createdDate": "string",
"tenantId": "string",
"startTime": "string",
"requestClassId": "string",
"id": "string",
"state": "string",
"lastModified": "string",
"requestedItemApprovals": [
{
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": 0
},
"quoteProvided": false,
"lease": {
"unit": "string",
"amount": 0
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": 0
}
}
},
"requestInstanceId": "string",
"phaseDecision": {
"phase": {
"name": "string",
"description": "string",
"id": "string",
"levels": [
{
"approvalMode": "string",
"external": false,
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": 0,
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
}
],
"phasetype": {
"phaseOrder": 0,
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": false
}
},
"completionTime": "string",
"phaseNumber": 0,
"startTime": "string",
"decisions": [
{
"completionTime": "string",
"approvalMode": "string",
"level": {
"approvalMode": "string",
"external": false,
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": 0,
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
},
"approvalRequests": [
{
"creationTime": "string",
"workItemNumber": 0,
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"workItemId": "string",
"version": 0,
"completionTime": "string",
"tenantId": "string",
"action": "string",
"wiqServiceId": "string",
"id": "string",
"businessJustification": "string",
"state": "string",
"assignTime": "string",
"completedBy": "string"
}
],
"phaseNumber": 0,
"startTime": "string",
"id": "string",
"state": "string"
}
],
"id": "string",
"state": "string"
},
"requestedItemName": "string",
"phaseId": "string",
"phaseNumber": 0,
"version": 0,
"requestedItemDescription": "string",
"completionTime": "string",
"createdDate": "string",
"startTime": "string",
"requestClassId": "string",
"id": "string",
"state": "string",
"lastModified": "string",
"policy": {
"lastModifiedBy": "string",
"description": "string",
"version": 0,
"createdDate": "string",
"approvableItemId": "string",
"typeFilter": "string",
"stateName": "string",
"createdBy": "string",
"policyType": {
"phaseTypes": [
{
"phaseOrder": 0,
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": false
}
],
"classId": "string",
"typeFilter": "string",
"name": "string",
"description": "string",
"serviceTypeId": "string",
"id": "string"
},
"name": "string",
"id": "string",
"state": "string",
"lastModified": "string",
"approvableItemName": "string",
"approvableItemServiceTypeId": "string",
"phases": [
{
"name": "string",
"description": "string",
"id": "string",
"levels": [
{
"approvalMode": "string",
"external": false,
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": 0,
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
}
],
"phasetype": {
"phaseOrder": 0,
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": false
}
}
]
}
}
]
}string
requestedFor
Optional
requestedFor
string
requestInstanceId
Optional
requestInstanceId
string
requestedItemName
Optional
requestedItemName
string
requestReasons
Optional
requestReasons
string
requestingServiceId
Required
requestingServiceId
integer As int64 As int64
version
Optional
version
string
requestDescription
Optional
requestDescription
string
requestedItemDescription
Optional
requestedItemDescription
string As date-time As date-time
completionTime
Optional
completionTime
string
requestedBy
Optional
requestedBy
string
requestRef
Optional
requestRef
string
subTenantId
Optional
subTenantId
string As date-time As date-time
createdDate
Optional
createdDate
string
tenantId
Optional
tenantId
string As date-time As date-time
startTime
Optional
startTime
string
requestClassId
Optional
requestClassId
string As uuid As uuid
id
Optional
id
string
state
Required
state
Possible values are : UNINITIATED, PENDING, APPROVED, REJECTED, IN_ERROR,
string As date-time As date-time
lastModified
Optional
lastModified
201
Operation doesn't return any data structure