Create Requests by Owner
Generate change requests for a review. Equivalent to the Create Change Requests button on the Change Preview tab of a review.
GET https://instance.securid.com/aveksa/command.submit?cmd=createRequestsByOwner
note
This command only applies to reviews configured to generate requests explicitly by owner. It is ignored for reviews configured to generate requests automatically. A 412 is returned if the review is not configured for explicit-by-owner request generation.
Request
Parameters
| createRequestsByOwner | |
| The ID of the review result to create change requests for. | |
| group | Specifies how changes are grouped into requests. Valid values depend on the review type:
|
| format |
|
| token | Deprecated. Use the Authorization request header instead. |
Headers
Bearer token | |
| Accept | application/json |
| Content-Type | application/json |
Response
Parameters
name | The name of the review. |
status | success or failure |
message | Optional message returned with the status. |
Examples
Request
- Curl
- Python
- Node.js
curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=createRequestsByOwner&format=json&id=1&group=Reviewer" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"
import requests
url = "https://instance.securid.com/aveksa/command.submit"
params = {
"cmd": "createRequestsByOwner",
"format": "json",
"id": "1",
"group": "Reviewer"
}
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: "createRequestsByOwner",
format: "json",
id: "1",
group: "Reviewer"
};
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
- 404 Review Not Found
- 412 Missing id
- 412 Not Configured
- 412 Review Not Active
{
"data": {
"type": "createRequestsByOwner",
"status": "success",
"name": "UAR-5"
}
}
<html>
<head>
<title>Error</title>
</head>
<body>The token is not valid for the command 'createRequestsByOwner'. Token is invalid or expired</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>Could not find a report with the id <id>
Query String=cmd=createRequestsByOwner&format=json&id=<id></body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The parameter id is required.
Query String=cmd=createRequestsByOwner&format=json</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The review <review-name> is not configured to generate requests explicitly by owner.
Query String=cmd=createRequestsByOwner&format=json&id=<id></body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The review <review-name> is not active or on hold. The review must be in this state to generate requests.
Query String=cmd=createRequestsByOwner&format=json&id=<id></body>
</html>
Verified with RSA Governance & Lifecycle version 8.0.0.188886 P10_HF01.
See Also
- Run Review: Launch a review
- Get Review Status: Check the status of a running review
- Get Change Request Status: Check the status of generated change requests