Refresh Review

Reload data used in a review without restarting the review cycle.

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

note

Only user and account reviews support this command.

Request

Parameters

command	refreshReview
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.
coverage	Refresh reviewer coverage assignments. (Default) `true`
clearreassignments	Clear any manual reassignments made to the review. Only used when `coverage=true`. (Default) `false`
users	Refresh user data. (Default) `true`
groups	Refresh group data. (Default) `true`
roles	Refresh role data. (Default) `true`
entitlements	Refresh entitlement data. (Default) `true`
resources	Refresh resource data. (Default) `false`
accounts	Refresh account data. (Default) `true`
descriptions	Refresh description text used in the review.
reviewAnalysis	Refresh counts displayed in the review UI. (Default) `true`
applications	Comma-delimited list of application names to refresh. Only used when `entitlements=true`. If omitted, all applications are refreshed.

Headers

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

Response

Parameters

`type`	Executed command name
`name`	The name of the review.
`run-id`	The ID assigned to the refresh run. Use `getRunStatus` to check whether the refresh has completed.

Examples

Request

Curl
Python
Node.js

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

import requests

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

params = {
    "cmd": "refreshReview",
    "format": "json",
    "id": "143"
}

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}")

const axios = require('axios');

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

const params = {
    cmd: "refreshReview",
    format: "json",
    id: "143"
};

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
401 Invalid Token
412 Missing ID
412 Review State
404 ID Not Found

{
    "data": {
        "type": "refreshReview",
        "run-id": "10006",
        "name": "UAR-6"
    }
}

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

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

<html>
    <head>
        <title>Error</title>
    </head>
    <body>The review UAR-5 is not in a state where a refresh is allowed
 Query String=cmd=refreshReview&amp;format=json&amp;id=142</body>
</html>

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

Verified with RSA Governance & Lifecycle version 8.0.0.188886 P10_HF01.

Request​

Parameters​

Headers​

Response​

Parameters​

Examples​

Request​

Response​

See Also​

Request

Parameters

Headers

Response

Parameters

Examples

Request

Response

See Also