Podatkovne sheme: Skupni modeli

codeNizObvezno

Stabilna strojno berljiva koda.

Omejitve

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

Primer: "authentication.invalid_credentials"

fieldsPolje elementov <FieldError > | nullIzbirno

Napake preverjanja posameznih polj.

Primer: null

messageNizObvezno

Človeku razumljiva razlaga; v programski logiki uporabite kodo napake.

Primer: "The credentials are invalid."

Dodatna polja: Ne

dataMutationData Obvezno

Primer odgovora · MutationData.

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

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obvezno

Metapodatki odgovora.

Primer: {"request_id":"example"}

Dodatna polja: Ne

localeNizObvezno

Jezik, izbran za to zahtevo.

Primer: "en"

market_codeNizObvezno

Koda trga, vrnjena s končno točko konteksta.

Primer: "PL"

market_idNizObvezno

Identifikator trga, vrnjen s končno točko konteksta.

Primer: "example"

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

Primer: "example"

Dodatna polja: Ne

localeNizObvezno

Jezik, izbran za to zahtevo.

Primer: "en"

market_codeNizObvezno

Koda trga, vrnjena s končno točko konteksta.

Primer: "PL"

market_idNizObvezno

Identifikator trga, vrnjen s končno točko konteksta.

Primer: "example"

paginationPagination Obvezno

Metapodatki straničenja s kazalcem.

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

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

Primer: "example"

Dodatna polja: Ne

errorApiError Obvezno

Strukturirani podatki o napaki.

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

metaRequestMeta Obvezno

Metapodatki odgovora.

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

Dodatna polja: Ne

codeNizObvezno

Stabilna strojno berljiva koda.

Omejitve

enum

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

fieldNizObvezno

Polje, povezano z napako preverjanja.

minLength: 1maxLength: 128

locationNizObvezno

Podatki o lokaciji.

Omejitve

enum

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

Dodatna polja: Ne

amountNizObvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

Primer: "0.00"

currencyNizObvezno

Koda valute zneska.

Omejitve

pattern

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

Primer: "PLN"

minor_unitsCelo številoObvezno

Število decimalnih mest valute.

minimum: 0maximum: 4

Primer: 2

Dodatna polja: Ne

deletedLogična vrednostObvezno

Ali je bilo brisanje izvedeno.

Primer: false

idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (MutationData).

Primer: "example"

versionCelo število | nullObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

paginationPagination Obvezno

Metapodatki straničenja s kazalcem.

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

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

Primer: "example"

Dodatna polja: Ne

has_moreLogična vrednostObvezno

Ali je na voljo naslednja stran.

Primer: false

limitCelo številoObvezno

Največje število zapisov na tej strani.

minimum: 1maximum: 100

Primer: 20

next_cursorNiz | nullObvezno

Nadaljevalna vrednost za naslednjo stran ali null.

Primer: null

Dodatna polja: Ne

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

Primer: "example"

Dodatna polja: Ne