Canceling Tasks

Tasks can be canceled by POSTing to /v1/tasks/{task_id}/cancel.

URL Parameters

  • {task_id} - Cancel the task with this task_id

Status Codes

  • 200 - Success.
  • 401 - Authentication required.
  • 404 - The task_id does not exist, or the current user does not have permission to access it.

task_cancel_response

Name Type Description
task_id string The ID of the canceled task.

Example

POST https://routecloud.telogis.com/v1/tasks/v4AQjZm1eUW0gFnECtxqAw/cancel HTTP/1.1
X-Telogis-Session-Id: e938d41c-d519-4f07-b0a9-26d4745d6e74
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
  "task_id": "v4AQjZm1eUW0gFnECtxqAw",
  "message": "Task v4AQjZm1eUW0gFnECtxqAw was canceled."
}

If the task was not found a 404 is returned instead.

See Also