ipr.programtemplate.launch

Scope: ipr

Кто может вызывать: canManageCatalog() и canManageEmployee(actor, userId) для целевого сотрудника. Подробнее: Модель доступа

Запускает шаблон программы на одного сотрудника — создаёт новую карточку ИПР/ПИС на основе параметров шаблона (аналог кнопки «Запустить» на шаблоне в интерфейсе). Параметры запроса переопределяют соответствующие значения шаблона.

HTTP: POST

Побочные эффекты: Создаёт карточку ИПР/ПИС (элемент инфоблока ИПР) и связанные компетенции.

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

Параметр Тип Обяз. Описание
templateId (алиас id) int да ID шаблона программы
userId int да Сотрудник, для которого запускается программа
positionId int нет Текущая должность сотрудника. По умолчанию — должность из профиля сотрудника
managerId int нет Руководитель. По умолчанию берётся из шаблона/оргструктуры
title string нет Название карточки. По умолчанию — название шаблона
deadline (алиас term) int нет Срок в месяцах. По умолчанию — значение из шаблона (или 12)
dateClose string нет Явная дата завершения (портальный формат); по умолчанию вычисляется из deadline
targetPositionId int нет Целевая должность. По умолчанию — значение из шаблона
targetFunction string нет Целевая функция. По умолчанию — значение из шаблона
nextTemplateId int нет Шаблон следующей программы. По умолчанию — значение из шаблона
competenceIds int[] нет Компетенции карточки. По умолчанию — компетенции, зашитые в шаблон
observers int[] нет Наблюдатели карточки. По умолчанию — из шаблона
competenceDeadlines object нет Индивидуальные дедлайны по компетенциям. По умолчанию — из шаблона либо общий dateClose
sendBossAgreement bool нет Требовать согласование руководителем. По умолчанию — из шаблона
competenceRunOptions object нет Доп. опции запуска компетенций
competenceGoals object нет Цели по компетенциям

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

Поле Тип Описание
templateId int ID использованного шаблона
userId int ID сотрудника
iprId int ID созданной карточки ИПР/ПИС

Для получения полной карточки используйте ipr.ipr.get с полученным iprId.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR Не передан templateId/userId
NOT_FOUND Шаблон не найден
PERMISSION_DENIED Нет прав управлять шаблонами либо нет прав на указанного userId
IPR_ALREADY_EXISTS У сотрудника уже достигнут лимит активных программ
INTERNAL_ERROR Не удалось создать карточку из шаблона

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/ipr.programtemplate.launch.json"
          -H "Content-Type: application/json"
          -H "Accept: application/json"
          --data '{
          "templateId": 77,
          "userId": 15,
          "managerId": 1
        }'

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

{
          "result": {
            "result": {
              "templateId": 77,
              "userId": 15,
              "iprId": 4201
            },
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
ipr.programtemplate.delete
Следующая
ipr.programtemplate.masslaunch