alarm
Represents the content of an alarm.
XML
Elements
| name (type) |
min/max
occurs |
description |
|
alarmId (long)
|
1/1 |
Alarm identifier generated by the system.
|
|
name (string)
|
0/1 |
Alarm name.
|
|
catergory (string)
|
0/1 |
Alarm category.
|
|
severity (string)
|
0/1 |
Alarm severity (CRITICAL, MAJOR, MINOR, INFO).
|
|
state (string)
|
0/1 |
Alarm state (ACTIVE, CLEAR)
|
|
ack (boolean)
|
1/1 |
Indicates if the alarm has been acknowledged.
|
|
entityId (string)
|
0/1 |
Alarm entityID.
|
|
source (string)
|
0/1 |
Source address of the device that generated the alarm, if available.
|
|
reportingDevice (string)
|
0/1 |
Address of the device that reported the alarm, if available.
|
|
creationTime (string)
|
0/1 |
Time the alarm was generated.
|
|
lastUpdated (string)
|
0/1 |
The most recent time the alarm was updated.
|
|
updatedBy (string)
|
0/1 |
Indicate the party that updated the alarm most recently, if available.
|
JSON
| property |
type |
description |
| alarmId |
alarmId (long)
|
Alarm identifier generated by the system.
|
| name |
name (string)
|
Alarm name.
|
| catergory |
catergory (string)
|
Alarm category.
|
| severity |
severity (string)
|
Alarm severity (CRITICAL, MAJOR, MINOR, INFO).
|
| state |
state (string)
|
Alarm state (ACTIVE, CLEAR)
|
| ack |
ack (boolean)
|
Indicates if the alarm has been acknowledged.
|
| entityId |
entityId (string)
|
Alarm entityID.
|
| source |
source (string)
|
Source address of the device that generated the alarm, if available.
|
| reportingDevice |
reportingDevice (string)
|
Address of the device that reported the alarm, if available.
|
| creationTime |
creationTime (string)
|
Time the alarm was generated.
|
| lastUpdated |
lastUpdated (string)
|
The most recent time the alarm was updated.
|
| updatedBy |
updatedBy (string)
|
Indicate the party that updated the alarm most recently, if available.
|