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

Обзор

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

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

Описание: Ресурс rules отвечает за управление информацией о правилах соответствия ПО.

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

Тип Метод Описание
POST /rules/create Создание правила соответствия ПО
PUT /rules/update Обновление информации о правиле соответствия ПО
POST /rules/search Поиск правила соответствия ПО
GET /rules/{id} Получение правила соответствия ПО по ID
DELETE /rules/{id} Удаление правила соответствия ПО
POST /rules/group Группировка правил соответствия ПО
POST /rules/mass_delete Массовое удаление правил соответствия ПО
DELETE /rules/all Удаление всех правил соответствия ПО
GET /rules/_meta Получение свойств полей правил соответствия ПО и действий пользователей
POST /rules/mass_update Массовое изменение правил соответствия ПО

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

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

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

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