Run Review
Generate a review.
GET https://instance.securid.com/aveksa/command.submit?cmd=runReview
Request
Parameters
| runReview | |
| 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 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 the generation of the review. Use getRunStatus to check the status of the run after this call. This same id is also used in the getReviewResult command once the run is completed to get the result id. |
Examples
Request
- Curl
- Python
- Node.js
curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=runReview&format=json&name=Review1" \
-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
- 404 Invalid Review Name
- 412 Missing Parameter
{
"data": {
"type": "runReview",
"run-id": "5919"
}
}
<html>
<head>
<title>Error</title>
</head>
<body>Could not find review UAR1 Query String=cmd=runReview&format=json&name=UAR1</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The parameter name is required. Query String=cmd=runReview&format=json</body>
</html>