跳到正文

API 文档

v1.0.0

报告

GET /api/v1/reports/{report}

scope:reports:read 1 个额度

一份公开报告,包含元数据、处理状态、数据和事项。

路径参数

路径参数
名称类型说明
report 必填

报告 id(ULID)

string报告 id(ULID)

响应,HTTP 200

Public data

响应,HTTP 200

响应,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。每个值及其来源的构成方式请参阅 数据与来源文件