本文へ移動

API ドキュメント

v1.0.0

経過

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

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

案件の公開された出来事を新しい順に返します:公告、新しい報告書、破産管財人の変更、ニュース、オークション。それぞれに出典の区分が付きます。1ページ30件、per_page で最大100件。手続が移行または移管された場合は、以前の案件の出来事も from_case 付きで含まれます。

パスパラメーター

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

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

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

クエリパラメーター

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

ページ番号

integer | nullページ番号
per_page

1ページあたりの結果数(最大100)

integer | null1ページあたりの結果数(最大100)

応答、HTTP 200

Public data

応答、HTTP 200

応答、HTTP 200
名前型説明
data 必須 object[]
data[].id 必須 string
data[].type 必須 string
data[].occurred_at 必須 string | null
data[].from_case 必須 object | null
data[].from_case.id 必須 string
data[].from_case.case_number 必須 string
data[].details 必須 object
data[].details.report_id mixed
data[].details.report_number mixed
data[].details.report_date mixed
data[].details.title mixed
data[].details.description mixed
data[].details.type mixed
data[].details.curator mixed
data[].details.role mixed
data[].details.status mixed
data[].details.from mixed
data[].details.to mixed
data[].details.reason mixed
data[].details.provider mixed
data[].details.publication_id mixed
data[].details.date_basis mixed
data[].details.is_final mixed
meta 必須 object
meta.total 必須 integer
meta.page 必須 integer
meta.last_page 必須 integer

応答、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 に記載されています。各値が出典とともにどのように構成されているかは、次をご覧ください: データと出典文書