goalsmanagement.goal.delete

Scope: goalsmanagement

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

Удалить цель, если она не используется в карточках

HTTP: POST

Побочные эффекты: удаляет элемент каталога

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

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

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

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

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

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

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

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/goalsmanagement.goal.delete.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          --data '{
          "id": 101
        }'

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

{
          "result": {
            "result": {
              "id": 101,
              "deleted": true
            },
            "error": null
          }
        }

См. также

Предыдущая
goalsmanagement.goal.add
Следующая
goalsmanagement.goal.get