Datová schémata: Společné modely

codeŘetězecPovinné

Stabilní strojově čitelný kód.

Omezení

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"]

Příklad: "authentication.invalid_credentials"

fieldsPole <FieldError > | nullVolitelné

Chyby validace jednotlivých polí.

Příklad: null

messageŘetězecPovinné

Vysvětlení pro člověka; v programové logice používejte kód chyby.

Příklad: "The credentials are invalid."

Další pole: Ne

dataMutationData Povinné

Příklad odpovědi · MutationData.

Příklad: {"deleted":false,"id":"example","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Povinné

Metadata odpovědi.

Příklad: {"request_id":"example"}

Další pole: Ne

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

Příklad: "en"

market_codeŘetězecPovinné

Kód trhu vrácený koncovým bodem kontextu.

Příklad: "PL"

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

Příklad: "example"

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

Příklad: "example"

Další pole: Ne

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

Příklad: "en"

market_codeŘetězecPovinné

Kód trhu vrácený koncovým bodem kontextu.

Příklad: "PL"

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

Příklad: "example"

paginationPagination Povinné

Metadata stránkování pomocí kurzoru.

Příklad: {"has_more":false,"limit":20,"next_cursor":null}

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

Příklad: "example"

Další pole: Ne

errorApiError Povinné

Strukturované informace o chybě.

Příklad: {"code":"authentication.invalid_credentials","fields":null,"message":"The credentials are invalid."}

metaRequestMeta Povinné

Metadata odpovědi.

Příklad: {"request_id":"example-request"}

Další pole: Ne

codeŘetězecPovinné

Stabilní strojově čitelný kód.

Omezení

enum

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

fieldŘetězecPovinné

Pole související s chybou validace.

minLength: 1maxLength: 128

locationŘetězecPovinné

Informace o umístění.

Omezení

enum

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

Další pole: Ne

amountŘetězecPovinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

Příklad: "0.00"

currencyŘetězecPovinné

Kód měny částky.

Omezení

pattern

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

Příklad: "PLN"

minor_unitsCelé čísloPovinné

Počet desetinných míst používaných měnou.

minimum: 0maximum: 4

Příklad: 2

Další pole: Ne

deletedLogická hodnotaPovinné

Zda bylo smazání provedeno.

Příklad: false

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (MutationData).

Příklad: "example"

versionCelé číslo | nullPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

paginationPagination Povinné

Metadata stránkování pomocí kurzoru.

Příklad: {"has_more":false,"limit":20,"next_cursor":null}

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

Příklad: "example"

Další pole: Ne

has_moreLogická hodnotaPovinné

Zda je dostupná další stránka.

Příklad: false

limitCelé čísloPovinné

Maximální počet záznamů na této stránce.

minimum: 1maximum: 100

Příklad: 20

next_cursorŘetězec | nullPovinné

Hodnota pro pokračování na další stránku, nebo null.

Příklad: null

Další pole: Ne

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

Příklad: "example"

Další pole: Ne