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

Получение значений белых списков для правила

Запрос

Тип Метод
POST /logmule_go_rules/{id}/whitelists_values

Описание: метод возвращает значения всех табличных белых списков, относящихся к указанному правилу корреляции.

В выборку включаются белые списки:

  • автоматически определённые по пересечению маппингов;
  • явно связанные с правилом через white_lists с negation: false.

Если для явной связи задан field_mapping, сопоставление полей выполняется по нему. Для такой пары field_mapping имеет приоритет над whitelists_mappings.

Метод поддерживает поиск, фильтрацию, сортировку и пагинацию с помощью GenericSearchRequest.

Поиск, фильтрация и сортировка применяются к следующим полям:

  • whitelist_id;
  • whitelist_name;
  • record_id;
  • exception_id;
  • динамическим полям таксономии правила.

Если белый список пересекается с правилом только частично, отсутствующие значения полей таксономии возвращаются со значением null.

Пример запроса

POST

http://127.0.0.1/cruddy/v2/logmule_go_rules/54407148-5d2a-40ca-a360-f71cdecc2773/whitelists_values

Параметры пути

Параметр Тип данных Обязательность Описание
id string uuid Required ID правила корреляции

Тело запроса

Тело запроса соответствует структуре GenericSearchRequest.

Все параметры объекта являются опциональными. Допускается передача пустого объекта {}.

Пример тела запроса

{}

Успешный ответ

Статус код: 200 – запрос успешно обработан.

Формат: JSON.

Параметры ответа:

Параметр Тип данных Описание
total integer Общее количество найденных записей
items Array<object> Список значений белых списков
items[].whitelist_id string uuid ID белого списка
items[].whitelist_name string Название белого списка
items[].record_id string ID записи в белом списке
items[].exception_id string uuid или null ID записи-исключения для данной записи и правила. Если исключения нет, возвращается null
items[].<поле таксономии> — Динамическое поле таксономии правила. Значение может быть null

В каждом элементе массива items всегда присутствуют поля:

  • whitelist_id;
  • whitelist_name;
  • record_id;
  • exception_id.

Остальные поля формируются динамически в соответствии с таксономией правила.

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

{
  "total": 1,
  "items": [
    {
      "whitelist_id": "7bc42fd2-057c-4117-b367-8528bec75c80",
      "whitelist_name": "WL Users",
      "record_id": "vadim",
      "exception_id": null,
      "<поле_таксономии>": "<значение>"
    }
  ]
}

Другие возможные ответы

Код Описание
400 Некорректные параметры запроса
401 Ошибка аутентификации
404 Правило не найдено
500 Ошибка сервера