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 Error messages Message Code Message text Parameters INVALID_REQUEST_TYPE Change request {0} does not match request type {1} 2 - CR id, 1 - request type CHANGE_REQUEST_NOT_FOUND Change request {0} not found 0 - 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. Error messages: 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. Error messages: Message Code Message text Parameters UNEXPECTED_ERROR_OCCURRED Unexpected error occurred N/A

Request Curl example

Response example for 200

Response example for 400

Back to top