goalsmanagement.process.update

Scope: goalsmanagement

Кто может вызывать: Администратор модуля / портала. Подробнее: Права доступа

Обновить свойства процесса (запрещено, пока процесс запущен)

HTTP: POST

Побочные эффекты: обновляет свойства ИБ

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

Параметр Тип Обяз. Описание
id int да ID сущности
name string нет Название
reportingPeriod string нет xmlId или id: 1_week, 2_week, 1_month, 3_month, 6_month
processDuration string нет xmlId или id: 3_month, 6_month, 12_month
settingGoals `int string` нет
alignmentGoals `int string` нет
settingRating `int string` нет
alignmentRating `int string` нет
finalGoals `int string` нет
timeWindowGoals int нет Writable field (code)
maxPercent int нет Writable field (code)
dateStart string нет Writable field (code)

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

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

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR Некорректные или неполные параметры
PROCESS_NOT_FOUND Процесс не найден
PROCESS_IN_USE Процесс нельзя удалить: есть связанные активные карточки
ACCESS_DENIED Нет прав на операцию (общий запрет)
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/goalsmanagement.process.update.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          --data '{
          "id": 42,
          "name": "Оценка целей 2026",
          "reportingPeriod": "3_month",
          "processDuration": "12_month",
          "timeWindowGoals": 2,
          "maxPercent": 100,
          "dateStart": "2026-09-01"
        }'
        

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

{
          "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
          }
        }
        

См. также