Trigger Work Order calculation for change request

Trigger Work Order calculation for change request for Traffic Workflow.

Resource Name: /change-request/traffic/{changeRequestId}/work-order/calculate

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.
data string

Populated when status is success. One of the following:

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

message object type

Element

Type

Description
code string Headline of error.
message string Details of error.

Response:

Status codes:

Code

Description
200

ActiveChange was triggered

400

Input validation failure

Message Code Message text Parameters
INVALID_REQUEST_TYPE Change request {0} does not match request type {1} 3 - CR id, 1 - request type
CHANGE_REQUEST_NOT_FOUND Change request {0} not found 0 - CR id
INVALID_CHANGE_REQUEST_STATUS Change request {0} is not in the expected stage for calculating {1} 0 - CR id, 1 - CR stage
OPERATION_IS_ALREADY_IN_PROGRESS {0} for change request {1} is already running 0 -ooperation name, 1 - change request Id
OPERATION_IS_ALREADY_IN_PROGRESS {0} for change request {1} is already running 0 - ooperation name, 1 -change request 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 examples 

curl -k -X POST "https://<Machine_IP>/FireFlow/api/change-request/traffic/<ChangeRequestID>/work-order/calculate" -H "Cookie:RT_SID_FireFlow.443=<Cookie_Value>"

Response example for 200

{"status": "Success",

"messages": [],

"data": "Trigger work order for change request 64 has finished successfully"} }

Response example for 400 

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