Skip to content
Changeset Second Opinion

Ask for a job to end

POST
/api/v1/jobs/{id}/cancel
curl --request POST \
  --url https://example.com/api/v1/jobs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel

A queued job is cancelled at once; a running one ends at its next step. Repeats are fine.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
Id
string format: uuid

Responses

Section titled “Responses”

202

Section titled “202”

Successful Response

Media typeapplication/json
Job

Status of a durable background job; poll about every 2 seconds.

object
attempts
Attempts
integer
0
created_at
required
Created At
string format: date-time
error
Any of:
string
id
required
Id
string format: uuid
kind
required
JobKind

Kind of background work.

string
Allowed values: analyze draft
result_ref
Any of:
JobResultRef

What a succeeded job produced.

object
draft_id
Any of:
string format: uuid
run_id
Any of:
string format: uuid
status
required
JobStatus

State machine of a durable background job.

string
Allowed values: queued running succeeded failed cancelled
step
Any of:
string
Allowed values: fetch_evidence snapshot decide persist draft
updated_at
required
Updated At
string format: date-time

Example 

{
  "attempts": 0,
  "kind": "analyze",
  "status": "queued",
  "step": "fetch_evidence"
}

401

Section titled “401”

Unauthorized

Problem

Application/problem+json body. Extension members (for example job_id) are allowed.

object
detail
Any of:
string
errors
Any of:
Array<object>
FieldError

One validation failure: where, what, and a stable machine code (never the input value).

object
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
instance
Any of:
string
request_id
required
Request Id
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
key
additional properties
any

Example 

{
  "type": "about:blank"
}

403

Section titled “403”

Forbidden

Problem

Application/problem+json body. Extension members (for example job_id) are allowed.

object
detail
Any of:
string
errors
Any of:
Array<object>
FieldError

One validation failure: where, what, and a stable machine code (never the input value).

object
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
instance
Any of:
string
request_id
required
Request Id
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
key
additional properties
any

Example 

{
  "type": "about:blank"
}

404

Section titled “404”

Not Found

Problem

Application/problem+json body. Extension members (for example job_id) are allowed.

object
detail
Any of:
string
errors
Any of:
Array<object>
FieldError

One validation failure: where, what, and a stable machine code (never the input value).

object
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
instance
Any of:
string
request_id
required
Request Id
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
key
additional properties
any

Example 

{
  "type": "about:blank"
}

409

Section titled “409”

Conflict

Problem

Application/problem+json body. Extension members (for example job_id) are allowed.

object
detail
Any of:
string
errors
Any of:
Array<object>
FieldError

One validation failure: where, what, and a stable machine code (never the input value).

object
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
instance
Any of:
string
request_id
required
Request Id
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
key
additional properties
any

Example 

{
  "type": "about:blank"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}

Map data © OpenStreetMap contributors, under the Open Database Licence. Code under the Apache-2.0 licence. Made by Yogesh.

Changeset Second Opinion is an independent open source tool for OpenStreetMap reviewers. It is not endorsed by, sponsored by or affiliated with the OpenStreetMap Foundation. OpenStreetMap is a trademark of the OpenStreetMap Foundation, used under itstrademark policy.