Run Review
Trigger a review cycle by name.
GET https://instance.securid.com/aveksa/command.submit?cmd=runReview
caution
The name parameter requires the review definition name (for example, UAR), not an instance name (for example, UAR-1). Passing an instance name returns 404 Could not find review. There is no API to list review definition names; they must be obtained from the RSA G&L UI or database.
Request
Parameters
| runReview | |
| 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. |
| The definition name of the review to run. |
Headers
Bearer token | |
| Accept | application/json |
| Content-Type | application/json |
Response
Parameters
type | Executed command name |
run-id | The ID assigned to this review run. Pass it to Get Review Result once the run completes to retrieve the review instance id. |
Examples
Request
- Curl
- Python
- Node.js
curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=runReview&format=json&name=UAR" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"
import requests
url = "https://instance.securid.com/aveksa/command.submit"
params = {
"cmd": "runReview",
"format": "json",
"name": "UAR"
}
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: "runReview",
format: "json",
name: "UAR"
};
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 Parameter
- 404 Review Not Found
{
"data": {
"type": "runReview",
"run-id": "10009"
}
}
<html>
<head>
<title>Error</title>
</head>
<body>The token is not valid for the command 'runReview'. Token is invalid or expired</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The parameter name is required.
Query String=cmd=runReview&format=json</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>Could not find review InvalidReviewName
Query String=cmd=runReview&format=json&name=InvalidReviewName</body>
</html>
Verified with RSA Governance & Lifecycle version 8.0.0.188886 P10_HF01.
See Also
- Get Review Result: Resolve the
run-idto a review instanceidonce the run completes - Get Review Status: Check review progress and completion state
- Refresh Review: Reload reviewer assignments after coverage changes