Получение списка активных действий доступных в интеграции

Запрос

Тип	Метод
POST	/integration_actions/search

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

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

POST

Development server
https://development.gigantic-server.com/v1/integration_actions/search

Staging server
https://staging.gigantic-server.com/v1/integration_actions/search

Тело запроса:

Параметр	Тип данных	Обязательность	Описание
include_fields	Array<string>	Required	Список полей для выборки. Если модель содержит поля, не указанные в запросе, они будут отсутствовать в ответе
exclude_fields	Array<string>	Required	Список полей для удаления из выборки. Если модель содержит поля, указанные в запросе, они будут отсутствовать в ответе
filters	Array<filters>	Required	Список фильтров по полям модели
ordering	Array<ordering>	Required	Настройки сортировки
virtual_search	object<virtual_search>	Required	Поле для поиска по подстроке по всем строковым полям модели и настройка строгого поиска
relations	Array<string>	Required	Список связей для выборки. Список доступных связей отображается в ответе запроса на получение метаданных - “/_meta”
limit	integer	Required	Лимит выдачи найденных объектов
offset	integer	Required	Отступ от начала результата поиска в базе
_relations	Array<string>	Optional	Перечисление связанных сущностей идентификаторы которых нужно вернуть в ответе в поле _relations

Array of filters

Параметр	Тип данных	Обязательность	Описание
field	string	Required	Название поля модели
value	object	Required	Значение для фильтрации
filter_type	string	Required	В зависимости от этого значения определяется допустимые значения в поле value. Допустимые значения: - equal -> строка|число, проверяет равенство значений - substr -> строка, проверяет вхождение подстроки - intersection -> массив (тип элемента зависит от типа поля), проверяет вхождение значения поля в переданный массив - range -> массив (тип элемента зависит от типа поля), проверяет вхождение значения поля в переданный диапазон - related -> строка или массив строк (uuid), проверят связанность с моделью по идентификатору если value: [], проверяет наличие или отсутствие связанных сущностей - exists -> значение отсутствует, проверяется равенство колонки с null
negation	boolean	Optional	Флаг использования отрицания при проверке фильтра

Array of ordering

Параметр	Тип	Обязательность	Описание / Допустимые значения
field	string	Required	Поле модели выбранное для сортировки
direction	string	Required	Направление сортировки. Допустимые значения: - asc - desc

Object VirtualSearch

Параметр	Тип	Обязательность	Описание / Допустимые значения
value	string	Required	Значение выбранное для поиска
strict	boolean	Required	Опция, включающая строгий поиск. Возможные значения: - true - строгий поиск включена; - false - строгий поиск выключен.

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

{
  "include_fields": [
    "string"
  ],
  "exclude_fields": [
    "string"
  ],
  "filters": [
    {
      "field": "string",
      "value": [
        "name",
        [
          "value1",
          "value2"
        ]
      ],
      "filter_type": "equal",
      "negation": false
    }
  ],
  "ordering": [
    {
      "field": "string",
      "direction": "asc"
    }
  ],
  "virtual_search": {
    "value": "string",
    "strict": false
  },
  "relations": [
    "service_asset_findings",
    "logmule_go_rules",
    "user"
  ],
  "limit": 20,
  "offset": 0,
  "_relations": [
    "string"
  ]
}

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

Статус код: 200 – успешный ответ.

Формат: JSON.

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

Параметр	Тип данных	Описание
items	Array <IntegrationAction>	Список найденных активных действий для типа интеграции
total	integer	Количество найденных журналов

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

{
  "items": [
    {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "integration_id": "55d7337e-1d0a-49fc-9826-925ba40df035",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "state": true,
    "integration_type_id": "28581c11-33bb-4494-a053-3fc7348a93df",
    "name": "Заблокировать процесс по его ID",
    "script_lin": "block_windows_process_by_pid.sh",
    "script_win": "block_windows_process_by_pid.bat",
    "params": [
        {
        "parameter_name": "pid",
        "parameter_value": "{event.execution.process.id}",
        "from_event": true
    }
  ],
  "total": 1
}

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

Код	Ответ	Описание
400	Bad Request	Неверный тип параметра запроса, либо отсутствует обязательный параметр
500	Internal Server Error	Другие ошибки при удалении объектов

Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.

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

   
Код 400
   

{
  "error": "Bad Request",
  "error_code": 400
}



   
Код 500
   

{
  "error": "Internal Server Error",
  "error_code": 500
}