Дополнительные поля. Обзор

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

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

Описание: Ресурс custom_fields отвечает за управление дополнительными полями, которые можно добавлять к инцидентам информационной безопасности

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

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

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

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

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

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