View a subscription created by a REST API client

Use this page to view a subscription that was created by a REST API client. By creating subscriptions, you can monitor entities and be notified of changes to them.

You can access the REST API subscription page in either of the following ways:

• Click My Service Registry > My Subscriptions > subscription_name to open an existing subscription. The My Subscriptions collection is based on the user ID of the user who is currently logged in, and is therefore empty if security is disabled. In this case, switch to the Administrator perspective and click My Service Registry > All Subscriptions > subscription_name.

• For Administrators only, if security is enabled, click My Service Registry > All Subscriptions > subscription_name to open an existing subscription.

• Click My Service Registry > My Subscriptions in the navigation tree, if you have this displayed, and then click subscription_name to open an existing subscription. The My Subscriptions collection is based on the user ID of the user who is currently logged in, and is therefore empty if security is disabled. In this case, switch to the Administrator perspective and click My Service Registry > All Subscriptions > subscription_name.

• For Administrators only, if security is enabled, click My Service Registry > All Subscriptions in the navigation tree and click subscription_name to open an existing subscription.

A subscription contains the following details.

Name

Specifies the name of the subscription.

Description

Specifies the user-provided description of the subscription.

Owner

Specifies the user ID of the current owner of this subscription. Typically, this field contains the ID of the user who created the subscription initially.

Destination address type

Specifies the destination address type for subscription notification messages. This field identifies the type of subscription notifier plug-in that processes the subscription notifications.

Destination address

Specifies the destination address for subscription notification messages. The format of the address is specific to the type of notifier plug-in displayed in the destination address type field.

Subscription expiry duration

Specifies the duration of the subscription in days, after which the subscription object is automatically deleted.

Correlation ID

A unique string that is sent in the event notification message, and which is used by the client to correlate the messages that are generated from this subscription.

Batch notification mode

This field is set to "true" if a notifier for this subscription sends notifications to the target endpoint in "batch" mode. This mode means that multiple notifications are sent in a single message to optimize notification message flow.

Target bsrUri

Specifies a unique object bsrUri that must match a target object for a notification to occur.

Target name

Specifies a unique object name that must match a target object for a notification to occur.

Target namespace

Specifies a unique object namespace string that must match a target object for a notification to occur.

Target version

Specifies a unique object version string that must match a target object for a notification to occur.

Target query

Specifies an XPath query expression that must match a target object for a notification to occur.

Classifications

Specifies the list of classifications that must be present for the notification to occur. All selected classifications must be present.

Notify policy updates

This field is set to "true" if an event notification message is generated when a user operation takes place on a policy that is attached to a subscribed object.

Notify monitoring policy updates

This field is set to "true" if an event notification message is generated when a user operation takes place on a policy, and that policy is attached to a Service Level Agreement applied to a WSDL document that is a subscribed object.

Notify saved search result changes

If this field is set to "true", and the target objects defined in the subscription include a Saved Search, a Named Query, or both, notifications are sent for any objects that are returned by running the query, if those objects satisfy all of the match criteria defined in the subscription.

Referenced object match depth

The object graph depth for which notifications are sent. If the value is non-zero then notifications are sent not only for the target objects specified in the subscription definition, but also for any other objects referenced from the target objects, to the specified graph depth.

For example, if the value is "1", and the target attributes match a Concept object, a notification is sent if a user changes a WSDL document that is referenced by the Concept object.

If the value is "-1", notifications are sent for the entire referenced graph.

If the value is "0", notifications are sent only for the target object.

Operations

The operations that generate events that trigger a notification; these are Create, Update, Delete, Validate, Make governable, Remove governance and Transition. The transition operation can be further qualified by selecting the transitions to monitor from the Transitions list; the list of transitions is generated from the currently installed governance lifecycle.

Transitions

Specifies the transitions that are monitored.

Preferred notification message language

Specifies the language in which you want to receive notification messages.