Cancel Change Request

Cancel an in-progress change request.

GET https://instance.securid.com/aveksa/command.submit?cmd=cancelChangeRequest

note

Prior to 8.1.0, this command rejected requests that included format=json with a 412 error. From 8.1.0 onward, format=json is supported. Error responses are returned as HTML regardless of format.

Request

Parameters

command	cancelChangeRequest
id	The ID of the change request to cancel.
comment	Reason for cancelling the change request.
revertCompletedChanges	If true, reversal items are created for activities that have already completed. Default: false.
token	Deprecated. Use the Authorization request header instead.

Headers

Authorization

Bearer token

Response

This command returns no output on success. A 200 with an empty body indicates the change request was cancelled.

Examples

Request

Curl

curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=cancelChangeRequest&id=242&comment=Cancelled+via+API" \
-H "Authorization: Bearer <token>"

Python

import requests

url = "https://instance.securid.com/aveksa/command.submit"

params = {
    "cmd": "cancelChangeRequest",
    "id": "242",
    "comment": "Cancelled via API"
}

headers = {
    'Authorization': 'Bearer <token>'
}

response = requests.get(url, params=params, headers=headers)

if response.status_code == 200:
    print("Change request cancelled successfully")
else:
    print(f"Request failed with status code {response.status_code}")
    print(response.text)

Node.js

const axios = require('axios');

const url = "https://instance.securid.com/aveksa/command.submit";

const params = {
    cmd: "cancelChangeRequest",
    id: "242",
    comment: "Cancelled via API"
};

const headers = {
    'Authorization': 'Bearer <token>'
};

axios.get(url, { params, headers })
    .then(response => {
        if (response.status === 200) {
            console.log("Change request cancelled successfully");
        } else {
            console.log(`Request failed with status code ${response.status}`);
        }
    })
    .catch(error => {
        console.error('Error:', error.response ? error.response.data : error.message);
    });

Response

200

(empty body)

401 Invalid Token

<html>
    <head>
        <title>Error</title>
    </head>
    <body>The token is not valid for the command 'cancelChangeRequest'. Token is invalid or expired</body>
</html>

404 Not Found

<html>
    <head>
        <title>Error</title>
    </head>
    <body>The change request with id=&lt;id&gt; could not be found.

 Query String=cmd=cancelChangeRequest&amp;id=&lt;id&gt;&amp;comment=&lt;comment&gt;</body>
</html>

412 Missing id

<html>
    <head>
        <title>Error</title>
    </head>
    <body>The parameter id is required.
 Query String=cmd=cancelChangeRequest&amp;comment=&lt;comment&gt;</body>
</html>

412 Missing comment

<html>
    <head>
        <title>Error</title>
    </head>
    <body>The parameter comment is required.
 Query String=cmd=cancelChangeRequest&amp;id=&lt;id&gt;</body>
</html>

412 Invalid State

<html>
    <head>
        <title>Error</title>
    </head>
    <body>The current state of the change request with id=&lt;id&gt; is &lt;state&gt;, which can not be Cancelled.

 Query String=cmd=cancelChangeRequest&amp;id=&lt;id&gt;&amp;comment=&lt;comment&gt;</body>
</html>

Verified with RSA Governance & Lifecycle version 8.0.0.188886 P10_HF01.

See Also

• Get Change Request Status: Check the status and state of a change request
• Cancel Change Activity: Cancel a single activity within a change request
• Create Change Request: Create a new change request