報告書
GET /api/v1/reports/{report}
スコープ:reports:read 1 クレジット
メタデータ、処理状況、データ、項目を含む公開報告書。
パスパラメーター
| 名前 | 型 | 説明 |
|---|---|---|
report 必須 報告書 ID(ULID) | string | 報告書 ID(ULID) |
応答、HTTP 200
Public data
応答、HTTP 200
| 名前 | 型 | 説明 |
|---|---|---|
data 必須 | object | |
data.id 必須 | string | |
data.number 必須 | integer | null | |
data.title 必須 | string | |
data.is_final 必須 | boolean | |
data.published_on 必須 | string | |
data.period_start 必須 | string | null | |
data.period_end 必須 | string | null | |
data.page_count 必須 | integer | null | |
data.document_url 必須 | string | null | |
data.links 必須 | object | |
data.links.self 必須 | string | |
data.case 必須 | object | |
data.case.id 必須 | string | |
data.case.name 必須 | string | |
data.case.links 必須 | object | |
data.case.links.self 必須 | string | |
data.sha256 必須 | string | null | |
data.sections 必須 | object[] | |
data.sections[].code 必須 | string | |
data.sections[].heading 必須 | string | |
data.sections[].page_from 必須 | integer | |
data.sections[].page_to 必須 | integer | |
data.values 必須 | object[] | |
data.values[].field 必須 | string | |
data.values[].kind 必須 | enum | count, hours, decimal, amount |
data.values[].value 必須 | number | null | |
data.values[].state 必須 | string | |
data.values[].qualifier 必須 | string | null | |
data.values[].as_of 必須 | string | |
data.values[].source 必須 | object | null | |
data.values[].source.document 必須 | object | null | |
data.values[].source.document.id 必須 | string | |
data.values[].source.document.title 必須 | string | null | |
data.values[].source.document.report_number 必須 | integer | null | |
data.values[].source.document.report_date 必須 | string | null | |
data.values[].source.document.published_on 必須 | string | null | |
data.values[].source.document.page_count 必須 | integer | null | |
data.values[].source.document.url 必須 | string | null | |
data.values[].source.document.sha256 必須 | string | null | |
data.values[].source.page 必須 | integer | null | |
data.values[].source.section 必須 | string | null | |
data.values[].source.excerpt 必須 | string | null | |
data.topics 必須 | object[] | |
data.topics[].topic 必須 | string | |
data.topics[].state 必須 | string | |
data.topics[].source 必須 | object | null | |
data.topics[].source.document 必須 | object | null | |
data.topics[].source.document.id 必須 | string | |
data.topics[].source.document.title 必須 | string | null | |
data.topics[].source.document.report_number 必須 | integer | null | |
data.topics[].source.document.report_date 必須 | string | null | |
data.topics[].source.document.published_on 必須 | string | null | |
data.topics[].source.document.page_count 必須 | integer | null | |
data.topics[].source.document.url 必須 | string | null | |
data.topics[].source.document.sha256 必須 | string | null | |
data.topics[].source.page 必須 | integer | null | |
data.topics[].source.section 必須 | string | null | |
data.topics[].source.excerpt 必須 | string | null |
応答のフィールドは openapi.json に記載されています。各値が出典とともにどのように構成されているかは、次をご覧ください: データと出典文書