Obtenir une liste d'alertes en utilisant des paramètres
Cette API permet de récupérer une liste d'alertes en utilisant des paramètres.
Requête
GET /api/v2/alerts?clientID={clientID}&facilityID={facilityID}&deviceID={deviceID}&endpointID={endpointID}&maxCount={maxCount} HTTP/1.1
Host: gear.cloud.studio
Authorization: Bearer {accessToken}Paramètres
| Nom | Description |
|---|---|
| accessToken | Token d'accès avec les permissions de lecture des informations d'alerte. Consultez cette page pour plus d'informations. Le token d'accès peut également être envoyé dans la chaîne de requête en utilisant le paramètre « accessToken ». |
| clientID | Identifiant optionnel indiquant que seules les alertes du client donné doivent être récupérées. |
| facilityID | Identifiant optionnel indiquant que seules les alertes de l'installation donnée doivent être récupérées. |
| deviceID | Identifiant optionnel indiquant que seules les alertes de l'appareil donné doivent être récupérées. |
| endpointID | Identifiant optionnel indiquant que seules les alertes de l'endpoint donné doivent être récupérées. |
| maxCount | Paramètre optionnel indiquant le nombre maximum d'alertes à inclure dans le résultat. |
| 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 alertes correspondantes, comme montré dans cet exemple :
[
{
"AlertID": 211,
"VariableTypeID": 1,
"EndpointID": 114092,
"ConditionType": 3,
"Threshold": 25,
"ClientID": 4,
"FacilityID": 184,
"NormalConditionType": 6,
"NormalThreshold": 24,
"MinimumDurationSeconds": 300,
"NotificationEmails": ["someone@somewhere.com"],
"NotificationSMSNumbers": ["+1123456789"],
"NotificationVoiceNumbers": ["+1123456789"],
"Tags": ["default", "gateway-default"],
"SequenceNumber": 45701485,
"Enabled": true,
"Schedules": [],
"Timezone": {
"CurrentOffsetMinutes": -180,
"TimeZoneCode": "america/argentina/buenos_aires"
}
},
{
"AlertID": 212,
"VariableTypeID": 1,
"EndpointID": 114092,
"ConditionType": 5,
"Threshold": 20,
"ClientID": 4,
"FacilityID": 184,
"NormalConditionType": 3,
"NormalThreshold": 22,
"MinimumDurationSeconds": 300,
"NotificationEmails": ["someone@somewhere.com"],
"NotificationSMSNumbers": ["+1123456789"],
"NotificationVoiceNumbers": ["+1123456789"],
"Tags": ["default", "gateway-default"],
"SequenceNumber": 45701485,
"Enabled": true,
"Schedules": [
{
"Days": [
1,
2,
4,
5
],
"StartTime": {
"Hour": 0,
"Millisecond": 0,
"Minute": 0,
"Second": 0
},
"EndTime": {
"Hour": 23,
"Millisecond": 999,
"Minute": 0,
"Second": 59
}
}
],
"Timezone": {
"CurrentOffsetMinutes": -180,
"TimeZoneCode": "america/argentina/buenos_aires"
}
}
]Obtenir une alerte par son ID
Cette API permet de récupérer une alerte par son ID. Requête GET /api/v2/alerts/{alertID} HTTP/1.1 Host: gear.cloud.studio Authorization: Bearer {accessToken}...
Obtenir une liste d'alertes de manière incrémentale
Cette API permet de récupérer une liste d'alertes de manière incrémentale. Cela permet des mises à jour rapides des alertes à mesure qu'elles sont créées, modifiées ou supprimées, sans avoir besoin de récupérer la liste complète.