ipr.programtemplate.list

Scope: ipr

Кто может вызывать: Любой авторизованный пользователь REST. Подробнее: Модель доступа

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

HTTP: GET

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

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

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

Поля filter (Mongo)

Поле API Соответствие
id ID элемента
title NAME
active ACTIVE (по умолчанию Y)
type Тип шаблона (PROPERTY_PROGRAM_TYPE). Принимает XML_ID (PROGRAM_IPR/PROGRAM_PIS) и легаси-алиасы: competency, function, position → PROGRAM_IPR; individual → PROGRAM_PIS; также ipr/pis без учёта регистра
autoStart Признак автозапуска (PROPERTY_AUTO_START)

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

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

Поле Тип Описание
id int ID шаблона
title string Название
active bool ACTIVE = Y
type string XML_ID типа: PROGRAM_IPR | PROGRAM_PIS
autoStart bool Автоматический запуск включён
delayedAutoStart bool Отложенный автозапуск включён
sendBossAgreement bool Требовать согласование руководителем при запуске
targetPositionId int|null Целевая должность
deadline string|null Срок (в месяцах, как задано в шаблоне)
targetFunction string|null Целевая функция
nextTemplateId int|null Шаблон следующей программы
dateCreate string Дата создания
timestampX string Дата последнего изменения

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR Некорректное значение filter.type
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.programtemplate.list.json"
          -H "Accept: application/json"
          --data-urlencode "filter[type][\$eq]=PROGRAM_IPR"

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

{
          "result": {
            "result": [
              {
                "id": 77,
                "title": "Развитие руководителя отдела",
                "active": true,
                "type": "PROGRAM_IPR",
                "autoStart": false,
                "delayedAutoStart": false,
                "sendBossAgreement": true,
                "targetPositionId": null,
                "deadline": "12",
                "targetFunction": null,
                "nextTemplateId": null,
                "dateCreate": "01.02.2026 10:00:00",
                "timestampX": "01.02.2026 10:00:00"
              }
            ],
            "total": 1,
            "next": null,
            "error": null
          }
        }

См. также

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