Get ActiveChange status

Get the ActiveChange status of a change request sub-ticket including details for Traffic Workflow​.

Resource Name: /change-requests/traffic/{changeRequestId}/work-order/implementation/result

Request Method: GET

Header requirements:

Key Value
Cookie FireFlow_Session=[sessionID]. The sessionId is retrieved from the authentication request.
Request URL Parameters:

Element

Type

Description
changeRequestId Mandatory

Integer

The ID of the new Change Request created. Should be the sub-ticket number (not the number of the parent ticket).

Response parameters

Element

Type

Description
status String

Status of the API request. One of these:

  • Success
  • Failure
messages List of message object type Populated when status is failure.
code string Headline of error.
message string Details of error.
data data object type Populated when status is success
changeRequestId

Integer

The ID of the new Change Request created.

activeChangeStatus String

Status of the ActiveChange calculation. One of these:

  • Succeed
  • Failed
  • Not Started
  • in Progress
result String Details of the ActiveChange implementation from the device.

Response:

Status codes:

Code

Description
200

Operation completed successfully

400

Input validation failure

Message Code Message text Parameters
INVALID_REQUEST_TYPE Change request {0} does not match request type {1} 0 - CR id, 1 - request type
CHANGE_REQUEST_NOT_FOUND Change request {0} not found 0 - CR id
NOT_SUB_TICKET Change request {0} is not a sub request 0 - sub CR id
BAD_JSON_FORMAT Bad JSON format: {0} 0 - "failed to parse request body"
BAD_MEDIA_TYPE Content-Type header is missing or has unsuitable value N/A
UNAUTHORIZED_DEVICE User has no permission for some of the devices in this request or some devices are not available N/A
403

Authentication failure.

Message Code Message text Parameters
NO_PERMISSIONS There are no permissions to process the requested operation N/A
INVALID_SESSION_KEY The session key provided is invalid N/A
EXPIRED_SESSION_KEY The session key provided has expired N/A
BAD_COOKIE_HEADER Cookie header is missing or has non-expected value N/A
UNAUTHORIZED_DEVICE User has no permission for some of the devices in this request or some devices are not available N/A
500

Failed to complete operation.

Message Code Message text Parameters
UNEXPECTED_ERROR_OCCURRED Unexpected error occurred N/A

Request Curl example 

curl -k -X GET "https://<machine_IP>/FireFlow/api/change-requests/traffic/<ChangeRequestID>/active-change" -H "Cookie:RT_SID_FireFlow.443=<Cookie_value>"

Response example for 200 

{

"status": "Success",

"messages": [],

"data": {

"changeRequestId": 635,

"activeChangeStatus": "Succeed",

"result": "Successfully executed cli command : set policy name "527-1" from "Trust" to "Trust" "ip-10.136.15.1/32" "ip-10.137.15.7/32" "tcp-71" permit log"  }

}

Response example for 400 

{
            "status": "Failure",
           "messages": [{
            
"code": "INVALID_REQUEST_TYPE",
"message": "Change request 638 does not match request type Traffic Change"
}],
"data": null

            
}