Sign in
jobs

Cancel Job

Cancel an in-flight route generation job.

post/api/jobs/{job_id}/cancel

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

job_idstring uuid required

Response

Successful Response

error_messagestring nullable
job_idstring uuid required
progress'Pending' | 'Running' | 'Cancelled' | 'Completed' | 'Failed'
route_group_idstring uuid nullable
routes_createdinteger nullable
total_distance_kmnumber nullable
total_familiesinteger nullable
total_stopsinteger nullable

Changes

No recorded changes to this operation across all 1 revision of this API.