ipr.action.list

Scope: ipr

Кто может вызывать: Авторизованный пользователь с доступом к родительскому ИПР. Подробнее: Модель доступа

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

HTTP: GET

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

Ограничение видимости

Если передан filter.iprId — доступ к этому ИПР проверяется явно (NOT_FOUND, если недоступен). Если filter.iprId не передан и пользователь непривилегированный — выборка ограничивается мероприятиями по всем доступным пользователю ИПР (IPR\API\Ipr::getAllAvailableIprIds). По умолчанию (без filter.active) возвращаются только активные мероприятия.

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

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

Поля filter (Mongo)

Поле API Соответствие
id ID элемента
iprId ID родительского ИПР (не свойство инфоблока — обрабатывается отдельно, поддерживает только $eq/скаляр)
iprCompetencyId (алиас competencyId) Компетенция в составе ИПР (PROPERTY_COMP)
resourceType (алиас type) Тип ресурса (PROPERTY_TYPE), значение — XML_ID из ipr.action.type.list
userId Ответственный пользователь (PROPERTY_USER)
resourceId (алиас actId) ID связанного ресурса (PROPERTY_ACT_ID)
active ACTIVE (по умолчанию Y)

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

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

Поле Тип Описание
id int ID мероприятия
title string Название
active bool ACTIVE = Y
iprCompetencyId int Компетенция в составе ИПР
resourceType string XML_ID типа ресурса
resourceId int ID связанного ресурса (курса, теста и т. п.)
userId int Ответственный пользователь
deadline string|null Плановая дата, YYYY-MM-DD
dateClosed string|null Дата закрытия
required bool Обязательное мероприятие
addedAfterStart bool Добавлено после старта карточки
dateCreate string Дата создания
timestampX string Дата последнего изменения

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
NOT_FOUND filter.iprId указывает на недоступный/несуществующий ИПР
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.action.list.json"
          -H "Accept: application/json"
          --data-urlencode "filter[iprId]=4201"

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

{
          "result": {
            "result": [
              {
                "id": 12001,
                "title": "Курс «Обратная связь 360»",
                "active": true,
                "iprCompetencyId": 9001,
                "resourceType": "course",
                "resourceId": 305,
                "userId": 15,
                "deadline": "2026-09-30",
                "dateClosed": null,
                "required": true,
                "addedAfterStart": false,
                "dateCreate": "18.06.2026 12:10:02",
                "timestampX": "18.06.2026 12:10:02"
              }
            ],
            "total": 1,
            "next": null,
            "error": null
          }
        }

См. также

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