Datenschemas: Gemeinsame Modelle

codeZeichenfolgeErforderlich

Stabiler maschinenlesbarer Code.

Einschränkungen

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

Beispiel: "authentication.invalid_credentials"

fieldsArray <FieldError > | nullOptional

Validierungsfehler einzelner Felder.

Beispiel: null

messageZeichenfolgeErforderlich

Für Menschen lesbare Erklärung; Programmlogik muss den Fehlercode verwenden.

Beispiel: "The credentials are invalid."

Zusätzliche Felder: Nein

dataMutationData Erforderlich

Beispielantwort · MutationData.

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

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Erforderlich

Metadaten der Antwort.

Beispiel: {"request_id":"example"}

Zusätzliche Felder: Nein

localeZeichenfolgeErforderlich

Für diese Anfrage ausgewählte Sprache.

Beispiel: "en"

market_codeZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebener Marktcode.

Beispiel: "PL"

market_idZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebene Marktkennung.

Beispiel: "example"

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

Beispiel: "example"

Zusätzliche Felder: Nein

localeZeichenfolgeErforderlich

Für diese Anfrage ausgewählte Sprache.

Beispiel: "en"

market_codeZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebener Marktcode.

Beispiel: "PL"

market_idZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebene Marktkennung.

Beispiel: "example"

paginationPagination Erforderlich

Metadaten der Cursor-Paginierung.

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

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

Beispiel: "example"

Zusätzliche Felder: Nein

errorApiError Erforderlich

Strukturierte Fehlerinformationen.

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

metaRequestMeta Erforderlich

Metadaten der Antwort.

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

Zusätzliche Felder: Nein

codeZeichenfolgeErforderlich

Stabiler maschinenlesbarer Code.

Einschränkungen

enum

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

fieldZeichenfolgeErforderlich

Feld, auf das sich ein Validierungsfehler bezieht.

minLength: 1maxLength: 128

locationZeichenfolgeErforderlich

Standortinformationen.

Einschränkungen

enum

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

Zusätzliche Felder: Nein

amountZeichenfolgeErforderlich

Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

Beispiel: "0.00"

currencyZeichenfolgeErforderlich

Währungscode des Betrags.

Einschränkungen

pattern

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

Beispiel: "PLN"

minor_unitsGanzzahlErforderlich

Anzahl der Nachkommastellen der Währung.

minimum: 0maximum: 4

Beispiel: 2

Zusätzliche Felder: Nein

deletedBoolescher WertErforderlich

Gibt an, ob die Löschung durchgeführt wurde.

Beispiel: false

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. (MutationData).

Beispiel: "example"

versionGanzzahl | nullErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein

paginationPagination Erforderlich

Metadaten der Cursor-Paginierung.

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

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

Beispiel: "example"

Zusätzliche Felder: Nein

has_moreBoolescher WertErforderlich

Gibt an, ob eine weitere Seite verfügbar ist.

Beispiel: false

limitGanzzahlErforderlich

Maximale Anzahl von Datensätzen auf dieser Seite.

minimum: 1maximum: 100

Beispiel: 20

next_cursorZeichenfolge | nullErforderlich

Fortsetzungswert für die nächste Seite oder null.

Beispiel: null

Zusätzliche Felder: Nein

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

Beispiel: "example"

Zusätzliche Felder: Nein