Перейти к основному содержимому
Версия: 7.14

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

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

CreateSignal

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalPostStruct:SignalPostМодель запроса на создание сигнала. Доступные значения для свойства CreatedBy: Automaton, UserСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      SignalStruct:SignalВозвращает модель созданного сигналаСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

CreateSignalBatch

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalPostModelsStruct:SignalPost (Array)Массив моделей сигналов, которые будут созданыСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      SignalsStruct:SignalShort(Array)Возвращает массив моделей созданных сигналовСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

CreateSignalExpanded

  • Назначение: Создание сигнала (Expanded)

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      NameStringНазвание сигналаСвязь/контрол
      DescriptionStringОписание сигналаСвязь/контрол
      LabelsDynamicМетки сигналаСвязь
      OwnerWorkGroupIdInteger64Владелец сигналаСвязь/контрол
      SeverityIntegerКритичность сигнала. Принимает значения от 1 до 6.Связь/контрол
      ConfigItemIdsInteger64:ArrayИдентификаторы КЕ, которые будут связаны с сигналом. Могут быть привязаны только те КЕ, владелец которых совпадает с владельцем сигнала.Связь
      TagsStruct:SignalTag (Array)Теги, которые будут добавлены к сигналу.Связь
      EventsStruct:Event (Array)События, которые будут привязаны к сигналу. Указывается id стартового события (из сист. переменной StartEventId), тип и тело самого события.Связь
      ConfigItemComponentIdsInteger64:ArrayИдентификаторы компонентов КЕ.Связь
      ConfigItemComponentNameStringНазвание компонента КЕ. Работает только в паре с пином ConfigItemIdsСвязь
      • Доступные цвета для тэгов: pink, violet, indigo, blue, teal, green, orange, brown, slate
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      SignalStruct:SignalВозвращает модель созданного сигналаСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

CloseSignal

  • Назначение: Закрытие сигнала

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdInteger64Id сигнала, который будет закрытСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      SignalStruct:SignalВозвращает модель закрытого сигналаСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

CloseSignalBatch

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdsInteger64 (Array)Массив идентификаторов сигналов, которые будут закрытыСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      SignalsStruct:SignalShort (Array)Возвращает массив моделей закрытых сигналовСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

BindTagsToSignal

  • Назначение: Привязать тэги к сигналу

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdInteger64Id сигнала, у которого будут изменены тегиСвязь/контрол
      TagsStruct:SignalTag (Array)Список моделей тэгов, которые будут привязаны к сигналу. В случае указания названия цвета, несуществующего в системе, тег будет отражен серым цветом с названием, переданным пользователем.Связь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      TagsStruct:SignalTag (Array)Возвращает список моделей привязанных тэговСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

BindTagsToSignalBatch

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalsTagsBindsStruct:SignalBindTagsPostModel (Array)Массив моделей сигнал/тег, указывающая к каким сигналам какие теги будут добавленыСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      SignalsBindsResultStruct:SignalBindsTagsResultModel (Array)Возвращает список моделей привязанных тэговСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

UnbindTagsFromSignal

  • Назначение: Отвязать тэги от сигнала

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdInteger64Id сигнала, у которого будут изменены тегиСвязь/контрол
      TagsStruct:SignalTag (Array)Список моделей тэгов, которые будут отвязаны от сигнала.Связь
    • Outputs

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

UnbindTagsFromSignalBatch

  • Назначение: Отвязать тэги от сигнала пакетно

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalsTagsUnbindsStruct:SignalUnbindTagsDeleteModel (Array)Массив моделей сигнал/тег, указывающая от какого сигнала какие теги будут отвязаныСвязь
    • Outputs

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

BindConfigItemsToSignal

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdInteger64Id сигнала, у которого будут изменены КЕСвязь/контрол
      ConfigItemIdsInteger64 (Array)Список идентификаторов КЕ, которые будут привязаны к сигналуСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ConfigItemsStruct:SignalConfigItem (Array)Возвращает список моделей привязанных КЕСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

BindConfigItemsToSignalBatch

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalsConfigItemsBindsStruct:SignalBindConfigItemPostModel (Array)Массив моделей связей сигналов и КЕ, которые будут установленыСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      SignalsBindsResultStruct:SignalBindConfigItemsResultModel (Array)Массив моделей сигналов с установленными связями к КЕСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

UnBindConfigItemsFromSignal

  • Назначение: Отвязать КЕ от сигнала

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdInteger64Id сигнала, у которого будут изменены КЕСвязь/контрол
      ConfigItemIdsInteger64 (Array)Список идентификаторов КЕ, которые будут отвязаны от сигналаСвязь
    • Outputs

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

UnBindConfigItemsFromSignalBatch

  • Назначение: Пакетно отвязать КЕ от сигнала

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalsConfigitemsUnbindsStruct:SignalUnbindConfigItemsDeleteModel (Array)Массив моделей связей сигналов и КЕ, которые будут удаленыСвязь
    • Outputs

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

BindEventsToSignal

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdInteger64Id сигнала, к которому будут привязаны событияСвязь/контрол
      EventsStruct:Event (Array)Список моделей событий, которые будут привязаны к сигналуСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      EventsStruct:Event (Array)Возвращает список моделей привязанных событийСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

FilterSignalsExpanded

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

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

    Важно!

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

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

    • CreateAt;
    • ClosedAt;
    • DurationMilliseconds

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      IdsInteger64 (Array)Идентификаторы сигналовСвязь
      ConfigItemIdsInteger64 (Array)Id связанных КЕСвязь
      CreatedAtStruct:DatePostФильтрация по дате открытияСвязь
      ClosedAtStruct:DatePostФильтрация по дате закрытияСвязь
      StatusesString (Array)Список статусов. Возможные варианты: Open, ClosedСвязь
      SeveritiesInteger (Array)Степени критичности. Возможные варианты: от 1 до 6Связь
      DurationMillisecondsStruct:ValueFilterФильтрация по длительности сигнала в миллисекундахСвязь
      OwnerWorkGroupIdsInteger64 (Array)Идентификаторы Рабочих группСвязь
      TagsStruct:SignalTag (Array)Список моделей тегов. При указании нескольких моделей тегов - фильтрация осуществляется через логическое "И"Связь
      LabelsStruct:LabelsFilterФильтрация по меткамСвязь
      ConfigItemComponentIdsInteger64 (Array)Id компонентов КЕСвязь
    Struct:DatePost

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

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

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

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

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

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

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



    LabelsFilter

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

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

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

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

    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      SignalsStruct:Signal (Array)Возвращает список моделей найденных сигналовСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

GetSignalById

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdInteger64Идентификатор сигналаСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      SignalStruct:SignalВозвращает модель найденного сигналаСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

UpdateSignal

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdInteger64Идентификатор сигналаСвязь/контрол
      SignalPatchStruct:SignalPatchМодель обновления сигнала.
      Корректные значения статусов - Open/Closed
      Связь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      SignalStruct:SignalВозвращает обновленную модель сигналаСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

UpdateSignalBatch

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalsPatchModelsStruct:SignalPatchModel (Array)Массив моделей сигналов, требующих обновленияСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      SignalsStruct:Signal (Array)Возвращает массив моделей обновленных сигналовСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

UpdateSignalExpanded

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdInteger64Идентификатор сигналаСвязь/контрол
      StatusStringСтатус сигнала.
      Корректные значения статусов - Open/Closed
      Связь/контрол
      ConfigItemIdsInteger64 (Array)Список идентификаторов КЕСвязь
      TagsStruct:SignalTag (Array)Список моделей тэгов сигналаСвязь
      LabelsDynamicМетки сигналаСвязь
      ConfigItemComponentNameStringНазвание компонента КЕ. Работает только в паре с пином ConfigItemIdsСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      SignalStruct:SignalВозвращает обновленную модель сигналаСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

BindImageLinksToSignal

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdInteger64Идентификатор сигналаСвязь/контрол
      MakeNameUniqueBooleanЕсли установлено False - уже привязанный файл с таким же названием и типом будет перезаписанСвязь
      ImageLinksStruct:SignalImageLink (Array)Массив моделей вложений типа ImageLink
      Позволяет указать для каждого вложения название и внутреннюю ссылку на него
      Связь
    • Outputs

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

UnbindImageLinksFromSignal

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdInteger64Идентификатор сигналаСвязь/контрол
      ImageLinkNamesString (Array)Массив названий вложений, типа ImageLink, которые будут отвязаны от указанного сигналаСвязь
    • Outputs

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

BindConfigItemComponentsToSignal

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

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

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

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

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdInteger64Идентификатор сигналаСвязь/контрол
      ConfigItemIdsInteger64 (Array)Массив КЕ, который можно указать для привязки сигнала к ее компонентам по умолчаниюСвязь
      ConfigItemComponentIdsInteger64 (Array)Массив компонентов, которые будут привязаны к сигналуСвязь
    • Outputs

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

UnbindConfigItemComponentsFromSignal

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdInteger64Идентификатор сигналаСвязь/контрол
      ConfigItemIdsInteger64 (Array)Массив КЕ, который можно указать для отвязки сигнала от ее компонентовСвязь
      ConfigItemComponentIdsInteger64 (Array)Массив компонентов, которые будут отвязаны от сигналаСвязь
    • Outputs

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

BindLinksToSignal

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdInteger64Идентификатор сигналаСвязь/контрол
      MakeNameUniqueBooleanЕсли установлено false - привязанная ссылка с таким же названием будет обновлена. Иначе к названию будет добавлен уникальный индексСвязь
      LinksSignalLink (Array)Массив моделей вложений типа LinkСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      AttachmentsStruct:SignalAttachmentМассив моделей привязанных вложенийСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

UnbindLinksFromSignal

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      SignalIdInteger64Идентификатор сигналаСвязь/контрол
      LinkNamesString (Array)Массив названий ссылок, типа Link, которые будут отвязаны от указанного сигналаСвязь
    • Outputs

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