本文へ移動

API ドキュメント

v1.0.0

報告書間の変更

GET /api/v1/cases/{case}/changes

スコープ:cases:read 3 クレジット

2つの公開報告書の違い:変更された金額と項目を、項目ごとの出所とともに返します。既定では最新とその前の報告書を比較します。from と to で別の報告書を、since で指定日より前の最新の報告書を選べます。

パスパラメーター

パスパラメーター
名前型説明
case 必須

案件 ID(ULID)または案件のスラッグ

string案件 ID(ULID)または案件のスラッグ

クエリパラメーター

クエリパラメーター
名前型説明
from

1つ目の報告書の ID

string | null1つ目の報告書の ID
to

2つ目の報告書の ID

string | null2つ目の報告書の ID
since

この日付より前の最新の報告書と比較

string | nullこの日付より前の最新の報告書と比較

応答、HTTP 200

Public data

応答、HTTP 200

応答、HTTP 200
名前型説明
data 必須 object | null
data.from 必須 object
data.from.id 必須 string
data.from.number 必須 integer | null
data.from.title 必須 string
data.from.published_on 必須 string
data.from.document_url 必須 string | null
data.to 必須 object
data.to.id 必須 string
data.to.number 必須 integer | null
data.to.title 必須 string
data.to.published_on 必須 string
data.to.document_url 必須 string | null
data.values 必須 object[]
data.values[].field 必須 string
data.values[].kind 必須 string
data.values[].change 必須 string
data.values[].from 必須 object | null
data.values[].from.value 必須 number | null
data.values[].from.state 必須 enum known, not_mentioned, not_known, not_reported
data.values[].from.qualifier 必須 string | null
data.values[].to 必須 object | null
data.values[].to.value 必須 number | null
data.values[].to.state 必須 enum known, not_mentioned, not_known, not_reported
data.values[].to.qualifier 必須 string | null
data.values[].delta 必須 number | null
data.values[].from_source 必須 object | null
data.values[].from_source.document 必須 object | null
data.values[].from_source.document.id 必須 string
data.values[].from_source.document.title 必須 string | null
data.values[].from_source.document.report_number 必須 integer | null
data.values[].from_source.document.report_date 必須 string | null
data.values[].from_source.document.published_on 必須 string | null
data.values[].from_source.document.page_count 必須 integer | null
data.values[].from_source.document.url 必須 string | null
data.values[].from_source.document.sha256 必須 string | null
data.values[].from_source.page 必須 integer | null
data.values[].from_source.section 必須 string | null
data.values[].from_source.excerpt 必須 string | null
data.values[].to_source 必須 object | null
data.values[].to_source.document 必須 object | null
data.values[].to_source.document.id 必須 string
data.values[].to_source.document.title 必須 string | null
data.values[].to_source.document.report_number 必須 integer | null
data.values[].to_source.document.report_date 必須 string | null
data.values[].to_source.document.published_on 必須 string | null
data.values[].to_source.document.page_count 必須 integer | null
data.values[].to_source.document.url 必須 string | null
data.values[].to_source.document.sha256 必須 string | null
data.values[].to_source.page 必須 integer | null
data.values[].to_source.section 必須 string | null
data.values[].to_source.excerpt 必須 string | null
data.topics 必須 object[]
data.topics[].topic 必須 string
data.topics[].change 必須 string
data.topics[].from 必須 string | null
data.topics[].to 必須 string | null
data.topics[].investigation 必須 boolean
data.topics[].to_source 必須 object | null
data.topics[].to_source.document 必須 object | null
data.topics[].to_source.document.id 必須 string
data.topics[].to_source.document.title 必須 string | null
data.topics[].to_source.document.report_number 必須 integer | null
data.topics[].to_source.document.report_date 必須 string | null
data.topics[].to_source.document.published_on 必須 string | null
data.topics[].to_source.document.page_count 必須 integer | null
data.topics[].to_source.document.url 必須 string | null
data.topics[].to_source.document.sha256 必須 string | null
data.topics[].to_source.page 必須 integer | null
data.topics[].to_source.section 必須 string | null
data.topics[].to_source.excerpt 必須 string | null
data.summary 必須 object
meta 必須 object
meta.reports 必須 object[]
meta.reports[].id 必須 string
meta.reports[].number 必須 integer | null
meta.reports[].title 必須 string
meta.reports[].published_on 必須 string
meta.reports[].document_url 必須 string | null

応答、HTTP 404

Not found

応答、HTTP 404

応答、HTTP 404
名前型説明
error 必須 object
error.code 必須

Stable error code, for example not_found or validation_failed

stringStable error code, for example not_found or validation_failed
error.message 必須

Human-readable explanation

stringHuman-readable explanation
error.details

Extra information, such as the fields that failed validation

objectExtra information, such as the fields that failed validation

応答、HTTP 422

Validation error

応答、HTTP 422

応答、HTTP 422
名前型説明
error 必須 object
error.code 必須

Stable error code, for example not_found or validation_failed

stringStable error code, for example not_found or validation_failed
error.message 必須

Human-readable explanation

stringHuman-readable explanation
error.details

Extra information, such as the fields that failed validation

objectExtra information, such as the fields that failed validation

応答のフィールドは openapi.json に記載されています。各値が出典とともにどのように構成されているかは、次をご覧ください: データと出典文書