REST API

Create problem data set

Create problem data set using predefined model schema that follows OpenAPI specification. The application provides several out-of-the-box examples that can be used as a starting point.

Example 1. List sample data sets REST API endpoint call

GET /v1/demo-data

Example 2. Get sample data set REST API endpoint call

GET /v1/demo-data/{dataset_name}

Submit a data set

Submit the unsolved data set using the REST API. The application validates the input and returns a unique identifier of the problem. The solving process is scheduled and eventually starts.

Example 3. Submit problem data set REST API endpoint call

POST /v1/route-plans

Get current best solution and check status

Check the current best solution and receive information about the solving process. The solution contains the optimized route plan. Use id attribute returned by submit a data set step.

Example 4. Check status REST API endpoint call

GET /v1/route-plans/{id}

Terminate solving

Terminate the solving process and receive the current best solution. Use id attribute returned by submit a data set step.

Example 5. Terminate solving REST API endpoint call

DELETE /v1/route-plans/{id}

Get all solving processes

Get info about the status of all solving processes.

Example 6. Terminate solving REST API endpoint call

GET /v1/route-plans