Skip to content
Changeset Second Opinion

Request an analysis

POST
/api/v1/cases/{id}/analyses
curl --request POST \
  --url https://example.com/api/v1/cases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/analyses \
  --header 'Content-Type: application/json' \
  --data '{ "force": false }'

202 with the job id; 200 with the run id when the latest run is current and not forced.

Parameters

Section titled “Parameters”

Path Parameters

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

Request Body

Section titled “Request Body”
Media typeapplication/json
AnalysisRequest

Request a fresh analysis; force re-runs even when the evidence is unchanged.

object
force
Force
boolean

Responses

Section titled “Responses”

200

Section titled “200”

The latest run is current

Media typeapplication/json
AnalysisCurrent

200: the latest run is current and force was not set.

object
run_id
required
Run Id
string format: uuid

Example generated

{
  "run_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

202

Section titled “202”

Successful Response

Media typeapplication/json
AnalysisAccepted

202: the analysis job was queued.

object
job_id
required
Job Id
string format: uuid

Example generated

{
  "job_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

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”

An analysis is already queued or running. The problem carries the existing job’s id in the extension member job_id.

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"
    }
  ]
}

429

Section titled “429”

Too Many Requests

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"
}

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.