Alert data type

Introduction

The alert data type allows obtaining the configuration of an alert. Below are all the properties of the alert data type.

Properties

AlertID (int) The AlertID property represents the unique identifier of the alert in the platform. This identifier is automatically assigned when an alert is created. ### VariableTypeID (int enum)

The VariableTypeID property indicates the type of variable associated with the alert. For user-defined variables, the ID is always equal to or greater than 1000. For the predefined variable types in the platform, the values are as follows:

• Temperature = 1
• Humidity = 2,
• Light level = 3
• Setpoint = 4
• Volume = 5
• Active energy = 6
• Run time = 7
• Discrete sensor state = 8
• Dimmerization = 9
• Weight = 10
• Flow = 11
• Voltage = 12
• Current = 13
• Active power = 14
• Reactive power = 15
• Apparent power = 16
• Power factor = 17
• Pressure = 18
• Frequency = 19
• Ppm concentration = 20
• Mass/volume concentration = 21
• AQI = 22
• People flow = 23
• People count = 24
• Reactive energy = 25
• Apparent energy = 26
• Location = 27

EndpointID (int) Unique identifier of the endpoint to which the alert corresponds. ### FacilityID (int) Unique identifier of the facility to which the alert corresponds. ### ClientID (int) Unique identifier of the client to which the alert corresponds. ### ConditionType (int enum)

The ConditionType property indicates the type of condition applied for comparison with the Threshold field value to trigger the alert. The possible values are as follows:

• Equal = 1: the alert will trigger when the reported value equals the value specified in the Threshold field.
• NotEqual = 2: the alert will trigger when the reported value differs from the value specified in the Threshold field.
• Greater = 3: the alert will trigger when the reported value is greater than the value specified in the Threshold field.
• GreaterOrEqual = 4: the alert will trigger when the reported value is greater than or equal to the value specified in the Threshold field.
• Lower = 5: the alert will trigger when the reported value is less than the value specified in the Threshold field.
• LowerOrEqual = 6: the alert will trigger when the reported value is less than or equal to the value specified in the Threshold field.

Threshold (double) Threshold used to activate the alert and generate the associated alarm. Used in conjunction with the ConditionType field. ### NormalConditionType (int enum)

The NormalConditionType property indicates the type of condition applied for comparison with the NormalThreshold field value to close the alert. The possible values are as follows:

• Equal = 1: the alert will close when the reported value equals the value specified in the NormalThreshold field.
• NotEqual = 2: the alert will close when the reported value differs from the value specified in the NormalThreshold field.
• Greater = 3: the alert will close when the reported value is greater than the value specified in the NormalThreshold field.
• GreaterOrEqual = 4: the alert will close when the reported value is greater than or equal to the value specified in the NormalThreshold field.
• Lower = 5: the alert will close when the reported value is less than the value specified in the NormalThreshold field.
• LowerOrEqual = 6: the alert will close when the reported value is less than or equal to the value specified in the NormalThreshold field.

NormalThreshold (double) Threshold used to return to the normal condition and deactivate the alert. Used in conjunction with the NormalConditionType field. ### MinimumDurationSeconds (int) Minimum amount of time (in seconds) that the condition must be maintained before activating the alert. ### NotificationEmails (array of string) List of email addresses to which notifications will be sent when the alert is activated or deactivated. ### NotificationSMSNumbers (array of string) List of phone numbers to which SMS notifications will be sent when the alert is activated or deactivated. ### NotificationVoiceNumbers (array of string) List of phone numbers to which voice notifications will be sent when the alert is activated or deactivated. ### Tags (array of string) List of tags associated with the alert. ### SequenceNumber (int64) Sequence number associated with the alert. The sequence number is updated with a higher number each time the alert is modified in any way, including when the alert is deleted. Each created or modified alert is guaranteed to receive a number higher than any other existing alert. ### Enabled (bool) Indicates whether the alert can be used, or if it has been deleted. The value false indicates that the alert has been deleted. Deleted alerts can only be accessed through the API for getting a list of alerts incrementally.