Property | Type | Description | Mandatory |
|---|---|---|---|
deviceId | String | The unique identifier of the Device on which the AlarmInstance occurred. | Y |
typeCode | Integer | The typeCode of the event that triggered the AlarmInstance. See Defining a Device Event Manifest for more information. | Y |
value | String | The value of the Event that triggered the AlarmInstance. | Y |
readingDateTime | DateTime | The timestamp of the Event (reading) that triggered the Alarm. | |
readingDateTimeOffset | DateTimeOffset | Same as readingDateTime with a different date structure. | Y |
ruleId | String | The unique identifier of the Rule that created this AlarmInstance when its conditions were met. | Y |
eventName | String | The name of the Event that triggered the Alarm. | |
severity | String/Enum | The severity defined by the Rule: • Warning • Minor • Major • Critical | Y |
status | String/Enum | The status of the AlarmInstance: • Open • Closed After an AlarmInstance is triggered by a Rule, its status is Open (0). An AlarmInstance can then be Closed (1) in the IoT Platform Portal or through the API. | Y |
snoozeExpirationDate | DateTime | Until this date has passed, the Rule does not send repeat notifications. This initial recurrence is described in the Rule in the actions/ruleRecurrenceSettings/repeatFrequency property. | |
message | String | A free-text message describing what occurred. For example, Temperature Is Too High. | |
appId | String | A unique Application identifier that is automatically generated by IoT Platform . This is the identifier of the Application to which this AlarmInstance is assigned. This identifier is automatically generated by IoT Platform when the Applications/Post request is used. | Y |