SoftLayer_Notification_Preference


SoftLayer_Notification_Preference

Description

Retrieve details for preferences. Preferences are used to allow the subscriber to modify their subscription in various ways. Details such as friendly name, keyname maximum and minimum values can be retrieved. These provide details to help configure subscriber preferences correctly.

Local

description
A description of what the preference is used for.
Type:

string

id
Unique identifier for the notification preference.
Type:

integer

keyName
Name that can be used by external systems to refer to preference.
Type:

string

maximumValue
Largest value allowed for the preference.
Type:

string

minimumValue
Smallest value allowed for the preference.
Type:

string

name
Friendly name for the notification.
Type:

string

units
The unit of measure used for the preference's value, minimum and maximum as well.
Type:

string

value
Default value used when setting up preferences for a new subscriber.
Type:

string