ipr.competency.section.list

Scope: ipr

Кто может вызывать: Авторизованный пользователь (чтение по правам инфоблока Bitrix). Подробнее: Модель доступа

Возвращает разделы каталога компетенций с поддержкой пагинации и фильтрации.

HTTP: GET

Побочные эффекты: none

Параметры метода

Параметр Тип Обяз. Описание
limit int нет Размер страницы, по умолчанию 50, максимум 500
offset int нет Смещение
fetchAll bool нет Вернуть все записи одним ответом (максимум 5000)
filter object нет Фильтр в mongo-style формате

Поля filter (Mongo)

Поле API Соответствие
id ID раздела
title (алиас name) NAME
parentId Родительский раздел (SECTION_ID); 0 — корневые разделы
depth Уровень вложенности (DEPTH_LEVEL)
active / status ACTIVE

По умолчанию (без filter.active/filter.status) возвращаются только активные разделы.

Возвращаемые данные

Массив объектов:

Поле Тип Описание
id int ID раздела
title string Название
code string Символьный код раздела
active bool ACTIVE = Y
status string active | inactive
parentId int Родительский раздел (0 — корневой)
depth int Уровень вложенности
sort int Сортировка

Обработка ошибок

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR Некорректное значение filter.status/filter.active
INTERNAL_ERROR Внутренняя ошибка сервера
INVALID_LIMIT / LIMIT_EXCEEDED / INVALID_OFFSET / INVALID_FILTER / INVALID_FILTER_OPERATOR Некорректные параметры пагинации/фильтра
FETCH_ALL_LIMIT_EXCEEDED Превышен лимит fetchAll

Пример запроса (GET)

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/ipr.competency.section.list.json"
          -H "Accept: application/json"
          --data-urlencode "filter[parentId]=0"

Пример ответа

{
          "result": {
            "result": [
              {
                "id": 12,
                "title": "Управленческие компетенции",
                "code": "management",
                "active": true,
                "status": "active",
                "parentId": 0,
                "depth": 1,
                "sort": 100
              }
            ],
            "total": 1,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
ipr.competency.delete
Следующая
ipr.competency.status.list