Alarm
Use the Alarm web service to create, list, or update alarms within your Remote Manager account. The maximum number of alarms per account is 16. When creating an alarm, you must specify an alarm template on which to base the alarm. See also the AlarmTemplate web service and Alarm template types.
URI
http://<hostname>/ws/Alarm
Formats
| HTTP method | Format | Description |
|---|---|---|
| GET | /ws/Alarm | Get a list of all alarms. |
| GET | /ws/Alarm/{almId} | Get details for a specific alarm. |
| POST | /ws/Alarm | Create a new alarm |
| PUT | /ws/Alarm/{almId} | Update an existing alarm. |
| DELETE | /ws/Alarm/{almId} | Delete an alarm. |
Elements
almId
Remote Manager identifier for the alarm.
cstId
Remote Manager identifier for the customer.
almtID
System-generated identifier for an alarm template. To get a list of available alarm template, use the AlarmTemplate web service.
grpId
Remote Manager identifier for the customer group.
almName
Name of the alarm.
almDescription
Description of the alarm.
almEnabled
Boolean value that indicates whether the alarm is enabled.
| Value | Description |
|---|---|
| true | Alarm is enabled. |
| false | Alarm is disabled. |
almPriority
Keyword that indicates the user-defined alarm priority: high, medium, or low.
almScopeConfig
Specifies the resource scope for the alarm. Scope options include:
| Scope | Description |
|---|---|
| Group | Applies the alarm to the specified group indicated by the full group path. |
| Device | Applies the alarm to the specified device ID. For example, 00000000-00000000-00000000-00000000. |
| XbeeNode | Applies the alarm to the specified XbeeNode extended address. For example, 00:13:A2:00:00:00:00:00. |
| Resource | Applies the alarm to a data stream path or pattern. You can use the wildcard charater asterisk () to match any element in the data stream path. For example, dia/channel//lth/temp matches all the lth temperature reading for all devices. |
| Global | Applies the alarm at the customer level to monitor all instances of an entity. For example, you can create an alarm to monitor the total number of web services calls for your account. This option is available for subscription usage alarms only. |
See almScopeConfig for the required XML structure for almScopeConfig.
almRuleConfig
Specifies the rule configurations for an alarm:
| Rule configuration | Description |
|---|---|
| FireRule | A list of variables that specify the condition for firing the alarm. |
| ResetRule | A list of variables that specify the condition for resetting the alarm. |
By default, all alarms reset automatically. You can disable automatic reset by passing the enabled = false attribute for the ResetRule element. For example, <ResetRule enabled = "false">.
See almRuleConfig for the required XML structure for almRuleConfig.
See Alarm template types for a list of available fire and reset variables for each alarm template type.