Response body attributes for subscriptions

When you use the HTTP GET method with the subscription object to request information about subscriptions, the following attributes are returned within named JSON objects.

The following objects are available:

topic
selector
destination
user
general
extended
timestamps

For more information about the PCF equivalents to the subscription REST API parameters and attributes, see REST API and PCF equivalents for subscriptions.

topic

The topic object contains attributes that are related to a defined topic.

name: String.; Specifies the name of a previously defined topic object from which the topic string prefix is obtained for the subscription.
definedString: String.; Specifies the topic string that contains the application part of the topic string only.

selector

The selector object contains attributes that are related to the message selector.

value

String.

Specifies the selector applied to messages published to the topic.

Only those messages that satisfy the selection criteria are put to the destination specified by this subscription.

type

String.

Specifies type of selector.

The value is one of the following values:

none: Specifies that no selector is present.
standard: Specifies that the selector references only the properties of the message, not its content, using the standard IBM® MQ selector syntax. Selectors of this type are to be handled internally by the queue manager.
extended: Specifies that the selector uses extended selector syntax, typically referencing the content of the message. Selectors of this type cannot be handled internally by the queue manager; extended selectors can be handled only by another program such as IBM Integration Bus.

destination

The destination object contains attributes that are related to the destination queue / queue manager.

isManaged: Boolean.; Specifies whether the destination is managed.
qmgrName: String.; Specifies the name of the destination queue manager, either local or remote, to which messages for the subscription are forwarded.
name: String.; Specifies the name of the alias, local, remote, or cluster queue to which messages for this subscription are put.
correlationId: Hexadecimal.; Specifies the correlation identifier that is placed in the CorrelId field of the message descriptor for all the messages sent to this subscription.

user

The user object contains attributes that are related to user that created the subscription, such as the accounting token, the user ID that owns the subscription and the user data.

accountingToken: Hexadecimal.; Specifies the accounting token used in the AccountingToken field of the message descriptor.
applicationIdentityData: String.; Specifies the application identity data used in the ApplIdentityData field of the message descriptor.
data: String.; Specifies the user data associated with the subscription.
name: String.; Specifies the userid that 'owns' this subscription. This parameter is either the userid associated with the creator of the subscription, or, if subscription takeover is permitted, the userid which last took over the subscription.
isVariable: Boolean.; Specifies whether any user other than the one who created the subscription can take over ownership.

general

The general object contains attributes that are related to general subscription properties, such as whether the subscription is durable, how the subscription was created and whether wildcards should be interpreted in the topic string.

isDurable

Boolean.

Specifies whether this subscription is a durable subscription.

If the subscription is durable, the subscription persists, even if the creating application disconnects from the queue manager or issues an MQCLOSE call for the subscription. The queue manager reinstates the subscription during restart.

If the subscription is non-durable, the queue manager removes the subscription when the creating application disconnects from the queue manager or issues an MQCLOSE call for the subscription. If the subscription has a destination.class of managed, the queue manager removes any messages not yet consumed when it closes the subscription.

type

String.

Specifies how the subscription was created.

The value is one of the following values:

administrative: Created using DEF SUB MQSC, REST or PCF command. It also indicates that a subscription has been modified using an administrative command.
api: Created using an MQSUB API request.
proxy: Created internally and used for routing publications through a queue manager.

usesCharacterWildcard

Boolean.

Specifies the schema to be used when any wildcard characters that are contained in the topic string are interpreted.

If the value is set to true, wildcard characters represent portions of strings; this is for compatibility with IBM MQ V6.0 brokers.

If the value is set to false, wildcard characters represent portions of the topic hierarchy; this value is for compatibility with IBM Integration Bus brokers.

extended

The extended object contains attributes that are related to extended subscription properties, such as the expiry time, the message priority and the network scope.

expiry

Integer.

Specifies the time, in tenths of seconds, at which a subscription expires after its creation date.

A value of -1 can be used to represent unlimited.

level

Integer.

Specifies the level within the subscription interception hierarchy at which this subscription is made.

messagePriority

String.

Specifies the priority of messages sent to this subscription. It has the range 0-9.

Additionally, the value can be one of the following values:

asPublished: The priority of messages sent to this subscription is taken from that priority supplied to the published message.
asQueue: The priority of messages sent to this subscription is determined by the default priority of the queue defined as a destination.

messagePropertyControl

String.

Specifies how publish/subscribe related message properties are added to messages sent to this subscription.

The value is one of the following values:

none: Specifies that publish/subscribe properties are not added to the messages.
compatible: Specifies that if the original publication is a PCF message, then the publish/subscribe properties are added as PCF attributes. Otherwise, publish/subscribe properties are added within an MQRFH version 1 header. This method is compatible with applications coded for use with previous versions of IBM MQ.
pcf: Specifies that publish/subscribe properties are added as PCF attributes.
rfh2: Specifies that publish/subscribe properties are added within an MQRFH version 2 header. This method is compatible with applications coded for use with IBM Integration Bus brokers.

deliverOnRequest

Boolean.

Specifies whether the subscriber polls for updates using the MQSUBRQ API call, or whether all publications are delivered to this subscription.

If the value is set to true, publications are only delivered to this subscription in response to an MQSUBRQ API call.

If the value is set to false, all publications on the topic are delivered to this subscription.

networkScope

String.

Specifies whether this subscription is passed to other queue managers in the network.

The value is one of the following values:

all: Specifies that the subscription is forwarded to all queue managers directly connected through a publish/subscribe collective or hierarchy.
qmgr: Specifies that the subcription forwards only messages that are published on the topic within this queue manager.

timestamps

The timestamps object contains attributes that are related to date and time information.

altered: String.; Specifies the date and time at which the subscription was last altered.; For more information about the time stamp format that is used to return the date and time, see REST API time stamps.
created: String.; Specifies the date and time at which the subscription was created.; For more information about the time stamp format that is used to return the date and time, see REST API time stamps.