InlineAlarmInfo0

InlineAlarmInfo0

Parameters for alarm creation.

JSON Example

{
    "_typeName": "string",
    "name": "string",
    "systemName": "string",
    "description": "string",
    "enabled": false,
    "expression": {
        "_typeName": "string"
    },
    "action": {
        "_typeName": "string"
    },
    "actionFrequency": 0,
    "setting": {
        "_typeName": "string",
        "toleranceRange": 0,
        "reportingFrequency": 0
    }
}

string

name

Required

Name of the alarm.

string

systemName

Optional

System name of the alarm.

This is set only for predefined Alarms - i.e. Alarms created by the server or extensions automatically. After creation this value cannot be modified. User-created Alarms do not have a systemName at all.

The purpose of this field is to identify system-created Alarms reliably, even if they are edited by users.

When creating Alarms with systemName, the systemName and the name of the alarm should be equal.

When reconfiguring an Alarm with systemName, the same systemName should be passed in the new AlarmSpec. Renaming Alarms with systemName is not allowed, i.e. when reconfiguring, the name passed in the new AlarmSpec should be equal to either the systemName or its localized version (the current name in the Alarm's info).

string

description

Required

Description of the alarm.

boolean

enabled

Required

Flag to indicate whether or not the alarm is enabled or disabled.

expression

Required

Top-level alarm expression that defines trigger conditions.

action

Optional

Action to perform when the alarm is triggered.

integer As int32 As int32

actionFrequency

Optional

Frequency in seconds, which specifies how often appropriate actions should repeat when an alarm does not change state.

setting

Optional

Tolerance and maximum frequency settings.

Used By

AlarmInfo