ipr.action.delete

Scope: ipr

Кто может вызывать: Пользователь с canEdit на родительском ИПР либо привилегированный (admin/hr). force=true — только привилегированный. Подробнее: Модель доступа

Удаляет мероприятие.

  • По умолчанию — мягкое удаление (ACTIVE = N). Обязательное мероприятие (required = true) так удалить нельзя.
  • С force=true (только для admin/hr) — полное удаление элемента, в том числе обязательного.

HTTP: POST

Побочные эффекты: Деактивирует или необратимо удаляет элемент мероприятия.

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

Параметр Тип Обяз. Описание
id int да ID мероприятия
force bool нет Полное удаление вместо деактивации. Требует прав admin/hr

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

Поле Тип Описание
id int ID мероприятия
deleted bool true
hard bool true, если было полное удаление (force)

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR id не передан или некорректен
NOT_FOUND Мероприятие или родительский ИПР не найдены
PERMISSION_DENIED Родительский ИПР недоступен для редактирования; force=true без прав admin/hr; попытка мягко удалить обязательное мероприятие без force
INTERNAL_ERROR Не удалось удалить/деактивировать мероприятие

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

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

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

{
          "result": {
            "result": {
              "id": 12001,
              "deleted": true,
              "hard": false
            },
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
ipr.action.update
Следующая
ipr.action.type.list