Execution of a planning - these methods start the planning itself, help you to gather the progress and generic state (Still running? Done?) including detailed KPIs you can use to stop a planning. While other APIs return only meta data the Optiflow engine enables you to gather the complete "best known solution so far" even during an ongoing planning.
- string uuid = startOptimization( settings, locations[], orders, vehicles[], resources[],depots[], routes[], constraints, rules, metadata ) : Initiates a cost-minimizing optimization that efficiently schedules orders onto routes. The routes are assigned to the provided vehicles and satisfy the given constraints. Once the optimization is accepted, the optimization starts for the requested duration after which the resulting routes can be retrieved. Zstd or Gzip-encoded content is supported in the request body and returned in the response if accepted by the client.
- OptimizationProgressSample[] samples = getOptimizationProgress( string uuid ) : Retrieves the optimization progress. Zstd or Gzip-encoded content is returned in the response if accepted by the client.
- OptimizationResult result = getOptimizationResult( uuid ) : Retrieves the current result of the optimization. While the optimization is running, this will return intermediate metrics to track the progress. Once succeeded, the optimized routes are returned. Zstd or Gzip-encoded content is returned in the response if accepted by the client.
- void stopOptimization( uuid ): Stops an optimization. Once accepted, the optimization will stop as soon as possible and the final state of the routes can be retrieved. Zstd or Gzip-encoded content is returned in the response if accepted by the client.
- OptimizationSummaries summaries = listOptimizations( cursor, limit, createdBedore, createdAfter, name, tags, statuses ) : Retrieves a list of optimization summaries that match the specified search criteria. Zstd or Gzip-encoded content is returned in the response if accepted by the client.
- void deleteOptimization ( uuid ) : Deletes the optimization. Also stops the optimization if it is currently running. Zstd or Gzip-encoded content is returned in the response if accepted by the client.
- OptimizationRequest request = getOptimizationRequest( uuid ): Retrieves the original request for the optimization. Zstd or Gzip-encoded content is returned in the response if accepted by the client.
