Administrating WebSphere MQ with your browser.
The second part of the URI must be
topic to call the TopicController.
Get information about one or more topics. This action executes the
MQCMD_INQUIRE_TOPIC pcf command. On success, the returned JSON
object will have a
data array, on failure an
The name of the queuemanager. This parameter is required.
The name of a topic. Generic topic names are supported. This parameter is optional.
true cluster information about topics and other topics in the repository
that match the selection criteria is returned. By default this is
Specifies how the command is executed when the queuemanager is a member of a queue-sharing group. This parameter applies to z/OS only.
When value is
true, all topics starting with SYSTEM. will be discarded.
This parameter is optional. By default the value is set to
Speficies which filter to use:
I means Integerfilter,
S means Stringfilter.
FilterParam and FilterValue are required to create the filter. When a
filter can’t be build because of too little information, it will be silently
The operator that is being used to evaluate whether the parameter satisfies the filter-value.
The default is
The following values are allowed:
GT: Greater than
LT: Less than
EQ: Equal to
NE: Not equal to
NLT: Not less than
NGT: Not greater than
LE: Less than or equal to
GE: Greater than or equal to
A Stringfilter can use some additional operators:
LK: Matches a generic string
NL: Does not match a generic string
CTG: Contains an item which matches a generic string
EXG: Does not contain any item which matches a generic string.
The name of the parameter to filter on. The names are based on the names used in the WebSphere MQ information center.
The value to use for filtering. When a string is passed for an Integerfilter, a WebSphere MQ constant is assumed.
With the TopicAttrs parameter you can specify which attributes must be returned from the PCF command. Multiple occurences of this parameter are possible. The value must be a valid attribute name.
Attrs is a synonym for TopicAttrs
Only return topics with a name that matches TopicName. By default * is used which matches all topics. Name is a synonym for this parameter.
This parameter is ignored when there is a URI parameter for a topicname.
Disposition of the object within the group. Possible values are
All. This parameter applies to z/OS only.
Only return the topics of the given type. Possible values are
All. Default is
All. The value is case-sensitive.
This sample is a PHP script that inquires all topics from a queuemanager:
When using an application/json POST request you can post a JSON object with names like the query parameters.
All URL parameters and query parameters are ignored except for the URL parameter for the name of the queuemanager.
There are some differences between query parameters and a JSON object:
- JSON property names are case-sensitive
- TopicAttrs is a JSON array with attributenames as element.
- Synonyms can’t be used, you need to use the name of the attribute as described in the query parameters. You can’t use name, it must be TopicName for example.
- A filter is an object: IntegerFilterCommand can be used to filter on parameters which has integer values, while StringFilterCommand can be used to filter on parameters with string values. The filter object has these three properties: Parameter (see FilterParam), Operator (see FilterOp) and FilterValue (see FilterValue).
An IntegerFilterCommand can’t be used together with a StringFilterCommand
This sample is a Perl script that inquires all topics: