Tipo de datos alert

Introducción

El tipo de datos alert permite obtener la configuración de una alerta. A continuación se describen todas las propiedades del tipo de datos alert.

Propiedades

### AlertID (int) La propiedad AlertID representa el identificador único de la alerta en la plataforma. Este identificador es asignado automáticamente cuando se crea una alerta. ### VariableTypeID (int enum)

La propiedad VariableTypeID indica el tipo de variable asociado con la alerta. Para variables definidas por el usuario, el ID es siempre igual o mayor a 1000. Para los tipos de variable predefinidos en la plataforma, los valores son los siguientes:

• 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) Identificador único del endpoint al que corresponde la alerta. ### FacilityID (int) Identificador único del facility al que corresponde la alerta. ### ClientID (int) Identificador único del cliente al que corresponde la alerta. ### ConditionType (int enum)

La propiedad ConditionType indica el tipo de condición que se aplica para comparar con el valor del campo Threshold para disparar la alerta. Los valores posibles son los siguientes:

• Equal = 1: la alerta se disparará cuando el valor reportado sea igual al indicado en el campo Threshold.
• NotEqual = 2: la alerta se disparará cuando el valor reportado sea diferente al indicado en el campo Threshold.
• Greater = 3: la alerta se disparará cuando el valor reportado sea mayor al indicado en el campo Threshold.
• GreaterOrEqual = 4: la alerta se disparará cuando el valor reportado sea mayor o igual al indicado en el campo Threshold.
• Lower = 5: la alerta se disparará cuando el valor reportado sea menor al indicado en el campo Threshold.
• LowerOrEqual = 6: la alerta se disparará cuando el valor reportado sea menor o igual al indicado en el campo Threshold.

### Threshold (double) Umbral utilizado para activar la alerta y generar la alarma asociada. Se utiliza junto con el campo ConditionType. ### NormalConditionType (int enum)

La propiedad NormalConditionType indica el tipo de condición que se aplica para comparar con el valor del campo NormalThreshold para cerrar la alerta. Los valores posibles son los siguientes:

• Equal = 1: la alerta se cerrará cuando el valor reportado sea igual al indicado en el campo NormalThreshold.
• NotEqual = 2: la alerta se cerrará cuando el valor reportado sea diferente al indicado en el campo NormalThreshold.
• Greater = 3: la alerta se cerrará cuando el valor reportado sea mayor al indicado en el campo NormalThreshold.
• GreaterOrEqual = 4: la alerta se cerrará cuando el valor reportado sea mayor o igual al indicado en el campo NormalThreshold.
• Lower = 5: la alerta se cerrará cuando el valor reportado sea menor al indicado en el campo NormalThreshold.
• LowerOrEqual = 6: la alerta se cerrará cuando el valor reportado sea menor o igual al indicado en el campo NormalThreshold.

### NormalThreshold (double) Umbral utilizado para volver a la condición normal y desactivar la alerta. Se utiliza junto con el campo NormalConditionType. ### MinimumDurationSeconds (int) Cantidad mínima de tiempo (en segundos) que debe mantenerse la condición antes de activar la alerta. ### NotificationEmails (array of string) Lista de direcciones de e-mail a las que se enviarán notificaciones cuando la alerta se active o desactive. ### NotificationSMSNumbers (array of string) Lista de números de teléfono a los que se enviarán notificaciones por SMS cuando la alerta se active o desactive. ### NotificationVoiceNumbers (array of string) Lista de números de teléfono a los que se enviarán notificaciones de voz cuando la alerta se active o desactive. ### Tags (array of string) Lista de tags asociadas a la alerta. ### SequenceNumber (int64) Número de secuencia asociado a la alerta. El número de secuencia se actualiza con un número mayor cada vez que la alerta se modifica de cualquier manera, incluso cuando la alerta se elimina. Se garantiza que cada alerta creada o modificada recibirá un número mayor al de cualquier otra alerta existente. ### Enabled (bool) Indica si la alerta puede utilizarse, o si ha sido eliminada. El valor false indica que la alerta ha sido eliminada. Sólo es posible acceder a alertas eliminadas a través de la API para obtener una lista de alertas en forma incremental.