White Papers
OpenManage Essentials-Specific Resource Model
39 REST API Guide–OpenManage Essentials
The attributes associated with the alert subscription is described here:
Attribute Name
Description
Id
The unique identifier for the subscription.
IdSubscriberService
The enumerated type or identifier of the subscription service. This enables
association with the correct notification mechanism.
UserName
The user name of the subscriber.
Description
The description of the subscriber (for example, mobile device model).
IsEnabled
A flag indicating whether this subscription is enabled or disabled.
AlertFilterId
The filter identifier associated with the subscription.
Token
A string that provides information about the subscriber (for example, address or
device token).
The numbers for the various subscriber services are listed in the following table. As of OpenManage
Essentials version 1.3, only Google Cloud is supported.
IdSubscriberService
number
Description
1
Google Cloud
2.9.1 AlertSubscription GET command
To get the associated subscription that is assigned to a mobile device, you must specify the device ID that is
associated to the particular device. The GET command suffix is as follows:
/AlertSubscriptions/<deviceId>
2.9.2 AlertSubscription DELETE command
Deletion of the subscription (or unsubscribe) is accomplished using the standard HTTP DELETE operation.
Note: For the DELETE operation, you have to provide the DeviceId value to the alert subscription that you want to
delete.
2.9.3 AlertSubscription POST example Data
The payload for the POST command is an XML structure that defines the various fields that are needed to
create an Alert Subscription.
Note: All the values in the payload are case sensitive.
Of particular importance are Boolean values such as the <IsEnabled> included in the following example. This
type of attribute takes the values of ‘true’ or ‘false’ in lower case. Any other value, including ‘True’ and ‘False’
will create an invalid data error when posting.
<RESTSubscription>
<IdDevice>sshiphone4</IdDevice>
<IdSubscriberService>1</IdSubscriberService>
<UserName>SteveHeracleous</UserName>
<IsEnabled>true</IsEnabled>
<AlertFilterId>1006921498</AlertFilterId>
<Token>Token16</Token>
<Description>REST POST subscription creation</Description>