AlarmTemplate
Use the AlarmTemplate web service to retrieve information about available alarm types within your Remote Manager host.
URI
http://<hostname>/ws/AlarmTemplate
Formats
| HTTP method | Format | Description |
|---|---|---|
| GET | /ws/AlarmTemplate | Get a list of all available alarm templates. |
Elements
almtID
System-generated identifier for an alarm template. To get a list of available alarm template, use the AlarmTemplate web service.
almtName
Name of the alarm template.
almtDescription
Description of the alarm template.
grpId
Remote Manager identifier for the customer group.
almtTopic
Topic for the alarm template.
almtScopeOptions
Specifies the resource scope for the alarm template. 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. For example, 00000000-00000000-00000000-00000000. |
| XbeeNode | Applies the alarm to the specified XbeeNode, expressed as the 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 almtScopeOptions for the required XML structure for almtScopeOptions.
almtRules
Specifies the rule configurations for the alarm template:
| 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. |
See almtRules for the required XML structure for almtRules.
See Alarm template types for a list of available fire and reset variables for each alarm template type.