Перейти к содержанию

Обзор

Основные характеристики

Характеристика Значение
Наименование content_folders
Компоненты Cruddy
Появился в версии 4.0.0
Доступен в версиях 4.0.0 и выше
Авторизация по токену Security scheme type: http
Bearer format: JWT
Авторизация по APIkey Security scheme type: apiKey
Header parameter name: PgrApiKey
Версия API v2

Описание: Ресурс content_folders отвечает за управление папками контента. Под контентом понимаются сущности, созданные пользователями в платформе.

Примечание: На момент версии 4.2.2 веб-интерфейс поддерживает работу папок со следующим типом контента: Правила корреляции (logmule_go_rules).

Список методов для работы с ресурсом

Тип Метод Описание
POST /content_folders/create Создание папки контента
POST /content_folders/update Редактирование папки контента
POST /content_folders/search Поиск папок контента
GET /content_folders/{folder_id} Получение папки контента по ID
DELETE /content_folders/{folder_id} Удаление папки контента
POST /content_folders/mass_update Массовое изменение папок контента
POST /content_folders/mass_delete Массовое удаление папок контента

Ответы методов

Статус код Описание
200 Успех
201 Успешное создание объекта
204 Успешный ответ. Пустое тело ответа
400 Неверный тип параметра запроса, либо отсутствует обязательный параметр
404 Ресурс не найден
409 Попытка присвоить объекту существующее уникальное значение атрибута
422 Внутренняя ошибка удаления
500 Ошибка сервера

Модели объектов

Название Описание
ContentFolders Модель данных ресурса content_folders