Set Review State
Change the state of a review instance.
GET https://instance.securid.com/aveksa/command.submit?cmd=setReviewState
caution
The RSA official reference documents a name parameter as mutually exclusive with id. Passing name without id returns 412 The parameter id is required. Always use id.
Request
Parameters
| setReviewState | |
| 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 review instance ID returned by Get Review Result. | |
The state to set. Valid values: onhold active completed |
Headers
Bearer token | |
| Accept | application/json |
| Content-Type | application/json |
Response
Parameters
type | Executed command name |
name | The name of the review. |
status | success or failure |
message | Returned when present. Describes the reason when status is failure. |
Examples
Request
- Curl
- Python
- Node.js
curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=setReviewState&format=json&id=143&state=active" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"
import requests
url = "https://instance.securid.com/aveksa/command.submit"
params = {
"cmd": "setReviewState",
"format": "json",
"id": "143",
"state": "active"
}
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: "setReviewState",
format: "json",
id: "143",
state: "active"
};
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 Missing State
- 412 Invalid State
- 404 ID Not Found
{
"data": {
"type": "setReviewState",
"status": "success",
"name": "UAR-6"
}
}
<html>
<head>
<title>Error</title>
</head>
<body>The token is not valid for the command 'setReviewState'. Token is invalid or expired</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The parameter id is required.
Query String=cmd=setReviewState&format=json&state=active</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The parameter state is required.
Query String=cmd=setReviewState&format=json&id=143</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The parameter state must be a valid value: onhold, active, completed
Query String=cmd=setReviewState&format=json&id=143&state=invalid</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>Could not find a review with the id 99999
Query String=cmd=setReviewState&format=json&id=99999&state=active</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-idto a review instanceid - Get Review Status: Check review progress and completion state