本文へ移動

API ドキュメント

v1.0.0

文書

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

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

案件の公開報告書と登記簿の公告を、新しい順に元の文書へのリンク付きで返します。

パスパラメーター

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

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

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

応答、HTTP 200

Public data

応答、HTTP 200

応答、HTTP 200
名前型説明
data 必須 object[]
data[].kind 必須 enum report, publication
data[].id 必須 string
data[].title 必須 string | null
data[].report_number integer | null
data[].publication_number integer | null
data[].publication_type string
data[].date 必須 string
data[].pages integer | null
data[].source 必須 object
data[].source.name 必須 string
data[].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

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