Get Work Order calculation status

Get Work Order calculation status for a change request for Traffic Workflow.

The calculation can be started using the Trigger Work Order calculation for change request API or in FireFlow user interface.

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

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.
data data object type Populated when status is success

message object type

Element

Type

Description

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

data object type

Element

Type

Description

workOrderCalculationStatus String

Status of the Work Order calculation. One of these:

  • Completed
  • Completed with errors
  • In progress
  • Not started
calculationTimeStamp String Only relevant when workOrderCalculationStatus is completed.

Response:

Status codes:

Code

Description

200

Operation completed successfully

400

Input validation failure

403 Authentication failure.
Work order 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-request/traffic/<ChangeRequestID>/work-order/calculation/status" -H "Cookie:RT_SID_FireFlow.443=<Cookie_Value>"

Response example for 200

{"status": "Success",

"messages": [],

"data":{

"workOrderCalculationStatus": "Completed",

"calculationTimeStamp": "Wed 26 Aug 2020T16:54:47Z"

}

}

Response example for 400

{

"status": "Failure",

"messages": [{

"code": "CHANGE_REQUEST_NOT_FOUND",

"message": "Change request 6354 not found"

}

],

"data": null

}

Back to top