goalsmanagement.goalcard.stop

Scope: goalsmanagement

Кто может вызывать: Администратор портала или администратор модуля — как кнопка «Остановить» в разделе «Контроль процессов». С версии 16.0.1 руководителю отдела метод недоступен. Подробнее: Права доступа

Остановить процесс подразделения: деактивировать его карточки целей и связанные карточки оценки, перевести запуск в статус «остановлен». Парный метод — goalsmanagement.goalcard.start.

HTTP: POST

Побочные эффекты: останавливает карточки отдела

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

Параметр Тип Обяз. Описание
departmentId int да ID отдела
processId int нет Включены параллельные процессы: какой процесс остановить. 0 или не передан — процесс из привязки отдела
runId string нет Включены параллельные процессы: конкретный запуск. Если по processId активно несколько запусков и runId не передан, возвращается VALIDATION_ERROR

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

Ответ в конверте модуля: result.result — {departmentId, processId, runId, stopped}; result.error. Ключи total/next для не-list методов могут отсутствовать в сериализации, если не переданы.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Вызывающий не администратор портала и не администратор модуля
VALIDATION_ERROR Несколько активных запусков процесса — передайте runId
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/goalsmanagement.goalcard.stop.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          --data '{
          "departmentId": 12
        }'

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

{
          "result": {
            "result": {
              "departmentId": 12,
              "processId": 42,
              "runId": "run_6f1c2a9e4b7d",
              "stopped": true
            },
            "error": null
          }
        }

См. также

Предыдущая
goalsmanagement.goalcard.status.list
Следующая
Обзор раздела