Cancel Change Activity
Cancel a pending activity in a change request. Equivalent to marking an activity as canceled in the change request UI.
GET https://instance.securid.com/aveksa/command.submit?cmd=cancelChangeActivity
Request
Parameters
| cancelChangeActivity | |
| The ID of the activity to cancel. Retrieve from the Activities page or from Get Request Items. | |
| A comment explaining why the activity is canceled. | |
| format |
|
| token | Deprecated. Use the Authorization request header instead. |
Headers
Bearer token | |
| Accept | application/json |
| Content-Type | application/json |
Response
Parameters
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=cancelChangeActivity&format=json&id=615&comment=Cancelled+via+API" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"
import requests
url = "https://instance.securid.com/aveksa/command.submit"
params = {
"cmd": "cancelChangeActivity",
"format": "json",
"id": "615",
"comment": "Cancelled via API"
}
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: "cancelChangeActivity",
format: "json",
id: "615",
comment: "Cancelled via API"
};
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 Activity Not Found
- 412 Missing id
- 412 Missing comment
{
"data": {
"type": "cancelChangeActivity"
}
}
<html>
<head>
<title>Error</title>
</head>
<body>The token is not valid for the command 'cancelChangeActivity'. Token is invalid or expired</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The change activity with id=<id> could not be found.
Query String=cmd=cancelChangeActivity&format=json&id=<id>&comment=<comment></body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The parameter id is required.
Query String=cmd=cancelChangeActivity&format=json&comment=<comment></body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The parameter comment is required.
Query String=cmd=cancelChangeActivity&format=json&id=<id></body>
</html>
Verified with RSA Governance & Lifecycle version 8.0.0.188886 P10_HF01.
See Also
- Get Request Items: Retrieve activity IDs for a change request
- Get Change Request Status: Check the status of a change request
- Cancel Change Request: Cancel an entire change request