ipr.programtemplate.add
Scope:
iprКто может вызывать:
canManageCatalog()— группа «может управлять ИПР» либоadmin/hr. Подробнее: Модель доступа
Создаёт шаблон программы.
HTTP: POST
Побочные эффекты: Создаёт элемент инфоблока шаблонов программ.
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
title (алиас name) |
string |
да | Название, 1..255 символов |
type (алиас programType) |
string |
нет | PROGRAM_IPR | PROGRAM_PIS (и легаси-алиасы, см. ipr.programtemplate.list). По умолчанию PROGRAM_IPR |
active |
bool |
нет | По умолчанию true |
autoStart |
bool |
нет | Включить автозапуск. По умолчанию false |
delayedAutoStart |
bool |
нет | Включить отложенный автозапуск |
sendBossAgreement |
bool |
нет | Требовать согласование руководителем при запуске |
targetPositionId |
int |
нет | Целевая должность |
deadline |
string |
нет | Срок (число месяцев, как значение свойства шаблона) |
targetFunction |
string |
нет | Целевая функция |
nextTemplateId (алиас nextProgram) |
int |
нет | Шаблон следующей программы |
competenceIds |
int[] |
нет | Компетенции каталога, зашиваемые в шаблон |
observers |
int[] |
нет | Наблюдатели, зашиваемые в шаблон |
competenceDeadlines |
object |
нет | Индивидуальные дедлайны по компетенциям, { "<competenceId>": "..." } |
autoStartDepartments |
string[] |
нет | Подразделения для автозапуска |
Возвращаемые данные
Полный шаблон — та же форма, что у ipr.programtemplate.get.
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
VALIDATION_ERROR |
title не передан/длиннее 255 символов, некорректный type |
PERMISSION_DENIED |
Нет прав управлять шаблонами программ |
INTERNAL_ERROR |
Не удалось создать шаблон / каталог не настроен |
Пример запроса (POST)
curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/ipr.programtemplate.add.json"
-H "Content-Type: application/json"
-H "Accept: application/json"
--data '{
"title": "Развитие руководителя отдела",
"type": "PROGRAM_IPR",
"competenceIds": [1049, 1051],
"sendBossAgreement": true
}'
Пример ответа
{
"result": {
"result": {
"id": 77,
"title": "Развитие руководителя отдела",
"type": "PROGRAM_IPR",
"competenceIds": [1049, 1051]
},
"total": null,
"next": null,
"error": null
}
}
См. также
Предыдущая
Следующая