Функции для работы с сигналами

Описание и характеристика функций модуля Автоматизации, которые используются при разработке сценариев обработки первичных событий и регистрации сигналов.

Общие параметры для функций

Входящие пины

• In
  Тип: exec
  Описание: Пин вызова функции и передачи в нее управления
• BearerToken
  По умолчанию BearerToken запрашивается из системной переменной Scenario.
  Если указать вручную, в запросе к API будет применен указанный токен.

Исходящие пины

• Ok
  Тип: exec
  Описание: Последовательность продолжается по этой ветке в случае успешного выполнения запроса
• Failed
  Тип: exec
  Описание: Последовательность продолжается по этой ветке если запрос выполнен с ошибкой
• Response
  Тип: Struct:AutomatonResponse
  Описание: Возвращает результат выполнения запроса в виде данных со структурой модели AutomatonResponse

Функции создания сигналов

CreateSignal

Назначение: Создание сигнала
Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/signals для создания нового сигнала

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalPost	Struct:SignalPost	Модель запроса на создание сигнала

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Signal	Struct:Signal	Возвращает модель созданного сигнала

CreateSignalBatch

Назначение: Пакетное создание сигналов
Описание: Функция выполняет запрос к API Monq для создания новых сигналов.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalPostModels	Struct:SignalPost (Array)	Массив моделей сигналов, которые будут созданы

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Signals	Struct:SignalShort(Array)	Возвращает массив моделей созданных сигналов

CreateSignalExpanded

Назначение: Создание сигнала (расширенное)
Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/signals для создания нового сигнала.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
Name	String	Название сигнала
Description	String	Описание сигнала
Labels	Dynamic	Метки сигнала
OwnerWorkGroupId	Integer64	Владелец сигнала
Severity	Integer	Критичность сигнала. Принимает значения от 1 до 6.
ConfigItemIds	Integer64:Array	Идентификаторы КЕ, которые будут связаны с сигналом. Могут быть привязаны только те КЕ, владелец которых совпадает с владельцем сигнала.
Tags	Struct:SignalTag (Array)	Теги, которые будут добавлены к сигналу.
Events	Struct:Event (Array)	События, которые будут привязаны к сигналу. Указывается id стартового события (из сист. переменной StartEventId), тип и тело самого события.
ConfigItemComponentIds	Integer64:Array	Идентификаторы компонентов КЕ.
ConfigItemComponentName	String	Название компонента КЕ. Работает только в паре с пином ConfigItemIds
AssigneeId	Integer64	Идентификатор ответственного
CustomFields	Struct: CustomFieldValuesPostModel (Array)	Настраиваемые поля (атрибуты) сигнала
TypeKey	String	Ключ типа сигнала

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Signal	Struct:Signal	Возвращает модель созданного сигнала

Доступные цвета для тегов

pink, violet, indigo, blue, teal, green, orange, brown, slate

Функции закрытия сигналов

CloseSignal

Назначение: Закрытие сигнала
Описание: Функция выполняет запрос к API [PATCH] /api/public/sm/v2/signals/{id} и устанавливает сигналу статус Closed.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalId	Integer64	Id сигнала, который будет закрыт

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Signal	Struct:Signal	Возвращает модель закрытого сигнала

CloseSignalBatch

Назначение: Пакетное закрытие сигналов
Описание: Функция выполняет запрос к API Monq и устанавливает переданным сигналам статус Closed.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalIds	Integer64 (Array)	Массив идентификаторов сигналов, которые будут закрыты

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Signals	Struct:SignalShort (Array)	Возвращает массив моделей закрытых сигналов

Функции для работы с тегами сигналов

BindTagsToSignal

Назначение: Привязать теги к сигналу
Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/signals/{id}/tags и привязывает к сигналу список переданных тегов.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalId	Integer64	Id сигнала, у которого будут изменены теги
Tags	Struct:SignalTag (Array)	Список моделей тегов, которые будут привязаны к сигналу. В случае указания названия цвета, несуществующего в системе, тег будет отражен серым цветом с названием, переданным пользователем.

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Tags	Struct:SignalTag (Array)	Возвращает список моделей привязанных тегов

BindTagsToSignalBatch

Назначение: Пакетная привязка тегов к сигналу
Описание: Функция выполняет запрос к API Monq и привязывает к сигналу список переданных тегов пакетно.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalsTagsBinds	Struct: SignalBindTagsPostModel (Array)	Массив моделей сигнал/тег, указывающая к каким сигналам какие теги будут добавлены

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
SignalsBindsResult	Struct: SignalBindsTagsResultModel (Array)	Возвращает список моделей привязанных тегов

UnbindTagsFromSignal

Назначение: Отвязать теги от сигнала
Описание: Функция выполняет запрос к API [DELETE] /api/public/sm/v2/signals/{id}/tags и удаляет привязку тегов от сигнала.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalId	Integer64	Id сигнала, у которого будут изменены теги
Tags	Struct:SignalTag (Array)	Список моделей тегов, которые будут отвязаны от сигнала.

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций

UnbindTagsFromSignalBatch

Назначение: Отвязать теги от сигнала пакетно
Описание: Функция выполняет запрос к API Monq и удаляет привязку тегов от сигнала пакетно.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalsTagsUnbinds	Struct: SignalUnbindTagsDeleteModel (Array)	Массив моделей сигнал/тег, указывающая от какого сигнала какие теги будут отвязаны

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций

Функции для работы со связанными КЕ

BindConfigItemsToSignal

Назначение: Привязать КЕ к сигналу
Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/signals/{id}/config-items и привязывает к сигналу список переданных идентификаторов КЕ.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalId	Integer64	Id сигнала, у которого будут изменены КЕ
ConfigItemIds	Integer64 (Array)	Список идентификаторов КЕ, которые будут привязаны к сигналу

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
ConfigItems	Struct: SignalConfigItem (Array)	Возвращает список моделей привязанных КЕ

BindConfigItemsToSignalBatch

Назначение: Пакетная привязка КЕ к сигналу
Описание: Функция выполняет запрос к API Monq и привязывает к сигналу список переданных идентификаторов КЕ пакетно.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalsConfigItemsBinds	Struct: SignalBindConfigItemPostModel (Array)	Массив моделей связей сигналов и КЕ, которые будут установлены

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
SignalsBindsResult	Struct: SignalBindConfigItemsResultModel (Array)	Массив моделей сигналов с установленными связями к КЕ

UnBindConfigItemsFromSignal

Назначение: Отвязать КЕ от сигнала
Описание: Функция выполняет запрос к API [DELETE] /api/public/sm/v2/signals/{id}/config-items и отвязывает переданные идентификаторы КЕ от сигнала.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalId	Integer64	Id сигнала, у которого будут изменены КЕ
ConfigItemIds	Integer64 (Array)	Список идентификаторов КЕ, которые будут отвязаны от сигнала

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций

UnBindConfigItemsFromSignalBatch

Назначение: Пакетно отвязать КЕ от сигнала
Описание: Функция выполняет запрос к API Monq и отвязывает переданные идентификаторы КЕ от сигнала.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalsConfigitemsUnbinds	Struct: SignalUnbindConfigItemsDeleteModel (Array)	Массив моделей связей сигналов и КЕ, которые будут удалены

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций

Функции для работы с событиями сигналов

BindEventsToSignal

Назначение: Привязать события к сигналу
Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/signals/{id}/events и привязывает к сигналу список переданных моделей событий.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalId	Integer64	Id сигнала, к которому будут привязаны события
Events	Struct:Event (Array)	Список моделей событий, которые будут привязаны к сигналу

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Events	Struct:Event (Array)	Возвращает список моделей привязанных событий

Функции обновления информации в сигналах

UpdateSignal

Назначение: Обновление данных сигнала
Описание: Функция выполняет запрос к API [PATCH] /api/public/sm/v2/signals/{id}для обновления данных и возвращает обновленную модель сигнала.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalId	Integer64	Идентификатор сигнала
SignalPatch	Struct:SignalPatch	Модель обновления сигнала. Корректные значения статусов - Open/Closed

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Signal	Struct:Signal	Возвращает обновленную модель сигнала

UpdateSignalBatch

Назначение: Пакетное обновление данных сигнала
Описание: Функция выполняет запрос к API Monq для обновления данных сигнала.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalsPatchModels	Struct:SignalPatchModel (Array)	Массив моделей сигналов, требующих обновления

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Signals	Struct:Signal (Array)	Возвращает массив моделей обновленных сигналов

UpdateSignalExpanded

Назначение: Обновление данных сигнала (Expanded)
Описание: Функция выполняет запрос к API [PATCH] /api/public/sm/v2/signals/{id}для обновления данных и возвращает обновленную модель сигнала.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalId	Integer64	Идентификатор сигнала
Status	String	Статус сигнала. Корректные значения статусов - Open/Closed
ConfigItemIds	Integer64 (Array)	Список идентификаторов КЕ
Tags	Struct:SignalTag (Array)	Список моделей тегов сигнала
Labels	Dynamic	Метки сигнала
ConfigItemComponentName	String	Название компонента КЕ. Работает только в паре с пином ConfigItemIds
AssigneeId	Integer64	Идентификатор пользователя системы
Name	String	Название сигнала
Description	String	Описание сигнала
Severity	Integer	Критичность сигнала
CustomFields	Struct:CustomFieldValuesPostModel	Настраиваемые поля сигнала

к сведению

Для обновления конкретных атрибутов, например только Name, в остальные входящие пины необходимо передать Null через функцию ReturnNull

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Signal	Struct:Signal	Возвращает обновленную модель сигнала

BindImageLinksToSignal

Назначение: Привязка вложения к сигналу
Описание: Функция реализует привязку вложения, типа ImageLink к сигналу.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalId	Integer64	Идентификатор сигнала
MakeNameUnique	Boolean	Если установлено False - уже привязанный файл с таким же названием и типом будет перезаписан
ImageLinks	Struct:SignalImageLink (Array)	Массив моделей вложений типа ImageLink. Позволяет указать для каждого вложения название и внутреннюю ссылку на него

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Attachments	Struct:SignalAttachment (Array)	Массив моделей привязанных вложений

UnbindImageLinksFromSignal

Назначение: Отвязка вложения от сигнала
Описание: Функция реализует отвязку вложения, типа ImageLink от сигнала.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalId	Integer64	Идентификатор сигнала
ImageLinkNames	String (Array)	Массив названий вложений, типа ImageLink, которые будут отвязаны от указанного сигнала

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций

BindConfigItemComponentsToSignal

Назначение: Привязка сигнала к компоненту КЕ
Описание: Функция реализует привязку сигнала к определенному компоненту КЕ

Общие требования к привязке компонентов:

• К одному сигналу можно привязать только один компонент для каждой КЕ. Всего компонентов может быть множество, но они должны относиться к разным КЕ
• Можно указать как идентификаторы КЕ так и идентификаторы компонентов одновременно, если они не противоречат предыдущему условию
• При указании только идентификаторов КЕ, сигнал будет привязан к компоненту по умолчанию для данной КЕ

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalId	Integer64	Идентификатор сигнала
ConfigItemIds	Integer64 (Array)	Массив КЕ, который можно указать для привязки сигнала к ее компонентам по умолчанию
ConfigItemComponentIds	Integer64 (Array)	Массив компонентов, которые будут привязаны к сигналу

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
ConfigItems	Struct:SignalConfigItem	Массив привязанных КЕ, с указанием идентификатора компонента

UnbindConfigItemComponentsFromSignal

Назначение: Отвязка сигнала от компонента КЕ
Описание: Функция реализует отвязку сигнала от определенного компонента КЕ

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalId	Integer64	Идентификатор сигнала
ConfigItemIds	Integer64 (Array)	Массив КЕ, который можно указать для отвязки сигнала от ее компонентов
ConfigItemComponentIds	Integer64 (Array)	Массив компонентов, которые будут отвязаны от сигнала

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций

BindLinksToSignal

Назначение: Привязка ссылок к сигналу
Описание: Функция реализует привязку сторонних и внутренних ссылок для обогащения информации о сигнале

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalId	Integer64	Идентификатор сигнала
MakeNameUnique	Boolean	Если установлено false - привязанная ссылка с таким же названием будет обновлена. Иначе к названию будет добавлен уникальный индекс
Links	SignalLink (Array)	Массив моделей вложений типа Link

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Attachments	Struct:SignalAttachment	Массив моделей привязанных вложений

UnbindLinksFromSignal

Назначение: Отвязка ссылок от сигнала
Описание: Функция реализует отвязку неактуальных сторонних и внутренних ссылок от сигнала

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalId	Integer64	Идентификатор сигнала
LinkNames	String (Array)	Массив названий ссылок, типа Link, которые будут отвязаны от указанного сигнала

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций

Функции поиска по сигналам

FilterSignalsExpanded

Назначение: Поиск сигналов по фильтру
Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/signals/filter и возвращает список моделей сигналов попадающих под условия фильтра.

Важно

Есть несколько структур, которые требуют обязательного заполнения. Если фильтрация по ним не предполагается, необходимо передать значение Null с помощью функции ReturnNull.
Список обязательных пинов: CreateAt, ClosedAt, DurationMilliseconds

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
Ids	Integer64 (Array)	Идентификаторы сигналов
ConfigItemIds	Integer64 (Array)	Id связанных КЕ
CreatedAt	Struct:DatePost	Фильтрация по дате открытия
ClosedAt	Struct:DatePost	Фильтрация по дате закрытия
Statuses	String (Array)	Список статусов. Возможные варианты: Open, Closed
Severities	Integer (Array)	Степени критичности. Возможные варианты: от 1 до 6
DurationMilliseconds	Struct:ValueFilter	Фильтрация по длительности сигнала в миллисекундах
OwnerWorkGroupIds	Integer64 (Array)	Идентификаторы Рабочих групп
Tags	Struct:SignalTag (Array)	Список моделей тегов. При указании нескольких моделей тегов - фильтрация осуществляется через логическое "И"
Labels	Struct:LabelsFilter	Фильтрация по меткам
ConfigItemComponentIds	Integer64 (Array)	Id компонентов КЕ
AssigneeIds	Integer64 (Array)	Фильтрация по ответственному
CustomFields	Struct:CustomFieldFilterModel (Array)	Фильтрация по настраиваемым полям (атрибутам)

DatePost

Можно разложить структуру DatePost и передать дату в ее свойства:
MoreThan - будут возвращены сигналы, созданные позднее указанной даты
LessThan - ранее указанной даты
Equal - в указанную дату
LessThanOrEqual - ранее или в указанную дату
MoreThanOrEqual - позднее или в указанную дату
Range - Возможность задать интервал, например через функцию DateRangeToNow или разложив структуру на Start и End и передать для них даты

Фильтрация по меткам

• Можно указать только Key и в таком случае вернутся все сигналы, для меток которых существует указанный ключ.
• Также можно указать точное соответствие через пин Value. Тогда фильтрация будет реализована по полному соответствию ключей и значений.
• При указании нескольких моделей меток - фильтрация осуществляется через логическое "И".
• Если передать Null на вход, метки не будут учитываться при фильтрации.

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Signals	Struct:Signal (Array)	Возвращает список моделей найденных сигналов

GetSignalById

Назначение: Получение информации о сигнале по Id
Описание: Функция выполняет запрос к API [GET] /api/public/sm/v2/signals/{id} и возвращает модель сигнала по его идентификатору.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
SignalId	Integer64	Идентификатор сигнала

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Signal	Struct:Signal	Возвращает модель найденного сигнала