Get an alarm by its ID
This API allows retrieving an alarm by its ID.
Request
GET /api/v2/alarms/{alarmID} HTTP/1.1
Host: gear.cloud.studio
Authorization: Bearer {accessToken}Parameters
| Name | Description |
|---|---|
| accessToken | Access token with permissions to read alarm information. See this page for more information. The access token can also be sent as part of the query string, using the "accessToken" parameter. |
| alarmID | Unique identifier of the alarm for which information is requested. |
Response
The response contains the specified alarm, as shown in this example:
{
"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
}Última atualização em
Alarm data type
Introduction The alarm data type allows obtaining alarm information. Below are all the properties of the alarm data type.
Get a list of alarms using parameters
API reference for getting a list of alarms filtered by client, facility, device, endpoint, state or date range, up to a maximum count.