Функции для работы с Сигналами
Описание и характеристика функций модуля Автоматизации, которые используются при разработке сценариев обработки первичных событий и регистрации сигналов.
Функции создания сигналов
CreateSignal
-
Назначение: Создание сигнала
-
Описание: Функция выполняет запрос к API
[POST] /api/public/sm/v2/signals
для создания нового сигнала.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол SignalPost Struct:SignalPost Модель з апроса на создание сигнала. Доступные значения для свойства CreatedBy
:Automaton
,User
Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Signal Struct:Signal Возвращает модель созданного сигнала Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
CreateSignalBatch
-
Назначение: Пакетное создание сигналов
-
Описание: Функция выполняет запрос к API Monq для создания новых сигналов.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол SignalPostModels Struct:SignalPost (Array) Массив моделей сигналов, которые будут созданы Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Signals Struct:SignalShort(Array) Возвращает массив моделей созданных сигналов Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
CreateSignalExpanded
-
Назначение: Создание сигнала (Expanded)
-
Описание: Функция выполняет запрос к API
[POST] /api/public/sm/v2/signals
для создания нового сигнала.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол 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
Связь - Доступные цвета для тэгов:
pink
,violet
,indigo
,blue
,teal
,green
,orange
,brown
,slate
- Доступные цвета для тэгов:
-
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Signal Struct:Signal Возвращает модель созданного сигнала Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
Функции закрытия сигналов
CloseSignal
-
Назначение: Закрытие сигнала
-
Описание: Функция выполняет запрос к API
[PATCH] /api/public/sm/v2/signals/{id}
и устанавливает сигналу статусClosed
.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол SignalId Integer64 Id сигнала, который будет закрыт Связь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Signal Struct:Signal Возвращает модель закрытого сигнала Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
CloseSignalBatch
-
Назначение: Пакетное закрытие сигналов
-
Описание: Функция выполняет запрос к API Monq и устанавливает переданным сигналам статус
Closed
.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол SignalIds Integer64 (Array) Массив идентификаторов сигналов, которые будут закрыты Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Signals Struct:SignalShort (Array) Возвращает массив моделей закрытых сигналов Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
Функции для работы с тэгами сигналов
BindTagsToSignal
-
Назначение: Привязать тэги к сигналу
-
Описание: Функция выполняет запрос к API
[POST] /api/public/sm/v2/signals/{id}/tags
и привязывает к сигналу список переданных тэгов.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запр осе к API будет применен указанныйСвязь/контрол SignalId Integer64 Id сигнала, у которого будут изменены теги Связь/контрол Tags Struct:SignalTag (Array) Список моделей тэгов, которые будут привязаны к сигналу. В случае указания названия цвета, несуществующего в системе, тег будет отражен серым цветом с названием, переданным пользователем. Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Tags Struct:SignalTag (Array) Возвращает список моделей привязанных тэгов Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
BindTagsToSignalBatch
-
Назначение: Паке тная привязка тэгов к сигналу
-
Описание: Функция выполняет запрос к API Monq и привязывает к сигналу список переданных тэгов пакетно.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол SignalsTagsBinds Struct:SignalBindTagsPostModel (Array) Массив моделей сигнал/тег, указывающая к каким сигналам какие теги будут добавлены Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь SignalsBindsResult Struct:SignalBindsTagsResultModel (Array) Возвращает список моделей привязанных тэгов Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
UnbindTagsFromSignal
-
Назначение: Отвязать тэги от сигнала
-
Описание: Функция выполняет запрос к API
[DELETE] /api/public/sm/v2/signals/{id}/tags
и удаляет привязку тэгов от сигнала.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол SignalId Integer64 Id сигнала, у которого будут изменены теги Связь/контрол Tags Struct:SignalTag (Array) Список моделей тэгов, которые будут отвязаны от сигнала. Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
UnbindTagsFromSignalBatch
-
Назначение: Отвязать тэги от сигнала пакетно
-
Описание: Функция выполняет запрос к API Monq и удаляет привязку тэгов от сигнала пакетно.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол SignalsTagsUnbinds Struct:SignalUnbindTagsDeleteModel (Array) Массив моделей сигнал/тег, указывающая от какого сигнала какие теги будут отвязаны Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
Функции для работы со связанными КЕ
BindConfigItemsToSignal
-
Назначение: Привязать КЕ к сигналу
-
Описание: Функция выполняет запрос к API
[POST] /api/public/sm/v2/signals/{id}/config-items
и привязывает к сигналу список переданных идентификаторов КЕ.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол SignalId Integer64 Id сигнала, у которого будут изменены КЕ Связь/контрол ConfigItemIds Integer64 (Array) Список идентификаторов КЕ, которые будут привязаны к сигналу Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь ConfigItems Struct:SignalConfigItem (Array) Возвращает список моделей привязанных КЕ Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
BindConfigItemsToSignalBatch
-
Назначение: Пакетная привязка КЕ к сигналу
-
Описание: Функция выполняет запрос к API Monq и привязывает к сигналу список переданных идентификаторов КЕ пакетно.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол SignalsConfigItemsBinds Struct:SignalBindConfigItemPostModel (Array) Массив моделей связей сигналов и КЕ, которые будут установлены Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь SignalsBindsResult Struct:SignalBindConfigItemsResultModel (Array) Массив моделей сигналов с установленными связями к КЕ Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
UnBindConfigItemsFromSignal
-
Назначение: Отвязать КЕ от сигнала
-
Описание: Функция выполняет запрос к API
[DELETE] /api/public/sm/v2/signals/{id}/config-items
и отвязывает переданные идентификаторы КЕ от сигнала.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол SignalId Integer64 Id сигнала, у которого будут изменены КЕ Связь/контрол ConfigItemIds Integer64 (Array) Список идентификаторов КЕ, которые будут отвязаны от сигнала Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
UnBindConfigItemsFromSignalBatch
-
Назначение: Пакетно отвязать КЕ от сигнала
-
Описание: Функция выполняет запрос к API Monq и отвязывает переданные идентификаторы КЕ от сигнала.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол SignalsConfigitemsUnbinds Struct:SignalUnbindConfigItemsDeleteModel (Array) Массив моделей связей сигналов и КЕ, которые будут удалены Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
Функции для работы с событиями сигналов
BindEventsToSignal
-
Назначение: Привязать события к сигналу
-
Описание: Функция выполняет запрос к API
[POST] /api/public/sm/v2/signals/{id}/events
и привязывает к сигналу список переданных м оделей событий.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол SignalId Integer64 Id сигнала, к которому будут привязаны события Связь/контрол Events Struct:Event (Array) Список моделей событий, которые будут привязаны к сигналу Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Events Struct:Event (Array) Возвращает список моделей привязанных событий Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-