Wspólne modele danych

codeTekstWymagane

Stały kod przeznaczony do przetwarzania przez integrację.

Ograniczenia

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

Przykład: "authentication.invalid_credentials"

fieldsTablica <FieldError > | nullOpcjonalne

Błędy walidacji poszczególnych pól.

Przykład: null

messageTekstWymagane

Opis przeznaczony dla człowieka; w logice programu używaj kodu błędu.

Przykład: "The credentials are invalid."

Dodatkowe pola: Nie

dataMutationData Wymagane

Przykład odpowiedzi · MutationData.

Przykład: {"deleted":false,"id":"example","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Wymagane

Metadane odpowiedzi.

Przykład: {"request_id":"example"}

Dodatkowe pola: Nie

localeTekstWymagane

Język wybrany dla tego żądania.

Przykład: "en"

market_codeTekstWymagane

Kod rynku zwrócony przez endpoint kontekstu.

Przykład: "PL"

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

Przykład: "example"

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

Przykład: "example"

Dodatkowe pola: Nie

localeTekstWymagane

Język wybrany dla tego żądania.

Przykład: "en"

market_codeTekstWymagane

Kod rynku zwrócony przez endpoint kontekstu.

Przykład: "PL"

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

Przykład: "example"

paginationPagination Wymagane

Metadane stronicowania z użyciem kursora.

Przykład: {"has_more":false,"limit":20,"next_cursor":null}

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

Przykład: "example"

Dodatkowe pola: Nie

errorApiError Wymagane

Ustrukturyzowane informacje o błędzie.

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

metaRequestMeta Wymagane

Metadane odpowiedzi.

Przykład: {"request_id":"example-request"}

Dodatkowe pola: Nie

codeTekstWymagane

Stały kod przeznaczony do przetwarzania przez integrację.

Ograniczenia

enum

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

fieldTekstWymagane

Pole powiązane z błędem walidacji.

minLength: 1maxLength: 128

locationTekstWymagane

Informacje o lokalizacji.

Ograniczenia

enum

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

Dodatkowe pola: Nie

amountTekstWymagane

Kwota dziesiętna zapisana jako tekst JSON; null tylko tam, gdzie jest dozwolony.

Przykład: "0.00"

currencyTekstWymagane

Kod waluty kwoty.

Ograniczenia

pattern

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

Przykład: "PLN"

minor_unitsLiczba całkowitaWymagane

Liczba cyfr części ułamkowej używanych przez walutę.

minimum: 0maximum: 4

Przykład: 2

Dodatkowe pola: Nie

deletedWartość logicznaWymagane

Czy zastosowano usunięcie.

Przykład: false

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. (MutationData).

Przykład: "example"

versionLiczba całkowita | nullWymagane

Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

Dodatkowe pola: Nie

paginationPagination Wymagane

Metadane stronicowania z użyciem kursora.

Przykład: {"has_more":false,"limit":20,"next_cursor":null}

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

Przykład: "example"

Dodatkowe pola: Nie

has_moreWartość logicznaWymagane

Czy dostępna jest kolejna strona.

Przykład: false

limitLiczba całkowitaWymagane

Maksymalna liczba rekordów na tej stronie.

minimum: 1maximum: 100

Przykład: 20

next_cursorTekst | nullWymagane

Znacznik kontynuacji dla następnej strony albo null.

Przykład: null

Dodatkowe pola: Nie

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

Przykład: "example"

Dodatkowe pola: Nie