本文へ移動

API ドキュメント

v1.0.0

オークション

GET /api/v1/auctions/{auction}

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

関連案件と関連付けの理由を含む1件のオークション。

パスパラメーター

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

オークション ID(ULID)

stringオークション ID(ULID)

応答、HTTP 200

応答、HTTP 200

応答、HTTP 200
名前型説明
data 必須 object
data.matches 必須 object[]
data.matches[].case 必須 object
data.matches[].case.id 必須 string
data.matches[].case.name 必須 string
data.matches[].case.links 必須 object
data.matches[].case.links.self 必須 string
data.sources 必須 mixed[]

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