Subscription

Class Description

Holds the information related to a client subscription to receive updates to a resource automatically.

Attributes

NameTypeDescription
encodingUInt80 - application/sep+xml 1 - application/sep-exi 2-255 - reserved
levelString16Contains the preferred schema and extensibility level indication such as "+S1"
limitUInt32This element is used to indicate the maximum number of list items that should be included in a notification when the subscribed resource changes. This limit is meant to be functionally equivalent to the ‘limit’ query string parameter, but applies to both list resources as well as other resources. For list resources, if a limit of ‘0’ is specified, then notifications SHALL contain a list resource with results=’0’ (equivalent to a simple change notification). For list resources, if a limit greater than ‘0’ is specified, then notifications SHALL contain a list resource with results equal to the limit specified (or less, should the list contain fewer items than the limit specified or should the server be unable to provide the requested number of items for any reason) and follow the same rules for list resources (e.g., ordering). For non-list resources, if a limit of ‘0’ is specified, then notifications SHALL NOT contain a resource representation (equivalent to a simple change notification). For non-list resources, if a limit greater than ‘0’ is specified, then notifications SHALL contain the representation of the changed resource.
notificationURIanyURIThe resource to which to post the notifications about the requested subscribed resource. Because this URI will exist on a server other than the one being POSTed to, this attribute SHALL be a fully-qualified absolute URI, not a relative reference.

Relationships

Inherits from

Descendant classes

  • No descendant classes

Associations

Source ClassCardinality SourceTarget ClassCardinality Target
SubscriptionCondition0..1
SubscriptionListSubscription0..*