Core directories

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

Возвращает типизированные и пользовательские справочники; права на переход в модуль клиент проверяет отдельно. Каталог отдаётся целиком: параметров limit и offset у него нет, потому что это дерево навигации, а не список данных — интерфейс, листающий собственное меню, показать его не может. Потолок при этом объявлен и назван в ответе полем limit: столько справочников конструктора каталог читает за раз. Кабинет, который в него не поместился, отвечает truncated=true — усечение здесь не восстанавливается длиной ответа, потому что после чтения набор ещё раз сужают права. Смещения нет намеренно: страницы каталога были бы непредсказуемого размера — потолок применяется до фильтра прав, а фильтр после, и вторая страница могла бы прийти пустой при непустой третьей.

get/api/v1/core/directories

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/core/directories
  • 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.