Opero Docs
API OperoObiekty własne

Lista rekordów własnych

GET
/v1/custom-modules/{moduleKey}/objects/{objectKey}/records

Autoryzacja

api-token
AutoryzacjaBearer <token>

Token Opero API. Przekaż go jako Authorization: Bearer ek_...

In: header

Parametry ścieżki

moduleKey*tekst
objectKey*tekst

Parametry zapytania

contentLocale?tekst

Zwróć wartość każdego pola lokalizowalnego w tym języku treści, z powrotem do języka źródłowego obiektu tam, gdzie nie ma tłumaczenia. Musi to być jeden z języków treści organizacji. To język danych; język interfejsu pozostaje językiem wywołującego.

includeI18n?wartość logiczna

Zwróć dodatkowo surowe mapy tłumaczeń jako $i18n. Można łączyć z contentLocale.

page?liczba

Numer strony (liczony od 1)

limit?liczba

Liczba elementów na stronie

count?tekst

Strategia liczenia. exact zwraca meta.total, none pomija liczenie, a hasMore zwraca meta.hasMore, gdy endpoint to obsługuje.

filters?tekst

Drzewo filtrów zakodowane jako JSON. Przykład: {"op":"AND","items":[{"field":"status","operator":"eq","value":"ACTIVE"}]}

sort?tekst

Uporządkowana lista reguł sortowania zakodowana jako JSON. Dla pojedynczego pola opartego na słowniku można ustawić dictionaryMetadataKey na klucz metadanych zadeklarowany w tym słowniku, aby sortować według niego zamiast według zapisanego klucza wpisu.

columns?tekst

Uporządkowana lista wymaganych kolumn zakodowana jako JSON. W v1 jest to walidowany kontrakt prezentacji danych.

expand?tekst

Rozdzielone przecinkami klucze pól rozwijanych dołączane w odpowiedzi pod _expanded. Obsługuje pola REFERENCE, USER, USER_MULTI, CONTRACTOR i CONTRACTOR_MULTI. Np. "equipment_id,site_id". Nieistniejące referencje zwracają null.

Treść odpowiedzi

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/custom-modules/string/objects/string/records"
{  "data": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "values": {},      "contentLocale": "de",      "i18n": {},      "expanded": {        "property1": {          "id": "rec_123",          "displayLabel": "Acme Corp",          "moduleKey": "crm",          "objectKey": "companies",          "objectName": "Company",          "color": "#3B82F6",          "icon": "building-2"        },        "property2": {          "id": "rec_123",          "displayLabel": "Acme Corp",          "moduleKey": "crm",          "objectKey": "companies",          "objectName": "Company",          "color": "#3B82F6",          "icon": "building-2"        }      },      "files": {}    }  ],  "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": {}  }}