データスキーマ: 共通モデル

code文字列必須

安定した機械可読コード。

制約

enum

["request.malformed", "authentication.required", "authentication.invalid_credentials", "authorization.scope_denied", "authorization.ip_not_allowed", "authorization.client_ip_unverified", "entitlements.api_disabled", "entitlements.operation_disabled", "entitlements.limit_exceeded", "entitlements.resource_blocked", "resource.not_found", "request.method_not_allowed", "resource.version_conflict", "resource.state_conflict", "resource.in_use", "resource.already_exists", "idempotency.key_reused", "request.too_large", "request.unsupported_media_type", "request.validation_failed", "rate_limit.exceeded", "capacity.queue_full", "capacity.wait_timeout", "internal.error", "gateway.bad_response", "service.unavailable", "gateway.timeout"]

例: "authentication.invalid_credentials"

fields配列 <FieldError > | null任意

フィールドごとの検証エラー。

例: null

message文字列必須

人向けの説明。プログラムの判断にはエラーコードを使います。

例: "The credentials are invalid."

追加フィールド: いいえ

dataMutationData 必須

レスポンス例 · MutationData.

例: {"deleted":false,"id":"example","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

レスポンスのメタデータ。

例: {"request_id":"example"}

追加フィールド: いいえ

locale文字列必須

このリクエストで選択した言語。

例: "en"

market_code文字列必須

コンテキストエンドポイントが返した市場コード。

例: "PL"

market_id文字列必須

コンテキストエンドポイントが返した市場識別子。

例: "example"

request_id文字列必須

申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。

minLength: 1maxLength: 100

例: "example"

追加フィールド: いいえ

locale文字列必須

このリクエストで選択した言語。

例: "en"

market_code文字列必須

コンテキストエンドポイントが返した市場コード。

例: "PL"

market_id文字列必須

コンテキストエンドポイントが返した市場識別子。

例: "example"

paginationPagination 必須

カーソルによるページ分割のメタデータ。

例: {"has_more":false,"limit":20,"next_cursor":null}

request_id文字列必須

申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。

minLength: 1maxLength: 100

例: "example"

追加フィールド: いいえ

errorApiError 必須

構造化されたエラー情報。

例: {"code":"authentication.invalid_credentials","fields":null,"message":"The credentials are invalid."}

metaRequestMeta 必須

レスポンスのメタデータ。

例: {"request_id":"example-request"}

追加フィールド: いいえ

code文字列必須

安定した機械可読コード。

制約

enum

["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]

field文字列必須

検証エラーに関連するフィールド。

minLength: 1maxLength: 128

location文字列必須

ロケーション情報。

制約

enum

["path", "query", "header", "body"]

追加フィールド: いいえ

amount文字列必須

JSON 文字列として表した10進数の金額。null は許可される場合のみ。

例: "0.00"

currency文字列必須

金額の通貨コード。

制約

pattern

"^[A-Z]{3}$"

例: "PLN"

minor_units整数必須

通貨で使用する小数桁数。

minimum: 0maximum: 4

例: 2

追加フィールド: いいえ

deleted真偽値必須

削除が適用されたかどうか。

例: false

id文字列必須

リソース識別子。返された値をそのまま保持してください。 (MutationData).

例: "example"

version整数 | null必須

同時更新制御に使うリソースバージョン。

例: 1

追加フィールド: いいえ

paginationPagination 必須

カーソルによるページ分割のメタデータ。

例: {"has_more":false,"limit":20,"next_cursor":null}

request_id文字列必須

申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。

minLength: 1maxLength: 100

例: "example"

追加フィールド: いいえ

has_more真偽値必須

次のページがあるかどうか。

例: false

limit整数必須

このページの最大レコード数。

minimum: 1maximum: 100

例: 20

next_cursor文字列 | null必須

次のページの継続値、または null。

例: null

追加フィールド: いいえ

request_id文字列必須

申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。

minLength: 1maxLength: 100

例: "example"

追加フィールド: いいえ