Saltar al contenido principal
CloudStudio

Obtener una lista de alertas utilizando parámetros

Esta API permite obtener una lista de alertas, utilizando parámetros.

Request

GET /api/v2/alerts?clientID={clientID}&facilityID={facilityID}&deviceID={deviceID}&endpointID={endpointID}&maxCount={maxCount} HTTP/1.1
Host: gear.cloud.studio
Authorization: Bearer {accessToken}

Parámetros

NombreDescripción
accessTokenToken de acceso con permisos para leer información de alertas. Vea esta página para más información. El access token también puede enviarse como parte del query string, utilizando el parámetro “accessToken”.
clientIDIdentificador opcional indicando que sólo se desea obtener la lista de alertas para el cliente dado.
facilityIDIdentificador opcional indicando que sólo se desea obtener la lista de alertas para el facility dado.
deviceIDIdentificador opcional indicando que sólo se desea obtener la lista de alertas para el dispositivo dado.
endpointIDIdentificador opcional indicando que sólo se desea obtener la lista de alertas para el endpoint dado.
maxCountParámetro opcional indicando la cantidad máxima de alertas a incluir en el resultado.
Es obligatorio incluir uno (y sólo uno) de los parámetros “clientID”, “facilityID”, “deviceID”, o “endpointID”.

Response

La respuesta contiene la lista de alertas buscada, como se muestra en este ejemplo:

[
	{
		"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"
        }
	}
]

Última actualización

En esta página