Get Approval Details
Get the details of a particular approval. The user specified by the token must have access to the requested approval.
GET https://instance.securid.com/aveksa/command.submit?cmd=getApprovalDetails
caution
This web service has been replaced with the command Get Work Items for User. Future releases may remove the deprecated web service command.
Request
Parameters
| getApprovalDetails | |
| format | properties - (Default) key=value. most useful when requesting a single object. If multiple objects are returned, values is a csv. ie key=value1,value2,value3 where value1 is the value for the first object, value2 is the value for the 2nd object, etc.json - Useful format for parsing into javascript or other languages. See www.json.org for details. |
| The id of the approval work item, retrieved from Get Approvals for User. |
Headers
Bearer token | |
| Accept | application/json |
| Content-Type | application/json |
Response
Parameters
The command returns detailed information about the approval in XML format.
Examples
Request
- Curl
curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=getApprovalDetails&format=json&approval-id=id" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"
Response
- 200 XML
- 200 JSON
- 401
- 412 Missing Parameter
- 412 Invalid ID
<?xml version="1.0" encoding="UTF-8"?>
<getApprovalDetails>
<Approval>
<EmailApprovalEnabled>false</EmailApprovalEnabled>
<LineItemApprovalEnabled>true</LineItemApprovalEnabled>
<ExtraFields/>
<WorkItemId>11:WPDS:1</WorkItemId>
<WorkItemName>Supervisor Approval</WorkItemName>
<WorkItemDueDate>2022-04-07 14:30:31.0</WorkItemDueDate>
<WorkItemCompletedDate>2022-04-04 14:30:34.0</WorkItemCompletedDate>
<WorkItemCompletedByName>System,</WorkItemCompletedByName>
<WorkItemReassignDisabled>false</WorkItemReassignDisabled>
<WorkItemState>Accepted</WorkItemState>
<RequestId>1</RequestId>
<RequestName>00001</RequestName>
<RequestedByName>Aishwarya Rao</RequestedByName>
<RequestDescription>System Admin Role - Bhagat</RequestDescription>
<RequestNotes/>
<RequestHasAttachments>false</RequestHasAttachments>
<Actions>
<ActionName>Accepted</ActionName>
</Actions>
</Approval>
</getApprovalDetails>
{
"getApprovalDetails": {
"Approval": {
"WorkItemCompletedByName": "",
"RequestId": 443,
"Actions": {
"ActionName": [
"Rejected",
"Accepted"
]
},
"RequestHasAttachments": false,
"ExtraFields": "",
"RequestName": "UAR-5",
"RequestDescription": "",
"WorkItemCompletedDate": "",
"LineItemApprovalEnabled": true,
"WorkItemState": "Available",
"RequestedByName": "AveksaAdmin,",
"EmailApprovalEnabled": true,
"WorkItemDueDate": "2024-01-22 17:00:00.0",
"WorkItemName": "Asset Business Owner Approval",
"WorkItemId": "3377:WPDS:1",
"RequestNotes": "",
"WorkItemReassignDisabled": false
}
}
}
<html>
<head>
<title>Error</title>
</head>
<body>The token is not valid for the command 'getApprovalDetails'. Token is invalid or expired</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The approval-id parameter is required.
Query String=cmd=getApprovalDetails&format=json&approval-id=</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The work item could not be retrieved
Query String=cmd=getApprovalDetails&format=json&approval-id=123</body>
</html>