Retrieve information about A specific approval request By its unique identifier.

Retrieve information about A specific approval request By its unique identifier.

Retrieve information about a specific approval request 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/approvalrequests/{requestId}
COPY
Path Parameters
string
requestId
Required

The request id

Responses
200

successful operation

Returns ApprovalRequestInfo of type(s) */* 
{
    "requestedItemApproval": {
        "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",
        "requestedBy": "string",
        "completionTime": "string",
        "requestRef": "string",
        "subTenantId": "string",
        "policyType": {
            "name": "string",
            "description": "string",
            "id": "string"
        },
        "requestClassId": "string",
        "startTime": "string",
        "id": "string",
        "state": "string",
        "policy": {
            "name": "string",
            "description": "string",
            "id": "string"
        }
    },
    "approver": [
        {
            "displayName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "infoItems": [
        {
            "approver": [
                {
                    "displayName": "string",
                    "type": "string",
                    "value": "string"
                }
            ],
            "level": {
                "name": "string",
                "description": "string",
                "id": "string"
            },
            "approval": {
                "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",
                "requestedBy": "string",
                "completionTime": "string",
                "requestRef": "string",
                "subTenantId": "string",
                "policyType": {
                    "name": "string",
                    "description": "string",
                    "id": "string"
                },
                "requestClassId": "string",
                "startTime": "string",
                "id": "string",
                "state": "string",
                "policy": {
                    "name": "string",
                    "description": "string",
                    "id": "string"
                }
            },
            "businessJustification": "string",
            "id": "string"
        }
    ],
    "completionAction": "string",
    "level": {
        "name": "string",
        "description": "string",
        "id": "string"
    },
    "tenantId": "string",
    "workItem": {
        "assignedDate": "string",
        "number": 0,
        "createdDate": "string",
        "id": "string",
        "assignedTo": [
            {
                "displayName": "string",
                "type": "string",
                "value": "string"
            }
        ],
        "completedDate": "string",
        "completedBy": "string",
        "status": "string"
    },
    "businessJustification": "string",
    "id": "string",
    "state": "string"
}
RequestedItemApprovalStatusInfo
requestedItemApproval
Required

requestedItemApproval

array of ApprovalPrincipal
approver
Optional

approver

array of ApprovalRequestItemInfo
infoItems
Optional

infoItems

string
completionAction
Optional

completionAction

Possible values are : APPROVE, REJECT, NONE,
ApprovalDescriptiveReference
level
Required

level

string
tenantId
Optional

tenantId

ApprovalWorkItemInfo
workItem
Optional

workItem

string
businessJustification
Optional

businessJustification

string
id
Optional

id

string
state
Optional

state

Possible values are : NOT_REQUESTED_YET, PENDING, COMPLETED, NOT_NECESSARY,

On This Page
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.