Aller au contenu principal
CloudStudio
API d'extraction de donnéesAlertes

Type de données Alert

Introduction

Le type de données alert permet d'obtenir la configuration d'une alerte. Voici toutes les propriétés du type de données alert.

Propriétés

AlertID (int) La propriété AlertID représente l'identifiant unique de l'alerte dans la plateforme. Cet identifiant est attribué automatiquement lors de la création d'une alerte. ### VariableTypeID (int enum)

La propriété VariableTypeID indique le type de variable associé à l'alerte. Pour les variables définies par l'utilisateur, l'ID est toujours supérieur ou égal à 1000. Pour les types de variables prédéfinis de la plateforme, les valeurs sont les suivantes :

  • Température = 1
  • Humidité = 2,
  • Niveau de luminosité = 3
  • Consigne = 4
  • Volume = 5
  • Énergie active = 6
  • Durée de fonctionnement = 7
  • État de capteur discret = 8
  • Gradation = 9
  • Poids = 10
  • Débit = 11
  • Tension = 12
  • Courant = 13
  • Puissance active = 14
  • Puissance réactive = 15
  • Puissance apparente = 16
  • Facteur de puissance = 17
  • Pression = 18
  • Fréquence = 19
  • Concentration en ppm = 20
  • Concentration masse/volume = 21
  • AQI = 22
  • Flux de personnes = 23
  • Nombre de personnes = 24
  • Énergie réactive = 25
  • Énergie apparente = 26
  • Localisation = 27

EndpointID (int) Identifiant unique de l'endpoint auquel correspond l'alerte. ### FacilityID (int) Identifiant unique de l'installation à laquelle correspond l'alerte. ### ClientID (int) Identifiant unique du client auquel correspond l'alerte. ### ConditionType (int enum)

La propriété ConditionType indique le type de condition appliqué pour la comparaison avec la valeur du champ Threshold afin de déclencher l'alerte. Les valeurs possibles sont les suivantes :

  • Equal = 1 : l'alerte se déclenche lorsque la valeur signalée est égale à la valeur indiquée dans le champ Threshold.
  • NotEqual = 2 : l'alerte se déclenche lorsque la valeur signalée est différente de la valeur indiquée dans le champ Threshold.
  • Greater = 3 : l'alerte se déclenche lorsque la valeur signalée est supérieure à la valeur indiquée dans le champ Threshold.
  • GreaterOrEqual = 4 : l'alerte se déclenche lorsque la valeur signalée est supérieure ou égale à la valeur indiquée dans le champ Threshold.
  • Lower = 5 : l'alerte se déclenche lorsque la valeur signalée est inférieure à la valeur indiquée dans le champ Threshold.
  • LowerOrEqual = 6 : l'alerte se déclenche lorsque la valeur signalée est inférieure ou égale à la valeur indiquée dans le champ Threshold.

Threshold (double) Seuil utilisé pour activer l'alerte et générer l'alarme associée. S'utilise conjointement avec le champ ConditionType. ### NormalConditionType (int enum)

La propriété NormalConditionType indique le type de condition appliqué pour la comparaison avec la valeur du champ NormalThreshold afin de fermer l'alerte. Les valeurs possibles sont les suivantes :

  • Equal = 1 : l'alerte se ferme lorsque la valeur signalée est égale à la valeur indiquée dans le champ NormalThreshold.
  • NotEqual = 2 : l'alerte se ferme lorsque la valeur signalée est différente de la valeur indiquée dans le champ NormalThreshold.
  • Greater = 3 : l'alerte se ferme lorsque la valeur signalée est supérieure à la valeur indiquée dans le champ NormalThreshold.
  • GreaterOrEqual = 4 : l'alerte se ferme lorsque la valeur signalée est supérieure ou égale à la valeur indiquée dans le champ NormalThreshold.
  • Lower = 5 : l'alerte se ferme lorsque la valeur signalée est inférieure à la valeur indiquée dans le champ NormalThreshold.
  • LowerOrEqual = 6 : l'alerte se ferme lorsque la valeur signalée est inférieure ou égale à la valeur indiquée dans le champ NormalThreshold.

NormalThreshold (double) Seuil utilisé pour revenir à la condition normale et désactiver l'alerte. S'utilise conjointement avec le champ NormalConditionType. ### MinimumDurationSeconds (int) Durée minimale (en secondes) pendant laquelle la condition doit se maintenir avant l'activation de l'alerte. ### NotificationEmails (array of string) Liste des adresses e-mail auxquelles des notifications sont envoyées lorsque l'alerte est activée ou désactivée. ### NotificationSMSNumbers (array of string) Liste des numéros de téléphone auxquels des notifications SMS sont envoyées lorsque l'alerte est activée ou désactivée. ### NotificationVoiceNumbers (array of string) Liste des numéros de téléphone auxquels des notifications vocales sont envoyées lorsque l'alerte est activée ou désactivée. ### Tags (array of string) Liste des tags associés à l'alerte. ### SequenceNumber (int64) Numéro de séquence associé à l'alerte. Le numéro de séquence est mis à jour avec un numéro plus élevé chaque fois que l'alerte est modifiée de quelque manière que ce soit, y compris lors de sa suppression. Chaque alerte créée ou modifiée reçoit obligatoirement un numéro supérieur à celui de toutes les autres alertes existantes. ### Enabled (bool) Indique si l'alerte peut être utilisée ou si elle a été supprimée. La valeur false indique que l'alerte a été supprimée. Les alertes supprimées ne sont accessibles que via l'API destinée à obtenir une liste d'alertes de manière incrémentale.

Dernière mise à jour le

Alertes

Comment interroger par l'API les alertes définies dans Gear Studio, c'est-à-dire les conditions qui génèrent des alarmes, par ID ou par paramètres.

Obtenir une alerte à partir de son ID

Référence de l'API pour obtenir une alerte à partir de son ID : la requête, les paramètres comme accessToken et alertID, et le format de réponse.

Sur cette page

IntroductionPropriétésAlertID (int) La propriété AlertID représente l'identifiant unique de l'alerte dans la plateforme. Cet identifiant est attribué automatiquement lors de la création d'une alerte. ### VariableTypeID (int enum)EndpointID (int) Identifiant unique de l'endpoint auquel correspond l'alerte. ### FacilityID (int) Identifiant unique de l'installation à laquelle correspond l'alerte. ### ClientID (int) Identifiant unique du client auquel correspond l'alerte. ### ConditionType (int enum)Threshold (double) Seuil utilisé pour activer l'alerte et générer l'alarme associée. S'utilise conjointement avec le champ ConditionType. ### NormalConditionType (int enum)NormalThreshold (double) Seuil utilisé pour revenir à la condition normale et désactiver l'alerte. S'utilise conjointement avec le champ NormalConditionType. ### MinimumDurationSeconds (int) Durée minimale (en secondes) pendant laquelle la condition doit se maintenir avant l'activation de l'alerte. ### NotificationEmails (array of string) Liste des adresses e-mail auxquelles des notifications sont envoyées lorsque l'alerte est activée ou désactivée. ### NotificationSMSNumbers (array of string) Liste des numéros de téléphone auxquels des notifications SMS sont envoyées lorsque l'alerte est activée ou désactivée. ### NotificationVoiceNumbers (array of string) Liste des numéros de téléphone auxquels des notifications vocales sont envoyées lorsque l'alerte est activée ou désactivée. ### Tags (array of string) Liste des tags associés à l'alerte. ### SequenceNumber (int64) Numéro de séquence associé à l'alerte. Le numéro de séquence est mis à jour avec un numéro plus élevé chaque fois que l'alerte est modifiée de quelque manière que ce soit, y compris lors de sa suppression. Chaque alerte créée ou modifiée reçoit obligatoirement un numéro supérieur à celui de toutes les autres alertes existantes. ### Enabled (bool) Indique si l'alerte peut être utilisée ou si elle a été supprimée. La valeur false indique que l'alerte a été supprimée. Les alertes supprimées ne sont accessibles que via l'API destinée à obtenir une liste d'alertes de manière incrémentale.