Model response

The response to the model request is the optimized route plan, metadata about the model run, and key performance indicators (KPIs).

Id Format Description

run

object

The model run 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 run

Contains metadata about the model solving run.

The run is associated with five key timestamps, each marking a distinct phase in the process:

  • submitDateTime: The moment the run is submitted. At this stage, the run is queued and has not yet begun solving. The run status is SOLVING_SCHEDULED.

  • startDateTime: The moment the run begins initializing. During this phase, the run is not solving yet, but the model is being built and enriched with external data (e.g., incorporating map information for models involving geographical locations). The run status is SOLVING_STARTED.

  • activeDateTime: The moment the solving phase begins. At this stage, the actual problem-solving process starts. The run status is SOLVING_ACTIVE.

  • completeDateTime: The moment the solving phase concludes. At this point, the run has finished solving but has not yet undergone any post-processing (e.g., score analysis or waypoint enrichment for geographical models). The run status is either SOLVING_COMPLETED or SOLVING_FAILED.

  • shutdownDateTime: The moment the post-processing phase finishes. All tasks, including post-processing, are completed, and the run is fully finalized.

Id Format Description Example

activeDateTime

string (ISO 8601 date, time and time zone offset)

The time solving the model changed to active state.

"2023-11-29T09:09:30.825044+01:00"

completeDateTime

string (ISO 8601 date, time and time zone offset)

The time solving the model request completed.

"2023-11-29T09:09:30.825044+01:00"

id

string

Unique identifier of the solver run

"3e26e4d5-9447-46c5-8c3b-a8fef78bc1cb"

name

string

Name of the solver run

"VehicleRoutePlan-2023-11-29T09:09:30.825044+01:00"

score

string

The current score of the route plan, as calculated by the solver.

"0hard/-7medium/-8116soft"

shutdownDateTime

string (ISO 8601 date, time and time zone offset)

The time solving the model solution was stored.

"2023-11-29T09:09:30.825044+01:00"

solverStatus

string (one of: "NOT_SOLVING", "SOLVING_SCHEDULED", "SOLVING_ACTIVE", "SOLVING_COMPLETED", "SOLVING_FAILED", "SOLVING_DISABLED")

The status of the solver.

"SOLVING_COMPLETED"

startDateTime

string (ISO 8601 date, time and time zone offset)

The time solving the model request started.

"2023-11-29T09:09:30.825044+01:00"

submitDateTime

string (ISO 8601 date, time and time zone offset)

The time the model request was accepted.

"2023-11-29T09:09:30.825044+01:00"