ipr.programtemplate.delete

Scope: ipr

Кто может вызывать: canManageCatalog() — группа «может управлять ИПР» либо admin/hr. Подробнее: Модель доступа

Удаляет шаблон программы (полное удаление элемента инфоблока). Уже созданные из этого шаблона карточки ИПР/ПИС не затрагиваются.

HTTP: POST

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

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

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

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

Поле Тип Описание
id int ID шаблона
deleted bool true

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR id не передан или некорректен
NOT_FOUND Шаблон не найден
PERMISSION_DENIED Нет прав управлять шаблонами программ
INTERNAL_ERROR Не удалось удалить шаблон

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

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

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

{
          "result": {
            "result": {
              "id": 77,
              "deleted": true
            },
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
ipr.programtemplate.update
Следующая
ipr.programtemplate.launch