Get Review Status
Returns the summary for a given review.
GET https://instance.securid.com/aveksa/command.submit?cmd=getReviewStatus
Request
Parameters
| getReviewStatus | |
| format | properties - (Default) key=value. most useful when requesting a single object. If multiple objects are returned, values is a csv. ie key=value1,value2,value3 where value1 is the value for the first object, value2 is the value for the 2nd object, etc.json - Useful format for parsing into javascript or other languages. See www.json.org for details. |
| The id of the review result obtained from getReviewResult. |
Headers
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 type for review. |
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. |
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. |
Examples
Request
- Curl
- Python
- Node.js
curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=getReviewStatus&format=json&run-id=61" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"
import requests
url = "https://instance.securid.com/aveksa/command.submit"
params = {
"cmd": "getReviewStatus",
"format": "json",
"id": "41"
}
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": "getReviewStatus",
"format": "json",
"id": "41"
};
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
- 404 Invalid ID
- 412 Missing ID
- 500 Internal Error
{
"data": {
"type": "getReviewStatus",
"state": "InActionable",
"name": "Azure Role #3-1",
"unassigned-review-items": "0",
"saved-entitlements": "0",
"saved-accounts": "0",
"reviewed-accounts": "0",
"reviewed-entitlements": "0",
"total-entitlements": "667",
"start-date": "2023-08-03 20:12:08",
"description": "",
"review-type": "account",
"total-accounts": "667"
}
}
<html>
<head>
<title>Error</title>
</head>
<body>Could not find a review with the id 5917
Query String=cmd=getReviewStatus&format=json&id=5917</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The parameter id is required.
Query String=cmd=getReviewStatus&format=json</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>org.hibernate.exception.GenericJDBCException: could not execute query</body>
</html>