Obtenir une liste d'alarmes à l'aide de paramètres
Cette API permet de récupérer une liste d'alarmes à l'aide de paramètres.
Requête
GET /api/v2/alarms?clientID={clientID}&facilityID={facilityID}&deviceID={deviceID}&endpointID={deviceID}&maxCount={maxCount} HTTP/1.1
Host: gear.cloud.studio
Authorization: Bearer {accessToken}Paramètres
| Nom | Description |
|---|---|
| accessToken | Token d'accès disposant des permissions de lecture des informations d'alarme. Consultez cette page pour plus d'informations. Le token d'accès peut également être envoyé dans la chaîne de requête, au moyen du paramètre « accessToken ». |
| clientID | Identifiant facultatif indiquant que seules les alarmes du client indiqué doivent être récupérées. |
| facilityID | Identifiant facultatif indiquant que seules les alarmes de l'installation indiquée doivent être récupérées. |
| deviceID | Identifiant facultatif indiquant que seules les alarmes de l'appareil indiqué doivent être récupérées. |
| dateFrom | Date à partir de laquelle les alarmes de l'appareil indiqué doivent être récupérées. |
| dateTo | Date jusqu'à laquelle les alarmes de l'appareil indiqué doivent être récupérées. |
| endpointID | Identifiant facultatif indiquant que seules les alertes de l'endpoint indiqué doivent être récupérées. |
| state | Identifiant de l'état de l'alarme. Les valeurs possibles sont « open », « closed » et « all ». |
| maxCount | Paramètre facultatif indiquant le nombre maximal d'enregistrements à inclure dans le résultat. Les valeurs supérieures à 500 sont limitées à 500, quelle que soit la valeur envoyée dans la requête. |
| Il est obligatoire d'inclure un (et un seul) des paramètres « clientID », « facilityID », « deviceID » ou « endpointID ». |
|---|
Réponse
La réponse contient la liste des alarmes correspondantes, comme le montre cet exemple :
[
{
"AlarmID":1266896,
"DeviceID":7370,
"DeviceDescription":"Controlador RUPANCO",
"EndpointID":0,
"AlarmTypeID":1,
"AlarmTypeDescription":"Dispositivo fuera de línea",
"AlarmSeverityID":3,
"AlarmSeverityDescription":"Alta",
"Details":"",
"DateTimeCreated_UTC":"2021-10-15T17:34:35",
"DateTimeClosed_UTC":"2021-10-15T18:21:39",
"SequenceNumber":28885207,
"MTTRMinutes":47.0
},
{
"AlarmID":1266922,
"DeviceID":7370,
"DeviceDescription":"Controlador RUPANCO",
"EndpointID":0,
"AlarmTypeID":1,
"AlarmTypeDescription":"Dispositivo fuera de línea",
"AlarmSeverityID":3,
"AlarmSeverityDescription":"Alta",
"Details":"",
"DateTimeCreated_UTC":"2021-10-15T19:36:41",
"DateTimeClosed_UTC":"2021-10-15T19:37:23",
"SequenceNumber":28885384,
"MTTRMinutes":47.0
}
]Dernière mise à jour le
Obtenir une alarme à partir de son ID
Référence de l'API pour obtenir une alarme à partir de son ID : la requête, les paramètres comme accessToken et alarmID, et le format de réponse.
Obtenir une liste d'alarmes de manière incrémentale
Cette API récupère une liste d'alarmes de manière incrémentale, pour mettre à jour rapidement les alarmes ouvertes ou fermées sans récupérer toute la liste.