Obtenir une liste d'alertes à l'aide de paramètres
Cette API permet de récupérer une liste d'alertes à l'aide de 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 disposant des 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, au moyen du paramètre « accessToken ». |
| clientID | Identifiant facultatif indiquant que seules les alertes du client indiqué doivent être récupérées. |
| facilityID | Identifiant facultatif indiquant que seules les alertes de l'installation indiquée doivent être récupérées. |
| deviceID | Identifiant facultatif indiquant que seules les alertes 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. |
| maxCount | Paramètre facultatif indiquant le nombre maximal 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 le montre 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"
}
}
]Dernière mise à jour le
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.
Obtenir une liste d'alertes de manière incrémentale
Cette API récupère une liste d'alertes de manière incrémentale, pour suivre vite les alertes créées, modifiées ou supprimées sans récupérer toute la liste.