Модель

IntegrationType

Тип интеграции (тип интеграционного подключения):

Параметр	Тип	Обязательность	Описание
id	string	Required	Идентификатор типа интеграции в формате uuid
name	string	Required	Наименование типа интеграции. Обычно наименование сторонней системы, с которой выполняется взаимодействие
state	boolean	Required	Состояние типа интеграции. Возможные значения: - true - тип интеграции активирован в платформе; - false - тип интеграции неактивен.
## ParameterMeta

Параметры типа интеграции:

Параметр	Тип	Обязательность	Описание
id	string	Required	Идентификатор параметра в формате uuid
integration_type_id	string	Required	Идентификатор типа интеграции в формате uuid
parameter_order	integer	Required	Порядок параметра в веб-интерфейсе платформы
parameter_name	string	Required	Название параметра с учётом вложенности по структуре конфигурации
value_type	string	Required	Тип переменной. Допустимые значения: - boolean - integer - string - number - array
required_field	boolean	Required	Является ли параметр обязательным к заполнению
value_params	object	Required	Объект, содержащий информацию о значении параметра
value_params{title}	string	Required	Наименование параметра в веб-интерфейсе платформы
value_params{description}	string	Optional	Описание параметра в веб-интерфейсе платформы
value_params{min_value}	integer	Optional	Минимальное значение (используется для параметров с типом int)
value_params{max_value}	integer	Optional	Максимальное значение (используется для параметров с типом int)
value_params{example}	string	Optional	Пример

Integration

Экземпляр интеграции:

Параметр	Тип	Обязательность	Описание
id	string	Required	Идентификатор экземпляра интеграции в формате uuid
created_at	string	Required	Дата создания в формате date-time
updated_at	string	Required	Дата изменения в формате date-time
integration_type_id	string	Required	Идентификатор типа интеграции
integration_name	string	Required	Наименование экземпляра интеграции
state	boolean	Required	Состояние экземпляра интеграции. Возможные значения: - true - тип интеграции активирован в платформе; - false - тип интеграции неактивен.
params	Array<Params>	Required	Параметры интеграции

Params

Параметр	Тип	Обязательность	Описание
host	string	Required	Адрес API сервера
port	integer	Required	Порт
login	string	Required	Логин для подключения к серверу
password	string	Required	Пароль
is_jobs_active	boolean	Required	Использовать ли периодические задачи синхронизации: true, false
is_actions_active	boolean	Required	Использовать ли активные действия: true, false

IntegrationJob

Периодическая задача экземпляра интеграции

Параметр	Тип	Обязательность	Описание
id	string	Required	Идентификатор задачи в формате uuid
created_at	string	Required	Дата создания в формате date-time
updated_at	string	Required	Дата изменения в формате date-time
integration_type_id	string	Required	Идентификатор типа интеграции
integration_id	string	Required	Идентификатор экземпляра интеграции, в которой исполняется задача
state	boolean	Required	Состояние задачи: - true - задача активна; - false - задача неактивна.
cron	string	Required	CRON-выражение, описывающее периодичность выполнения задачи

IntegrationJobsMeta

Периодические задачи типа интеграции

Параметр	Тип	Обязательность	Описание
id	string	Required	Идентификатор задачи в формате uuid
integration_type_id	string	Required	Идентификатор типа интеграции в формате uuid
name	string	Required	Название задачи
command	string	Required	Текст запускаемой команды
state	boolean	Required	Глобальное состояние задачи: - true - задача активна; - false - задача неактивна.
mappings	Array<object>	Required	Массив передаваемых параметров
mappings{parameter_name}	string	Required	Имя передаваемого параметра
mappings{parameter_type}	string	Required	Тип передаваемого параметра

IntegrationAction

Активное действие:

Параметр	Тип	Обязательность	Описание
id	string	Required	Идентификатор активного действия в формате uuid
integration_id	string	Required	Идентификатор экземпляра интеграции в формате uuid
created_at	string	Required	Дата создания в формате date-time
updated_at	string	Required	Дата изменения в формате date-time
state	boolean	Required	Состояние скрипта Вкл/выкл
integration_type_id	string	Required	Идентификатор типа интеграции в формате uuid
name	string	Required	Название активного действия
script_lin	string	Optional	Скрипт активного действия для ОС Linux
script_win	string	Optional	Скрипт активного действия для ОС Windows
state	boolean	Required	Глобальное состояние скрипта (вкл/выкл) для всех экземпляров платформы
params	Array<object>	Required	Список параметров для запуска скрипта
params{parameter_name}	string	Required	Имя передаваемого для запуска скрипта параметра
params{parameter_value}	string	Required	Что необходимо передать в качестве значения параметра (поле события)
params{from_event}	boolean	Required	Берётся ли значение параметра из поля события или ручной ввод значения

IntegrationActionMeta

Активное действие типа интеграции:

Параметр	Тип	Обязательность	Описание
id	string	Required	Идентификатор активного действия в формате uuid
integration_type_id	string	Required	Идентификатор типа интеграции в формате uuid
name	string	Required	Название активного действия
params	Array<object>	Required	Список параметров для запуска скрипта
params{parameter_name}	string	Required	Имя передаваемого для запуска скрипта параметра
params{parameter_value}	string	Required	Что необходимо передать в качестве значения параметра (поле события)
params{from_event}	boolean	Required	Берётся ли значение параметра из поля события или ручной ввод значения
script_lin	string	Optional	Скрипт активного действия для ОС Linux
script_win	string	Optional	Скрипт активного действия для ОС Windows
created_at	string	Required	Дата создания в формате date-time
updated_at	string	Required	Дата изменения в формате date-time

IntegrationActionsLog

Журнал работы активных действий:

Параметр	Тип	Обязательность	Описание
id	string	Required	Идентификатор записи в формате uuid
integration_id	string	Required	Идентификатор экземпляра интеграции в формате uuid
integration_action_id	string	Required	Идентификатор активного действия в формате uuid
integration_script_id	string	Required	Идентификатор скрипта
incident_id	string	Required	Идентификатор связанного инцидента
service_asset_id	string	Required	Идентификатор актива
rule_id	string	Required	Идентификатор сработавшего правила корреляции
executed_at	string	Required	Дата и время запуска команды от активного действия
result_at	string	Required	Дата и время получения ответа после выполнения команды
executed_by	string	Required	Инициатор запуска команды (пользователь или система на основе правила)
params	object	Required	Объект с параметрами запуска
result	string	Required	Результат выполнения команды
return_code	integer	Required	Код ответа команды
integration	string	Required
integration_action	string	Required
integration_script	string	Required
service_asset	string	Required
logmule_go_rule	string	Required
_relations	object	Required	Словарь, описывающий связанные сущности через идентификаторы

ActionsHistoryRecord

Запись истории выполнения активного действия на активе:

Параметр	Тип	Обязательность	Описание
id	integer	Required	Идентификатор записи
integration_id	string	Required	Идентификатор экземпляра интеграции
integration_script_id	integer	Required	Идентификатор отработавшей команды активного действия
name	string	Required	Название активного действия
params	Array<object>	Required	Параметры запуска команды
params{parameter_name}	string	Required	Имя параметра, передаваемого для запуска команды
params{parameter_value}	string	Required	Что необходимо передать в качестве значения параметра (поле события)
executed_at	string	Required	Время запуска команды
result_at	string	Required	Время получения ответа команды
result	string	Required	Ответ после выполнения команды
executed_by	string	Required	Инициатор запуска команды: пользователь или правило корреляции
rule_id	string	Required	Правило корреляции в рамках которого выполнилась команда
incident_id	string	Optional	Если был создан инцидент, его ИД
service_assets_id	string	Required	Идентификатора актива, на котором была выполнена команда

LogmuleGoRulesIntegrationAction

Активное действие интеграции в правиле корреляции:

Параметр	Тип	Обязательность	Описание
id	string	Required	Идентификатор активного действия в формате uuid
created_at	string	Required	Дата создания в формате date-time
updated_at	string	Required	Дата изменения в формате date-time
rule_id	string	Required	Идентификатор правила корреляции в формате uuid
integration_script_id	string	Required	Идентификатор команды (скрипта) интеграции в формате uuid
params	Array<object>	Required	Список параметров для запуска команды (скрипта) интеграции
params{parameter_name}	string	Required	Имя передаваемого параметра
params{parameter_value}	string	Required	Значение параметра
params{from_logline}	boolean	Required	Флаг для получения значения параметра из логлайна (события). Если true, поле parameter_value должно содержать название поля логлайна (может содержать . для полей вложенных объектов)
params{strategy}	string	Required	Стратегия выбора логлайна из массива. Поддерживаемые значения: - first — выбора первого логлайна, - last — выбора последнего логлайна.
state	boolean	Required	Состояние активного действия в интеграции: вкл/выкл
logmule_go_rule	Array<object>	Required	Модель связанного правила корреляции
integration_script	Array<object>	Required	Связанная команда (скрипт) интеграции
integration_script{id}	string	Required	Идентификатор команды (скрипта)
integration_script{created_at}	string	Required	Дата создания в формате date-time
integration_script{updated_at}	string	Required	Дата изменения в формате date-time