OSos3robotics
desired-jobs

Cancel Desired Job

patch/desired-jobs/{desired_id}

Request

  • Base URL
    https://api.os3robotics.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.os3robotics.com/desired-jobs/{desired_id}
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

desired_idstring uuid required

Request body

desired_state'cancelled' required

Response

Successful Response

idstring uuid required
tenant_idstring uuid required
workspace_idstring uuid required
desired_state'running' | 'cancelled' required
status'pending' | 'active' | 'settled' required
generationinteger required
max_retriesinteger required
job_idstring uuid nullable required
idempotency_keystring required
created_bystring nullable required
created_atstring date-time required
updated_atstring date-time required
settled_atstring date-time nullable required
job_statestring nullable
last_errorstring nullable
error_countinteger
next_attempt_atstring date-time nullable
pipeline_defaultsobject nullable

Changes

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