goalsmanagement.goal.get

Scope: goalsmanagement

Кто может вызывать: ModuleUser::canViewGoal(). Подробнее: Права доступа

Цель каталога по id (включая isUse)

HTTP: GET

Побочные эффекты: none

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

Параметр Тип Обяз. Описание
id int да ID сущности

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

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

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

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

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

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/goalsmanagement.goal.get.json" \
          -H "Accept: application/json" \
          --data-urlencode "id=101"

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

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

См. также

Предыдущая
goalsmanagement.goal.delete
Следующая
goalsmanagement.goal.list