Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titleDescription

Cancels any number of alarmsalarm pipelines, specified by their event ids. The event id is generated for an alarm when it becomes active, and is used to identify a particular event from other events for the same sourceEvent ids can be obtains from the system.alarm.queryStatus function. Canceling a pipeline will not impact the alarm that triggered the pipeline. The alarm will still be active, but will drop out of alarm pipelines.

...

Panel
titleSyntax

system.alarm.cancel(alarmIds)

  • Parameters

List[String] alarmIds - List of alarm pipeline event ids (UUIDs) to cancel.

  • Returns

Nothing

  • Scope

Gateway, Vision Client, Perspective Session

...