Skip to content
Changeset Second Opinion

Evidence snapshot of a case

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

The latest snapshot, or the one named by snapshot_id.

Parameters

Section titled “Parameters”

Path Parameters

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

Query Parameters

Section titled “Query Parameters”
snapshot_id
Any of:
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
EvidenceSnapshot

Everything fetched about the changeset at one time, with the coverage record.

object
case_id
required
Case Id
string format: uuid
coverage
required
Coverage

Honest record of what was and was not fetched; mandatory on every snapshot.

object
discussion
FetchStatus

Outcome of an auxiliary fetch (user profile, discussion).

string
default: fetched
Allowed values: fetched failed skipped
elements_detailed
required
Elements Detailed
integer
elements_in_changeset
required
Elements In Changeset
integer
elements_skipped_budget
Elements Skipped Budget
integer
0
history_gaps
History Gaps
Array<object>
HistoryGap

An element whose prior version could not be reconstructed, with the reason.

object
osm_id
required
Osm Id
integer
osm_type
required
OsmType

OSM element type.

string
Allowed values: node way relation
reason
required
CoverageGapReason

Why a prior version could not be reconstructed.

string
Allowed values: redacted not_found timeout budget
score
Score
number
default: 1 <= 1
snapshot_truncated
Snapshot Truncated
boolean
user_profile
FetchStatus

Outcome of an auxiliary fetch (user profile, discussion).

string
default: fetched
Allowed values: fetched failed skipped
discussion
Discussion
Array<object>
DiscussionEntry

A changeset discussion comment; text is raw here and sanitized at render time.

object
author_display
required
Author Display
string
date
required
Date
string format: date-time
id
required
Id
integer
text
required
Text
string
elements
Elements
Array<object>
ChangedElement

A changed object as the API returns it: the stored facts plus its evidence id.

object
action
required
ChangeAction

Action an element underwent in the changeset.

string
Allowed values: create modify delete
age_days
Any of:
integer
created_at_first_version
Any of:
string format: date-time
created_by_uid
Any of:
integer
evidence_id
Any of:
string
/^E[1-9][0-9]*$/
geometry_change
Any of:
GeometryChange

Coarse geometry delta of a modified element.

object
node_moved_m
Any of:
number
way_node_delta
Any of:
integer
osm_id
required
Osm Id
integer
osm_type
required
OsmType

OSM element type.

string
Allowed values: node way relation
source
EvidenceSource

Where a fact came from: live API, replayed fixture, or computed by code.

string
default: osm_api
Allowed values: osm_api replay derived
tags_after
Any of:
object
key
additional properties
string
tags_before
Any of:
object
key
additional properties
string
version_after
required
Version After
integer
version_before
Any of:
integer
evidence_version
required
Evidence Version
string
fetched_at
required
Fetched At
string format: date-time
id
required
Id
string format: uuid
provisional
Provisional
boolean
rendered_text
Rendered Text
string
""
rendered_tokens
Rendered Tokens
integer
0
source
required
EvidenceSource

Where a fact came from: live API, replayed fixture, or computed by code.

string
Allowed values: osm_api replay derived
tag_diffs
Tag Diffs
Array<object>
TagDiff

A single tag key difference between before and after versions of an element.

object
after
Any of:
string
before
Any of:
string
change
required
TagChange

Kind of tag difference between two versions.

string
Allowed values: added removed changed
key
required
Key
string
osm_id
required
Osm Id
integer
osm_type
required
OsmType

OSM element type.

string
Allowed values: node way relation

Example 

{
  "coverage": {
    "discussion": "fetched",
    "elements_skipped_budget": 0,
    "history_gaps": [
      {
        "osm_type": "node",
        "reason": "redacted"
      }
    ],
    "score": 1,
    "snapshot_truncated": false,
    "user_profile": "fetched"
  },
  "elements": [
    {
      "action": "create",
      "osm_type": "node",
      "source": "osm_api"
    }
  ],
  "provisional": false,
  "rendered_text": "",
  "rendered_tokens": 0,
  "source": "osm_api",
  "tag_diffs": [
    {
      "change": "added",
      "osm_type": "node"
    }
  ]
}

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

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.