goalsmanagement.goal.add
Scope:
goalsmanagementКто может вызывать: ModuleUser::canAddGoal(). Подробнее: Права доступа
Создать элемент каталога целей
HTTP: POST
Побочные эффекты: создаёт элемент ИБ целей
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
name |
string |
да | Название |
typeId |
int |
нет | Goal type enum ID (also type/typeGoals) |
active |
bool |
нет | Активность |
sort |
int |
нет | Sort (code) |
weightGoals |
mixed |
нет | Weight (code) |
canCascade |
`bool | string` | нет |
weightStep |
mixed |
нет | Step enum (code) |
maxPercent |
mixed |
нет | Max percent (code) |
percentStep |
mixed |
нет | Percent step (code) |
color |
string |
нет | Color (code) |
hintText |
string |
нет | Hint (code) |
hintTextPercent |
string |
нет | Percent hint (code) |
access |
array |
нет | Access list (code) |
Возвращаемые данные
Ответ в конверте модуля: result.result — созданная цель; result.error. Ключи total/next для не-list методов могут отсутствовать в сериализации, если не переданы.
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
ACCESS_DENIED |
Нет прав на операцию (общий запрет) |
INTERNAL_ERROR |
Внутренняя ошибка сервера |
Пример запроса (POST)
curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/goalsmanagement.goal.add.json" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
--data '{
"name": "Увеличить выручку отдела",
"typeId": 2,
"active": true,
"sort": 100,
"weightGoals": 40,
"canCascade": true,
"weightStep": 5,
"maxPercent": 120,
"percentStep": 5,
"color": "#2FC6F6"
}'
Пример ответа
{
"result": {
"result": {
"id": 101,
"active": true,
"name": "Увеличить выручку отдела",
"type": "strategy",
"weightGoals": 40,
"weightStep": 5,
"maxPercent": 120,
"percentStep": 5,
"sort": 100,
"canCascade": true,
"color": "#2FC6F6",
"dateCreate": "2026-01-10 09:15:00",
"timestampX": "2026-07-15 14:30:00",
"createdBy": 15,
"modifiedBy": 15,
"isUse": true
},
"error": null
}
}
См. также
Предыдущая
Следующая