Lista słowników
Autoryzacja
api-token Token Opero API. Przekaż go jako Authorization: Bearer ek_...
In: header
Parametry zapytania
Numer strony (liczony od 1)
Liczba elementów na stronie. Maksymalnie 100.
Strategia liczenia. exact zachowuje obecne dokładne liczenie wyników, none pomija liczenie, a hasMore pozwala zwrócić informację, czy istnieje kolejna strona, gdy endpoint to obsługuje.
Drzewo filtrów zakodowane jako JSON. Przykład: {"op":"AND","items":[{"field":"status","operator":"eq","value":"ACTIVE"}]}
Uporządkowana lista reguł sortowania zakodowana jako JSON. Dla pojedynczego pola opartego na słowniku można ustawić dictionaryMetadataKey na klucz metadanych udostępniany przez to pole, aby sortować według niego zamiast według zapisanego klucza wpisu.
Uporządkowana lista wymaganych kolumn zakodowana jako JSON. W v1 jest to walidowany kontrakt prezentacji danych.
Treść odpowiedzi
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/dictionaries"{ "data": [ { "id": "string", "key": "string", "name": "string", "description": "string", "scope": "SYSTEM", "entryKeyMode": "CUSTOM", "entryMetadataSchema": [ { "key": "customName", "type": "STRING", "required": false, "options": [ { "value": "a", "label": "Polish statute" } ] } ], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "meta": { "page": 1, "limit": 20, "total": 100, "hasMore": true }}{ "error": { "code": "NOT_FOUND", "message": "Resource not found", "meta": { "partiallyApplied": true, "failedPhase": "defaultForms", "committedObjects": [ { "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3", "key": "session", "created": true } ], "fieldsWritten": 1, "fieldsDeleted": 0 }, "fieldErrors": { "name": [ "Field \"name\" is required" ] }, "unavailableMutationScopes": [ "contractor.bankAccounts" ], "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50", "relationTableErrors": {}, "idempotencyConflict": {}, "errors": [ { "message": "relation \"foo\" does not exist" } ], "impacts": [ {} ], "validation": {} }}{ "error": { "code": "NOT_FOUND", "message": "Resource not found", "meta": { "partiallyApplied": true, "failedPhase": "defaultForms", "committedObjects": [ { "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3", "key": "session", "created": true } ], "fieldsWritten": 1, "fieldsDeleted": 0 }, "fieldErrors": { "name": [ "Field \"name\" is required" ] }, "unavailableMutationScopes": [ "contractor.bankAccounts" ], "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50", "relationTableErrors": {}, "idempotencyConflict": {}, "errors": [ { "message": "relation \"foo\" does not exist" } ], "impacts": [ {} ], "validation": {} }}{ "error": { "code": "NOT_FOUND", "message": "Resource not found", "meta": { "partiallyApplied": true, "failedPhase": "defaultForms", "committedObjects": [ { "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3", "key": "session", "created": true } ], "fieldsWritten": 1, "fieldsDeleted": 0 }, "fieldErrors": { "name": [ "Field \"name\" is required" ] }, "unavailableMutationScopes": [ "contractor.bankAccounts" ], "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50", "relationTableErrors": {}, "idempotencyConflict": {}, "errors": [ { "message": "relation \"foo\" does not exist" } ], "impacts": [ {} ], "validation": {} }}{ "error": { "code": "NOT_FOUND", "message": "Resource not found", "meta": { "partiallyApplied": true, "failedPhase": "defaultForms", "committedObjects": [ { "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3", "key": "session", "created": true } ], "fieldsWritten": 1, "fieldsDeleted": 0 }, "fieldErrors": { "name": [ "Field \"name\" is required" ] }, "unavailableMutationScopes": [ "contractor.bankAccounts" ], "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50", "relationTableErrors": {}, "idempotencyConflict": {}, "errors": [ { "message": "relation \"foo\" does not exist" } ], "impacts": [ {} ], "validation": {} }}