Get Review Status

Returns the status summary for a review instance.

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

Request

Parameters

command	getReviewStatus
format	properties - (Default) Returns the response as key=value pairs. When multiple objects are returned, values are comma-delimited: key=value1,value2,value3. json - Returns the response as JSON.
id	The review instance ID returned by Get Review Result.

Headers

Authorization	Bearer token
Accept	application/json
Content-Type	application/json

Response

Parameters

type	Executed command name
name	The name of the review.
description	The description for the review.
review-type	The review type.
state	The state of the review.
start-date	The date the review was started.
due-date	The date the review is due (only returned if the review has a specific due date set).
complete-date	The date the review was completed. Not currently returned even when state is Completed.
reviewed-entitlements	The number of entitlements reviewed.
saved-entitlements	The number of entitlements saved.
total-entitlements	The total number of entitlements in the review.
reviewed-users	The number of users reviewed.
certified-users	The number of certified users (only returned if the review supports certification).
saved-users	The number of users saved.
total-users	The total number of users in the review.
reviewed-accounts	The number of accounts reviewed (only valid for account reviews).
certified-accounts	The number of certified accounts (only returned if the account review supports certification).
saved-accounts	The number of accounts saved (only valid for account reviews).
total-accounts	The total number of accounts in the review (only valid for account reviews).
unassigned-review-items	The number of unassigned review items.
unassigned-certification-items	The number of unassigned certification items.

caution

The RSA official reference documents a name parameter as mutually exclusive with id. Passing name without id returns 412. Always use id.

Examples

Request

Curl

curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=getReviewStatus&format=json&id=142" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"

Python

import requests

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

params = {
    "cmd": "getReviewStatus",
    "format": "json",
    "id": "142"
}

headers = {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
}

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: "getReviewStatus",
    format: "json",
    id: "142"
};

const headers = {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
};

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 User Review

{
    "data": {
        "type": "getReviewStatus",
        "state": "Completed",
        "name": "UAR-5",
        "unassigned-review-items": "0",
        "saved-entitlements": "0",
        "total-users": "15",
        "due-date": "2026-06-24 15:26:57",
        "saved-users": "0",
        "reviewed-entitlements": "6",
        "total-entitlements": "62",
        "start-date": "2026-06-20 15:26:57",
        "description": "",
        "review-type": "user",
        "reviewed-users": "0"
    }
}

200 Account Review

{
    "data": {
        "type": "getReviewStatus",
        "state": "InProcess",
        "name": "Account Review-1",
        "unassigned-review-items": "1178920",
        "saved-entitlements": "0",
        "saved-accounts": "0",
        "reviewed-accounts": "6",
        "reviewed-entitlements": "6",
        "total-entitlements": "1178920",
        "start-date": "2026-06-20 21:53:23",
        "description": "",
        "review-type": "account",
        "total-accounts": "1063450"
    }
}

401 Invalid Token

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

412 Missing ID

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

404 ID Not Found

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Could not find a review with the id 99999
 Query String=cmd=getReviewStatus&amp;format=json&amp;id=99999</body>
</html>

Verified with RSA Governance & Lifecycle version 8.0.0.188886 P10_HF01.

See Also

• Run Review: Trigger a review run and get a run-id
• Get Review Result: Resolve a run-id to a review instance id
• Refresh Review: Reload reviewer assignments after coverage changes