AlarmStatus
Use the AlarmStatus web service to retrieve the current status of one or more alarms or to update the status of an alarm.
URI
http://<hostname>/ws/AlarmStatus
Formats
| HTTP method | Format | Description |
|---|---|---|
| GET | /ws/AlarmStatus | Get statuses for all current alarms. |
| GET | /ws/AlarmStatus/{almId} | Get statuses for a specific alarm. |
| PUT | /ws/AlarmStatus/{almId}/{almsSourceEntityId} | Update the alarm status. |
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
System-generated identifier assigned to a 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.