Saltar al contenido principal
CloudStudio

Obtener una lista de alarmas utilizando parámetros

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

Request

GET /api/v2/alarms?clientID={clientID}&facilityID={facilityID}&deviceID={deviceID}&endpointID={deviceID}&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 alarmas. 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 alarmas para el cliente dado.
facilityIDIdentificador opcional indicando que sólo se desea obtener la lista de alarmas para el facility dado.
deviceIDIdentificador opcional indicando que sólo se desea obtener la lista de alarmas para el dispositivo dado.
dateFromFecha a partir de la cual se desea obtener la lista de alarmas para el dispositivo dado.
dateToFecha hasta la cual se desea obtener la lista de alarmas para el dispositivo dado.
endpointIDIdentificador opcional indicando que sólo se desea obtener la lista de alertas para el endpoint dado.
stateIdentificador del estado de la alarma. Los valores posibles son “open”, “closed” y “all”.
maxCountParámetro opcional indicando la cantidad máxima de registros a incluir en el resultado, valores superiores a 500 se limitan a 500 independientemente del valor enviado en el request.
Es obligatorio incluir uno (y sólo uno) de los parámetros “clientID”, “facilityID”, “deviceID”, o “endpointID”.

Response

La respuesta contiene la lista de alarmas buscadas, como se muestra en este ejemplo:

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

Última actualización

En esta página