goalsmanagement.process.add
Scope:
goalsmanagementКто может вызывать: Администратор модуля / портала (canAddProcess / admin). Подробнее: Права доступа
Создать процесс (IB_ITHIVE_PROCESS)
HTTP: POST
Побочные эффекты: создаёт элемент ИБ процесса
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
name |
string |
да | Название |
reportingPeriod |
string |
нет | xmlId или id enum отчётного периода: 1_week, 2_week, 1_month, 3_month, 6_month (см. process.period.list) |
processDuration |
string |
нет | xmlId или id длительности процесса: 3_month, 6_month, 12_month |
dateStart |
string |
нет | Start date |
settingGoals |
`int | string` | нет |
alignmentGoals |
`int | string` | нет |
settingRating |
`int | string` | нет |
alignmentRating |
`int | string` | нет |
finalGoals |
`int | string` | нет |
timeWindowGoals |
int |
нет | Time window days (code accepts) |
maxPercent |
int |
нет | Max percent (code accepts, default 100) |
Возвращаемые данные
Ответ в конверте модуля: result.result — созданный процесс; result.error. Ключи total/next для не-list методов могут отсутствовать в сериализации, если не переданы.
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
ACCESS_DENIED |
Нет прав на операцию (общий запрет) |
VALIDATION_ERROR |
Пустые или некорректные поля: нет name/reportingPeriod, невалидный enum, сумма дней настроек больше отчётного периода |
INTERNAL_ERROR |
Внутренняя ошибка сервера |
Пример запроса (POST)
curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/goalsmanagement.process.add.json" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
--data '{
"name": "Оценка целей 2026",
"reportingPeriod": "3_month",
"processDuration": "12_month",
"dateStart": "2026-09-01",
"settingGoals": 14,
"alignmentGoals": 7,
"settingRating": 3,
"alignmentRating": 5,
"finalGoals": 10,
"timeWindowGoals": 2,
"maxPercent": 100
}'
Пример ответа
{
"result": {
"result": {
"id": 42,
"sectionId": 12,
"name": "Оценка целей 2026",
"active": "Y",
"processDuration": "12_month",
"settingGoals": 14,
"alignmentGoals": 7,
"settingRating": 3,
"alignmentRating": 5,
"reportingPeriod": "3_month",
"finalGoals": 10,
"maxPercent": 100,
"dateStart": "2026-09-01",
"timeWindowGoals": 2,
"isRun": false
},
"error": null
}
}
См. также
Предыдущая
Следующая