Get Approval Details

Get the details of a specific approval or activity work item.

GET https://instance.securid.com/aveksa/command.submit?cmd=getApprovalDetails

caution

This command is deprecated and has been replaced by Get Work Item Details. Future releases may remove it.

note

The response wrapper key is Approval for approval-type work items and Activity for fulfillment-type work items (for example, Manual Fulfillment steps). Activity responses omit LineItemApprovalEnabled and EmailApprovalEnabled. The RSA reference states this command requires a user token from loginUser. Trusted application tokens also work in practice.

Request

Parameters

command	getApprovalDetails
format	xml - (Default) Returns the response as XML. json - Returns the response as JSON.
approval-id	The ID of the work item, in id:WPDS:n format. Retrieve this from Find Approvals.

Headers

Authorization

Bearer token

Response

Parameters

WorkItemId	Unique identifier of the work item, in id:WPDS:n format.
WorkItemName	Display name of the work item step.
WorkItemState	Current state of the work item. Confirmed values: Available Open Accepted Rejected Canceled Completed.
WorkItemDueDate	Due date and time of the work item.
WorkItemCompletedDate	Date and time the work item was completed. Empty string if not yet completed.
WorkItemCompletedByName	Full name of the user who completed the work item. Empty string if not yet completed.
WorkItemReassignDisabled	Whether reassignment is disabled for this work item.
RequestId	Numeric ID of the parent change request.
RequestName	Name of the parent change request.
RequestedByName	Display name of the user who submitted the request, in LastName, FirstName format.
RequestDescription	Description of the change request. Empty string if not set.
RequestNotes	Notes attached to the change request. Empty string if not set.
RequestHasAttachments	Whether the request has file attachments.
Actions.ActionName	The action(s) available or taken for this work item. A single string for completed items. An array of strings for pending items where multiple actions are available.
EmailApprovalEnabled	Whether email-based approval is enabled. Present only for Approval-type work items.
LineItemApprovalEnabled	Whether line-item level approval is enabled. Present only for Approval-type work items.
ExtraFields	Additional custom fields. Empty string if none are configured.

Examples

Request

Curl

curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=getApprovalDetails&format=json&approval-id=1001:WPDS:1" \
-H "Authorization: Bearer <token>"

Python

import requests

url = "https://instance.securid.com/aveksa/command.submit"

params = {
    "cmd": "getApprovalDetails",
    "format": "json",
    "approval-id": "1001:WPDS:1"
}

headers = {
    'Authorization': 'Bearer <token>'
}

response = requests.get(url, params=params, headers=headers)

if response.status_code == 200:
    data = response.json()
    print(data)
else:
    print(f"Request failed with status code {response.status_code}")

Node.js

const axios = require('axios');

const url = "https://instance.securid.com/aveksa/command.submit";

const params = {
    cmd: "getApprovalDetails",
    format: "json",
    "approval-id": "1001:WPDS:1"
};

const headers = {
    'Authorization': 'Bearer <token>'
};

axios.get(url, { params, headers })
    .then(response => {
        if (response.status === 200) {
            console.log(response.data);
        } else {
            console.log(`Request failed with status code ${response.status}`);
        }
    })
    .catch(error => {
        console.error('Error:', error);
    });

Response

200 Available

Pending approval with multiple available actions. Actions.ActionName is an array.

{
    "getApprovalDetails": {
        "Approval": {
            "WorkItemCompletedByName": "",
            "RequestId": 1001,
            "Actions": {
                "ActionName": [
                    "Rejected",
                    "Accepted"
                ]
            },
            "RequestHasAttachments": false,
            "ExtraFields": "",
            "RequestName": "00001",
            "RequestDescription": "Test description field",
            "WorkItemCompletedDate": "",
            "LineItemApprovalEnabled": true,
            "WorkItemState": "Available",
            "RequestedByName": "AveksaAdmin,",
            "EmailApprovalEnabled": true,
            "WorkItemDueDate": "2026-06-24 17:00:00.0",
            "WorkItemName": "Asset Business Owner Approval",
            "WorkItemId": "1001:WPDS:1",
            "RequestNotes": "",
            "WorkItemReassignDisabled": false
        }
    }
}

200 Accepted

Completed approval. Actions.ActionName is a single string.

{
    "getApprovalDetails": {
        "Approval": {
            "WorkItemCompletedByName": "Smith, Alex",
            "RequestId": 1002,
            "Actions": {
                "ActionName": "Accepted"
            },
            "RequestHasAttachments": false,
            "ExtraFields": "",
            "RequestName": "00002",
            "RequestDescription": "",
            "WorkItemCompletedDate": "2025-12-10 10:03:10.0",
            "LineItemApprovalEnabled": true,
            "WorkItemState": "Accepted",
            "RequestedByName": "Doe, Jordan",
            "EmailApprovalEnabled": false,
            "WorkItemDueDate": "2025-12-15 10:02:40.0",
            "WorkItemName": "Asset Business Owner Approval",
            "WorkItemId": "1002:WPDS:1",
            "RequestNotes": "",
            "WorkItemReassignDisabled": false
        }
    }
}

200 Activity

Fulfillment-type work item. Response uses Activity wrapper instead of Approval. LineItemApprovalEnabled and EmailApprovalEnabled are not present.

{
    "getApprovalDetails": {
        "Activity": {
            "WorkItemCompletedByName": "",
            "RequestId": 1003,
            "Actions": {
                "ActionName": [
                    "Canceled",
                    "Completed"
                ]
            },
            "RequestHasAttachments": false,
            "ExtraFields": "",
            "RequestName": "00003",
            "RequestDescription": "",
            "WorkItemCompletedDate": "",
            "WorkItemState": "Available",
            "RequestedByName": "AveksaAdmin,",
            "WorkItemDueDate": "2026-06-24 17:00:00.0",
            "WorkItemName": "Manual Fulfillment",
            "WorkItemId": "1003:WPDS:1",
            "RequestNotes": "",
            "WorkItemReassignDisabled": false
        }
    }
}

401 Invalid Token

<html>
    <head>
        <title>Error</title>
    </head>
    <body>The token is not valid for the command 'getApprovalDetails'. Token is invalid or expired</body>
</html>

412 Missing approval-id

<html>
    <head>
        <title>Error</title>
    </head>
    <body>The approval-id parameter is required.
 Query String=cmd=getApprovalDetails&amp;format=json</body>
</html>

412 ID Not Found

<html>
    <head>
        <title>Error</title>
    </head>
    <body>The work item could not be retrieved
 Query String=cmd=getApprovalDetails&amp;format=json&amp;approval-id=99999:WPDS:1</body>
</html>

Verified with RSA Governance & Lifecycle version 8.0.0.188886 P10_HF01.

See Also

• Find Approvals: Search for approval IDs
• Get Approvals for User: Alternate command for listing approvals
• Perform Approval: Accept or reject an approval
• Get Work Item Details: Replacement for this command