ipr.ipr.list

Scope: ipr

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

Возвращает список карточек ИПР/ПИС с поддержкой пагинации и фильтрации.

HTTP: GET

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

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

Непривилегированный пользователь (не admin/hr) видит только карточки, входящие в IPR\API\Ipr::getAllAvailableIprIds() — свои и/или карточки сотрудников, которыми он управляет. Привилегированные (admin/hr) видят все карточки без ограничения. По умолчанию (без filter.active) в выборку попадают только активные карточки (ACTIVE = Y).

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

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

Поля filter (Mongo)

Поле API Соответствие
id ID элемента
userId Сотрудник (PROPERTY_SOTRUDNIK)
managerId Руководитель (PROPERTY_CUR_MANAGER)
status Статус (PROPERTY_STATUS), значение — XML_ID: NEW, SOGL, WORK, SOGL_RES, FINISHED
deadline Плановая дата завершения (PROPERTY_FINISH_DATE)
active ACTIVE (по умолчанию Y)
name Название карточки
type Тип (PROPERTY_TYPE), значение — XML_ID: IPR, PIS
templateId Шаблон, из которого создана карточка (PROPERTY_IPR_PROGRAM_TEMPLATES)

Пример: filter[status][$eq]=WORK, filter[userId][$in][]=8&filter[userId][$in][]=14.

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

Массив объектов той же формы, что и в ipr.ipr.get, но в укороченном виде (без списка компетенций):

Поле Тип Описание
id int ID карточки
title string Название
active bool ACTIVE = Y
userId int Сотрудник
managerId int Руководитель
status string XML_ID статуса
deadline string|null Плановая дата завершения, YYYY-MM-DD
dateCreate string Дата создания (портальный формат)
timestampX string Дата последнего изменения (портальный формат)

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка сервера (в т. ч. модуль iblock недоступен)
INVALID_LIMIT / LIMIT_EXCEEDED Некорректное значение limit
INVALID_OFFSET Некорректное значение offset
INVALID_FILTER / INVALID_FILTER_OPERATOR Некорректный фильтр
FETCH_ALL_LIMIT_EXCEEDED Превышен лимит fetchAll

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/ipr.ipr.list.json"
          -H "Accept: application/json"
          --data-urlencode "limit=20"
          --data-urlencode "filter[status][\$eq]=WORK"

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

{
          "result": {
            "result": [
              {
                "id": 4201,
                "title": "ИПР: Наумова Алиса",
                "active": true,
                "userId": 15,
                "managerId": 1,
                "status": "WORK",
                "deadline": "2026-12-30",
                "dateCreate": "18.06.2026 12:07:44",
                "timestampX": "18.06.2026 12:07:44"
              }
            ],
            "total": 1,
            "next": null,
            "error": null
          }
        }

См. также

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