Run lifecycle
In this document you will learn about the statuses of a run and a run’s lifecycle.
(A run’s status is indicated on the Run details at the top right in the sidebar in the Platform UI, or by the solverStatus field in the API.)
Run statuses
A run can be in one of several states:
| Status | Description | API value |
|---|---|---|
Scheduled |
The data has been received and is in the queue to be solved. |
|
Started |
The input data is being converted into the planning problem and augmented with additional information, such as distance matrix (if applicable). |
|
Solving |
The planning problem is currently being solved. |
|
Incomplete |
A full solution was not found before the run was terminated. |
|
Completed |
Solving has completed and no further solution will be generated. |
|
Failed |
An error has occurred and solving was unsuccessful. |
|
Typical lifecycle
-
When a run is submitted, its first status is "Scheduled", then typically goes through "Started" and "Solving" to "Completed".
-
A run can go to status "Failed" because of errors during any previous status.
Actions
-
Cancelling a run: When a run is Cancelled (via the Platform UI or the API) it goes from the current state to either "Incomplete" or "Completed".
Webhooks
Our platform supports webhook events. Events are sent during the lifecycle of a run. See Webhooks for details.