日本語

リクエストとレスポンス

HTTP ステータス、型付き JSON データ、リクエストのメタデータを合わせて確認します。

リクエスト

Content-Type: application/json: JSON の書き込みには Content-Type: application/json を指定してください。
data · meta: 成功レスポンスには data と meta が含まれ、コレクションのレスポンスにはページ分割情報も含まれます。
error.code · error.message: エラーには error.code、error.message、必要に応じてフィールド情報が含まれます。

データ型

必須かどうかと null を許可するかは別です。
スキーマが許可する場合、必須フィールドでも null を含められます。
JSON の真偽値、整数、文字列、null を型変換せず保持してください。
金額は10進数の文字列です。
価格計算に2進浮動小数点数を使わないでください。

64-bit · expected_version

一部の同時更新制御用バージョンは符号付き64ビット整数です。
JavaScript クライアントは Number.MAX_SAFE_INTEGER を超える値を損失なく JSON として扱い、元の整数表現で送信する必要があります。
バージョンを丸めたり JSON 文字列に変換したりしないでください。

ページ分割

エラーと復旧

ヘッダー

Cache-Control文字列任意: レスポンスのキャッシュ方針。

const: "no-store"
X-Correlation-ID文字列任意: この HTTP リクエストを追跡する識別子。
WWW-Authenticate文字列任意: サーバーが要求する認証方式。
Allow文字列任意: このリソースが対応する HTTP メソッド。
Retry-After整数任意: 再試行までに最低限待つ秒数。

minimum: 0
Location文字列任意: 作成したリソースの相対 URL。