Core reference

Получить каталог справочников, доступных в кабинете

Тот же состав, что и витрина раздела: правило доступа общее, второго не бывает. Справочник попадает в ответ, если модуль-владелец включён у кабинета и у роли есть право на чтение этого модуля. Каждая строка несёт полное имя (reference) и дескриптор (contract): пространство имён, форму записи с версией, источник правды, изменяемость, этап жизни и совместимость. Справочник удалённого приложения остаётся в каталоге только по исходу orphan, с этапом retired. Листания у каталога нет — он отдаётся целиком; потолок назван полем limit, а кабинет, не поместившийся в него, отвечает truncated=true. Обнаружение справочников поэтому один запрос, а не цикл по страницам.

get/api/v1/reference/catalog

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/reference/catalog
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key
    • OAuth 2 (authorization code, authorization URL https://erp.akeda.ru/oauth2/authorize, token URL https://erp.akeda.ru/oauth2/token, scopes: akeda:delegate)

Headers

X-Tenantstring required

Slug выбранного кабинета; кабинет не является юрлицом

Response

Доступные справочники

countinteger required
limitinteger required

Потолок каталога — сколько справочников конструктора он читает за раз. Параметра запроса у него нет: каталог отдаётся целиком, и число названо здесь, чтобы предел был виден, а не подразумевался

truncatedboolean required

Справочников в кабинете больше потолка, и часть в каталог не попала. Считается по кабинету точно, а не по длине ответа: после чтения набор ещё раз сужают права, и короткий ответ ничего об усечении не говорит. true означает ошибку моделирования на стороне кабинета, а не нормальный режим

Changes

No recorded changes to this operation across all 1 revision of this API.