Model response
The response to the model request is the optimized route plan, metadata about the model dataset, and key performance indicators (KPIs).
| Id | Format | Description |
|---|---|---|
metadata |
object |
The model dataset metadata. |
modelOutput |
object |
The model output containing the optimized route plan. |
kpis |
object |
Overall Key performance indicators (KPIs) of the vehicle route plan. |
1. Model metadata
Contains metadata about the model solving dataset.
The metadata object contains five timestamps, each marking a distinct phase of the dataset lifecycle. See dataset lifecycle for details on each phase and its status.
| Id | Format | Description | Example |
|---|---|---|---|
activeDateTime |
string (ISO 8601 date, time and time zone offset) |
The time solving the model changed to active state. |
|
completeDateTime |
string (ISO 8601 date, time and time zone offset) |
The time solving the model request completed. |
|
id |
string |
Unique identifier of the dataset |
|
name |
string |
Name of the solver dataset |
|
score |
string |
The current score of the route plan, as calculated by the solver. |
|
shutdownDateTime |
string (ISO 8601 date, time and time zone offset) |
The time solving the model solution was stored. |
|
solverStatus |
string (one of: "NOT_SOLVING", "SOLVING_SCHEDULED", "SOLVING_ACTIVE", "SOLVING_COMPLETED", "SOLVING_FAILED", "SOLVING_DISABLED") |
The status of the solver. |
|
startDateTime |
string (ISO 8601 date, time and time zone offset) |
The time solving the model request started. |
|
submitDateTime |
string (ISO 8601 date, time and time zone offset) |
The time the model request was accepted. |
|