Версия: 8.1

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

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

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

CreateSignal

Назначение: Создание сигнала

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

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
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	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
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	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
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	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
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	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
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	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
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	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
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	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
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	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
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	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
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	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
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	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
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	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
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	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
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	Связь

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

UpdateSignal

Назначение: Обновление данных сигнала

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

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
SignalId	Integer64	Идентификатор сигнала	Связь/контрол
SignalPatch	Struct:SignalPatch	Модель обновления сигнала. Корректные значения статусов - `Open`/`Closed`	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Signal	Struct:Signal	Возвращает обновленную модель сигнала	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

UpdateSignalBatch

Назначение: Пакетное обновление данных сигнала

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

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
SignalsPatchModels	Struct:SignalPatchModel (Array)	Массив моделей сигналов, требующих обновления	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Signals	Struct:Signal (Array)	Возвращает массив моделей обновленных сигналов	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

UpdateSignalExpanded

Назначение: Обновление данных сигнала (Expanded)

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
SignalId	Integer64	Идентификатор сигнала	Связь/контрол
Status	String	Статус сигнала. Корректные значения статусов - `Open`/`Closed`	Связь/контрол
ConfigItemIds	Integer64 (Array)	Список идентификаторов КЕ	Связь
Tags	Struct:SignalTag (Array)	Список моделей тэгов сигнала	Связь
Labels	Dynamic	Метки сигнала	Связь
ConfigItemComponentName	String	Название компонента КЕ. Работает только в паре с пином `ConfigItemIds`	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Signal	Struct:Signal	Возвращает обновленную модель сигнала	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

BindImageLinksToSignal

Назначение: Привязка вложения к сигналу

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

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
SignalId	Integer64	Идентификатор сигнала	Связь/контрол
MakeNameUnique	Boolean	Если установлено `False` - уже привязанный файл с таким же названием и типом будет перезаписан	Связь
ImageLinks	Struct:SignalImageLink (Array)	Массив моделей вложений типа ImageLink Позволяет указать для каждого вложения название и внутреннюю ссылку на него	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Attachments	Struct:SignalAttachment (Array)	Массив моделей привязанных вложений	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

UnbindImageLinksFromSignal

Назначение: Отвязка вложения от сигнала

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

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
SignalId	Integer64	Идентификатор сигнала	Связь/контрол
ImageLinkNames	String (Array)	Массив названий вложений, типа ImageLink, которые будут отвязаны от указанного сигнала	Связь

Outputs

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

BindConfigItemComponentsToSignal

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

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

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

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

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
SignalId	Integer64	Идентификатор сигнала	Связь/контрол
ConfigItemIds	Integer64 (Array)	Массив КЕ, который можно указать для привязки сигнала к ее компонентам по умолчанию	Связь
ConfigItemComponentIds	Integer64 (Array)	Массив компонентов, которые будут привязаны к сигналу	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
ConfigItems	Struct:SignalConfigItem	Массив привязанных КЕ, с указанием идентификатора компонента	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

UnbindConfigItemComponentsFromSignal

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

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

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
SignalId	Integer64	Идентификатор сигнала	Связь/контрол
ConfigItemIds	Integer64 (Array)	Массив КЕ, который можно указать для отвязки сигнала от ее компонентов	Связь
ConfigItemComponentIds	Integer64 (Array)	Массив компонентов, которые будут отвязаны от сигнала	Связь

Outputs

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

BindLinksToSignal

Назначение: Привязка ссылок к сигналу

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

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
SignalId	Integer64	Идентификатор сигнала	Связь/контрол
MakeNameUnique	Boolean	Если установлено `false` - привязанная ссылка с таким же названием будет обновлена. Иначе к названию будет добавлен уникальный индекс	Связь
Links	SignalLink (Array)	Массив моделей вложений типа Link	Связь

Outputs

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

UnbindLinksFromSignal

Назначение: Отвязка ссылок от сигнала

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

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
SignalId	Integer64	Идентификатор сигнала	Связь/контрол
LinkNames	String (Array)	Массив названий ссылок, типа Link, которые будут отвязаны от указанного сигнала	Связь

Outputs

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

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

FilterSignalsExpanded

Назначение: Поиск сигналов по фильтру

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

Важно!

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

Список пинов, которые требуют обязательного параметра:

CreateAt;
ClosedAt;
DurationMilliseconds

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
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 компонентов КЕ	Связь

Struct:DatePost

Пользователь может разложить структуру и передать дату на ее свойства.

MoreThan - будут возвращены сигналы, созданные позднее указанной даты;

LessThan - ранее указанной даты;

Equal - в указанную дату;

LessThanOrEqual - ранее или в указанную дату;

MoreThanOrEqual - позднее или в указанную дату;

Range - Возможность задать интервал, например через функцию DateRangeToNow или разложив структуру на Start и End и передать для них даты.

LabelsFilter

Фильтрация по меткам. Пользователь может указать только Key и в таком случае вернутся все сигналы, для меток которых существует указанный ключ.

Так же пользователь сможет указать точное соответствие через пин Value. Тогда фильтрация будет реализована по полному соответствию ключей и значений.

При указании нескольких моделей меток - фильтрация осуществляется через логическое "И".

Если пользователь передаст Null на вход, метки не будут учитываться при фильтрации.

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Signals	Struct:Signal (Array)	Возвращает список моделей найденных сигналов	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

GetSignalById

Назначение: Получение информации о сигнале по Id

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

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
Scenario	Struct:ScenarioBase	Системная переменная	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
SignalId	Integer64	Идентификатор сигнала	Связь/контрол

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Signal	Struct:Signal	Возвращает модель найденного сигнала	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

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

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

CreateSignal​

CreateSignalBatch​

CreateSignalExpanded​

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

CloseSignal​

CloseSignalBatch​

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

BindTagsToSignal​

BindTagsToSignalBatch​

UnbindTagsFromSignal​

UnbindTagsFromSignalBatch​

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

BindConfigItemsToSignal​

BindConfigItemsToSignalBatch​

UnBindConfigItemsFromSignal​

UnBindConfigItemsFromSignalBatch​

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

BindEventsToSignal​

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

UpdateSignal​

UpdateSignalBatch​

UpdateSignalExpanded​

BindImageLinksToSignal​

UnbindImageLinksFromSignal​

BindConfigItemComponentsToSignal​

UnbindConfigItemComponentsFromSignal​

BindLinksToSignal​

UnbindLinksFromSignal​

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

FilterSignalsExpanded​

GetSignalById​

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

CreateSignal

CreateSignalBatch

CreateSignalExpanded

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

CloseSignal

CloseSignalBatch

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

BindTagsToSignal

BindTagsToSignalBatch

UnbindTagsFromSignal

UnbindTagsFromSignalBatch

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

BindConfigItemsToSignal

BindConfigItemsToSignalBatch

UnBindConfigItemsFromSignal

UnBindConfigItemsFromSignalBatch

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

BindEventsToSignal

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

UpdateSignal

UpdateSignalBatch

UpdateSignalExpanded

BindImageLinksToSignal

UnbindImageLinksFromSignal

BindConfigItemComponentsToSignal

UnbindConfigItemComponentsFromSignal

BindLinksToSignal

UnbindLinksFromSignal

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

FilterSignalsExpanded

GetSignalById