Polling

In production, we recommend configuring Webhooks to retrieve the solutions to your submitted datasets from Timefold.

In local development environments, we recommend Server sent events (SSE), however, when server sent events are not possible, you can poll Timefold.

To poll for the solution to a dataset, use the dataset ID from the response to the POST operation and make a GET request to the following endpoint:

/v1/{model-entity-name}/<ID>/metadata

  • Replace <ID> with the dataset ID.

  • For field service routing and pick-up and delivery routing, replace {model-entity-name} with route-plans.

  • For employee shift scheduling, replace {model-entity-name} with schedules.

The solverStatus can be in one of several statuses. Solutions are final when the solverStatus is SOLVING_COMPLETED. Datasets that are not solved will not have the SOLVING_COMPLETED status.

See Webhooks for more information.