Trigger ActiveChange for change request

Trigger ActiveChange for a change request sub-ticket for Traffic Workflow.

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

Request Method: POST

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 string

Populated when status is success. One of the following:

  • Trigger ActiveChange for change request {changeRequestId} has finished successfully.
  • ActiveChange operation has finished with status failure.

Response:

Status codes:

Code

Description

200

ActiveChange was triggered

400

Input validation failure

403

Authentication failure

500

Failed to complete operation.

 

Request cURL examples

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

Response example for 200

{
  "status": "Success",
  "messages": [],
  "data": "Trigger ActiveChange for change request 647 has finished successfully"

}

Response example for 400

				{
  "status": "Failure",
  "messages": [
    {
      "code": "CHANGE_REQUEST_NOT_FOUND",
      "message": "Change request 6354 not found"
    }
  ],
  "data": null
}