ipr.competency.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
sectionId Раздел каталога (SECTION_ID)
active ACTIVE. Также принимает status/значения active/inactive/Y/N
status То же, что active, в терминах виртуального статуса: active → Y, inactive → N

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

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

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

Поле Тип Описание
id int ID компетенции
title string Название
description string Описание (PREVIEW_TEXT)
active bool ACTIVE = Y
status string active | inactive
sectionId int Раздел каталога
sort int Сортировка
level int|null Уровень компетенции
iconCode string Код иконки
iconColor int|null ID цвета иконки (enum)
dateCreate string Дата создания
timestampX string Дата последнего изменения

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

Справочник кодов: 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.list.json"
          -H "Accept: application/json"
          --data-urlencode "filter[sectionId]=12"

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

{
          "result": {
            "result": [
              {
                "id": 1049,
                "title": "Работа с обратной связью",
                "description": "",
                "active": true,
                "status": "active",
                "sectionId": 12,
                "sort": 500,
                "level": 2,
                "iconCode": "feedback",
                "iconColor": 3,
                "dateCreate": "01.02.2026 10:00:00",
                "timestampX": "01.02.2026 10:00:00"
              }
            ],
            "total": 1,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
Обзор раздела
Следующая
ipr.competency.get