Alarm data type

Introduction

The alarm data type allows obtaining alarm information. Below are all the properties of the alarm data type.

Properties

### AlarmID (int) The AlarmID property represents the unique identifier of the alarm in the platform. This identifier is automatically assigned when an alarm is created. ### DeviceID (int) The DeviceID property represents the unique identifier of the device that triggers the alarm. ### EndpointID (int) Unique identifier of the endpoint to which the alert corresponds. ### AlarmTypeID (int) The AlarmTypeID property indicates the type of alarm. ### AlarmTypeDescription (string) Description of the alarm type. Used only for listing or enumeration. ### AlarmSeverityID (int)

Indicates the severity of the alarm. Corresponds to one of the following values:

• Information = 0: Informational, no severity;
• Low = 1: Low alarm severity;
• Medium = 2: Medium severity;
• High = 3: Critical alarm, high severity.

### AlarmSeverityDescription (string) Description of the alarm severity. ### Details (string) Details associated with the alarm. ### DateTimeCreated_UTC (string) Date and time of alarm creation (UTC) in String format. ### DateTimeClosed_UTC (string) Date and time of alarm closure (UTC) in String format. ### SequenceNumber (long) Sequence number associated with the alarm. The sequence number is updated with a higher number each time the alarm is modified in any way, including when it is closed. Each alarm is guaranteed to receive a number higher than any other.