task_status_response
task_status_response represents the status of a task.
| Name | Type | Description |
|---|---|---|
| finished_time | datetime | The time that the task finished, in UTC, rounded down to the nearest millisecond. Not supplied if the task is still running. |
| last_status_time | datetime | The time that RouteCloud last updated the status of the task, in UTC, rounded down to the nearest millisecond. |
| started_time | datetime | The start time of the task, in UTC, rounded down to the nearest millisecond. |
| status | string | The status of the task. Can be: queued, running, completed, failed, or canceled. |
| status_information | object | Extra information relating to the status of the task. Not included with a tasks list request. The information contained in the object depends on the type of task (see below). |
| task_id | string | The ID of the task. |
status_information
The status_information field contains additional information relating to the running task. This information is not included if the task has not yet started, or if it has finished.
For build, sequence, evaluate, recommend, and insert requests, the following information is provided:
| Name | Type | Description |
|---|---|---|
| aggregates | problem_aggregates | A summary of the calculated values as they currently stand. Can be used to give an indication of overall progress. |
| build_phase | integer | The number of the build phase RouteCloud is currently performing. |
| current_state_percent_complete | float | The percentage of progress through the current optimizer state, if known. |
| num_build_phases | integer | The total number of build phases RouteCloud needs to perform to complete the task. |
| optimizer_state | string | A description of the current state of the optimization operation. Can be: calculating_times_and_distances, generating_route_options, assigning_jobs_to_routes, optimizing_routes, finishing_build, or calculating_route_paths. |