Check whether a scheduling run has finished
This endpoint is intentionally lightweight so you can poll it freely. It tells you whether the run has finished and which orders were scheduled where — it does not return the plan itself. Follow the uri values to the canonical endpoints, or use the solution endpoint for everything at once.
Request URL
get https://api.plan.routific.com/v2/schedules/actions/
Request Payload
//none
Response Payload
{
"actionUuid": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
"actionName": "schedule",
"status": "finished",
"actionSummary":
{
"scheduledOrders":
[
{
"uuid": "6a8e071a-4ee0-470b-982e-b24ed1d1b90c",
"routeUuid": "246612f0-f160-4649-bb16-292ebaa43555",
"uri": "/v2/orders/6a8e071a-4ee0-470b-982e-b24ed1d1b90c"
}
],
"unscheduledOrders":
[
{
"uuid": "9b3f2c44-1d7e-4a90-b3c1-8f2e6a91d445",
"uri": "/v2/orders/9b3f2c44-1d7e-4a90-b3c1-8f2e6a91d445"
}
],
"routes":
[
{
"uuid": "246612f0-f160-4649-bb16-292ebaa43555",
"uri": "/v2/routes/246612f0-f160-4649-bb16-292ebaa43555"
}
],
"scheduledOrdersCount": 1,
"unscheduledOrdersCount": 1,
"routesCount": 1
}
}
Why an order was not scheduled
The summary tells you which orders went unscheduled, not why. Per-order reasons are returned by the scheduled solution endpoint.
| Fields | Type | Description |
|---|---|---|
| actionUuid | String | Identifies this scheduling run request. Use it to poll for status and to fetch the solution |
| actionName | String | The action performed. Always schedule for this endpoint |
| status | String | The status of the run. Possible values: pending, finished, failed |
| actionSummary | Object | Present once the run has finished |
| actionSummary.scheduledOrders | Array | Orders that were scheduled, each with the routeUuid they landed on |
| actionSummary.unscheduledOrders | Array | Orders that could not be scheduled |
| actionSummary.routes | Array | Routes touched by this run |
| scheduledOrdersCount | Integer | Number of orders scheduled on to routes |
| unscheduledOrdersCount | Integer | Number of orders that couldn't be scheduled on to routes |
| routesCount | Integer | Number of routes touched by this run |