AlarmStatusHistory
Use the AlarmStatusHistory web service to retrieve a record of alarm statuses over time.
URI
http://<hostname>/ws/AlarmStatusHistory
Formats
| HTTP method | Format | Description |
|---|---|---|
| GET | /ws/AlarmStatusHistory | Get a list of all alarm statuses over time. |
| GET | /ws/AlarmStatusHistory/{almId} | Get a list of alarm statuses over time for a specific alarm. |
Elements
id
Unique identifier for the alarm status that consists of two elements:
| ID Element | Description |
|---|---|
| almId | System-generated identifier for the alarm. |
| almsSourceEntityId | System-generated identifier for the entity associated with the alarm status, such as a device or task. |
almsStatus
Current status of the alarm:
| Status value | Description |
|---|---|
| 0 | Alarm is reset. |
| 1 | Alarm is triggered. |
| 2 | Alarm is acknowledged. |
almsTopic
Topic for the alarm.
cstId
Remote Manager identifier for the customer.
almsUpdateTime
Time at which the alarm status was last updated (ISO 8601 standard format).
almsPayload
Payload associated with the status change for the alarm in XML format. The payload can be any event object in the system that caused the status of the alarm to change. Typically, the payload is a web services object, such as a monitor or device core object.
Query parameters
size
Number of resources to return for a GET request. Allowable value is a number from 1 to 1000. The default is 1000.
pageCursor
Page cursor that was returned from a previous request that can be used to retrieve the next page of data.
startTime
Start time (inclusive) for the status history you want to retrieve.
endTime
End time (exclusive) for the status history you want to retrieve.
order
Sort order for the retrieved data: asc for ascending or desc for descending.