Introduction
This page covers the ICD-001 Acknowledge Alarm Command.
Contents
...
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
...
| Info |
|---|
Optional attributes are formatted in italics and highlighted with an asterisk. |
Attributes | Description | Type | Notes |
MsgId | Unique message Id | Long | This must be globally unique across all message types |
MsgTimeStamp | Date and time that the message was sent | DateTime | |
AlarmId | Id of the alarm instance which needs acknowledgement | Integer | This is the alarm Id that appears on all ICD-001 Alarm Reports. |
UserName* | The user name of the operator or identifier of the external system that is initiating the acknowledgement (optional) | String | |
Notes* | Any notes or descriptions associated with the alarm acknowledgement that need to be stored with the alarm (optional) | String | This can be used to send any actions or notes associated with the alarm. These notes can be accessed when reviewing alarm details in Witness. |
| Info |
|---|
If the alarm is still active or the alarm Id you have provided does not match with any pending alarms then this command will return a failure status. |
...
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|
...