goalsmanagement.process.getInfo
Scope:
goalsmanagementКто может вызывать: Авторизованный пользователь с доступом к структуре/процессу. Подробнее: Права доступа
Параметры/привязка процесса для отдела
HTTP: GET
Побочные эффекты: none
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
departmentId |
int |
да | ID отдела |
Возвращаемые данные
Ответ в конверте модуля: result.result — настройки привязки отдела; result.error. Ключи total/next для не-list методов могут отсутствовать в сериализации, если не переданы.
Поля состояния процесса:
| Поле | Тип | Описание |
|---|---|---|
statusProcess |
string |
"1" — текущий запуск отдела в статусе «запущен», иначе "0". Отложенный запуск (D) даёт "0" |
started |
bool |
true — процесс привязки (relatedProcess) запущен: его карточки можно заполнять и согласовывать. Те же проверки состояния процесса, что выполняет goalsmanagement.goalcard.approve. false — goalcard.create и goalcard.approve вернут VALIDATION_ERROR; запустите процесс методом goalsmanagement.goalcard.start |
runs |
array |
Запуски процессов на отделе: runId, processId, status (1 — запущен, D — отложен, U — предстоящий, 0 — остановлен, C — отменён, E — период завершён), active (true для 1, D, U), dateStart, dateEnd (ДД.ММ.ГГГГ), periodKey |
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
VALIDATION_ERROR |
Некорректные или неполные параметры |
ACCESS_DENIED |
Нет прав на операцию (общий запрет) |
INTERNAL_ERROR |
Внутренняя ошибка сервера |
Пример запроса (GET)
curl -G "https://{портал}/rest/{user_id}/{webhook_code}/goalsmanagement.process.getInfo.json" \
-H "Accept: application/json" \
--data-urlencode "departmentId=12"
Пример ответа
{
"result": {
"result": {
"id": 12,
"name": "Отдел продаж",
"relatedProcess": 42,
"excludeEmployee": false,
"excludeHead": false,
"autoRestart": true,
"statusProcess": "1",
"startProcess": "2026-01-01",
"endProcess": "2026-12-31",
"goalsTable": "b_ithive_goals",
"ratingTable": "b_ithive_ratings",
"extendsProcess": false,
"started": true,
"runs": [
{
"runId": "run_6f1c2a9e4b7d",
"processId": 42,
"status": "1",
"active": true,
"dateStart": "01.01.2026",
"dateEnd": "31.12.2026",
"periodKey": ""
}
]
},
"error": null
}
}
См. также
Следующая