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
403 Authentication failure.
ActiveChange APIs have the same user-permissions as the UI. If a user without permissions (like requestor) is trying to call one of these APIs, he will get code 403: status is failure, the messages field contains NO_PERMISSIONS code with relevant message.

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

            
}