Обзор
Основные характеристики
| Характеристика | Значение |
|---|---|
| Наименование | mappings |
| Компоненты | Cruddy |
| Появился в версии | 3.7.4 |
| Доступен в версиях | 3.7.4 и выше |
| Авторизация по токену | Security scheme type: httpBearer format: JWT |
| Авторизация по APIkey | Security scheme type: apiKeyHeader parameter name: PgrApiKey |
| Параметры заголовка | Pgr-User-ID: ID пользователя (uuid) |
| Версия API | v2 |
Описание: Ресурс mappings отвечает за управление маппингами. Платформа Радар позволяет управлять полями события (таксономии), используемых в процессах разбора и нормализации.
Маппинг – это карта полей нормализованного или распаршенного события.
Список методов для работы с ресурсом
| Тип | Метод | Описание |
|---|---|---|
POST |
/mappings/create | Создание маппинга |
PUT |
/mappings/update | Обновление информации о маппинге |
POST |
/mappings/search | Поиск маппингов |
GET |
/mappings/{id} | Получение маппинга по ID |
DELETE |
/mappings/{id} | Удаление маппинга |
POST |
/mappings/mass_delete | Массовое удаление маппингов |
DELETE |
/mappings/all | Удаление всех маппингов |
GET |
/mappings/usages/{id} | Получение списка связанных объектов, в которых используется поле маппинга |
GET |
/mappings/dependencies/{id} | Получение родительских и/или дочерних полей по ID поля |
GET |
/mappings/list | Получение списка всех маппингов в формате key/value |
GET |
/mappings/nested | Получение списка всех маппингов в формате вложенной структуры |
Ответы методов
| Статус код | Описание |
|---|---|
200 |
Успех |
201 |
Успешное создание объекта |
204 |
Успешный ответ. Пустое тело ответа |
400 |
Неверный тип параметра запроса, либо отсутствует обязательный параметр |
404 |
Ресурс не найден |
422 |
Внутренняя ошибка удаления/изменения |
500 |
Ошибка сервера |
Модели объектов
| Название | Описание |
|---|---|
| Mapping | Модель данных ресурса mappings |