Tietoskeemat: Yhteiset mallit

codeMerkkijonoPakollinen

Vakaa koneellisesti luettava koodi.

Rajoitukset

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

Esimerkki: "authentication.invalid_credentials"

fieldsTaulukko <FieldError > | nullValinnainen

Yksittäisten kenttien validointivirheet.

Esimerkki: null

messageMerkkijonoPakollinen

Ihmiselle luettava selitys; käytä ohjelmalogiikassa virhekoodia.

Esimerkki: "The credentials are invalid."

Lisäkentät: Ei

dataMutationData Pakollinen

Vastausesimerkki · MutationData.

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

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Pakollinen

Vastauksen metatiedot.

Esimerkki: {"request_id":"example"}

Lisäkentät: Ei

localeMerkkijonoPakollinen

Tälle pyynnölle valittu kieli.

Esimerkki: "en"

market_codeMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinakoodi.

Esimerkki: "PL"

market_idMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinatunniste.

Esimerkki: "example"

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100

Esimerkki: "example"

Lisäkentät: Ei

localeMerkkijonoPakollinen

Tälle pyynnölle valittu kieli.

Esimerkki: "en"

market_codeMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinakoodi.

Esimerkki: "PL"

market_idMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinatunniste.

Esimerkki: "example"

paginationPagination Pakollinen

Kohdistinpohjaisen sivutuksen metatiedot.

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

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100

Esimerkki: "example"

Lisäkentät: Ei

errorApiError Pakollinen

Rakenteiset virhetiedot.

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

metaRequestMeta Pakollinen

Vastauksen metatiedot.

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

Lisäkentät: Ei

codeMerkkijonoPakollinen

Vakaa koneellisesti luettava koodi.

Rajoitukset

enum

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

fieldMerkkijonoPakollinen

Validointivirheeseen liittyvä kenttä.

minLength: 1maxLength: 128

locationMerkkijonoPakollinen

Sijaintitiedot.

Rajoitukset

enum

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

Lisäkentät: Ei

amountMerkkijonoPakollinen

JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

Esimerkki: "0.00"

currencyMerkkijonoPakollinen

Summan valuuttakoodi.

Rajoitukset

pattern

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

Esimerkki: "PLN"

minor_unitsKokonaislukuPakollinen

Valuutan käyttämien desimaalinumeroiden määrä.

minimum: 0maximum: 4

Esimerkki: 2

Lisäkentät: Ei

deletedTotuusarvoPakollinen

Toteutettiinko poisto.

Esimerkki: false

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa. (MutationData).

Esimerkki: "example"

versionKokonaisluku | nullPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

paginationPagination Pakollinen

Kohdistinpohjaisen sivutuksen metatiedot.

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

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100

Esimerkki: "example"

Lisäkentät: Ei

has_moreTotuusarvoPakollinen

Onko seuraava sivu käytettävissä.

Esimerkki: false

limitKokonaislukuPakollinen

Tämän sivun tietueiden enimmäismäärä.

minimum: 1maximum: 100

Esimerkki: 20

next_cursorMerkkijono | nullPakollinen

Seuraavan sivun jatkoarvo tai null.

Esimerkki: null

Lisäkentät: Ei

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100

Esimerkki: "example"

Lisäkentät: Ei