Administrating WebSphere MQ with your browser.
The second part of the URI must be
chstatus to call the ChannelStatusController.
This controller can be used to get status information from channels.
Returns all status attributes of channels which matches the given name.
This action executes the MQCMD_INQUIRE_CHANNEL_STATUS 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 channel. When this parameter is used, the ChannelName parameter is ignored.
The name of a channel. When this query parameter is not available, a *
will be used which matches all channels.
name can be used as synonym. This
parameter will be ignored when a channelname is passed as URL parameter.
Saved Channel or
Short Channel are the possible values.
The default is
Current Channel. The value is case sensitive.
Possible values are
Cluster-sender. The value is case-sensitive. This is actually a shortcut
for a Filter :
It’s a numeric filter, because ChannelType is an integer constant. When a string value is passed, MQWeb will try to convert the string to the corresponding constant.
Be aware that only one integer/string filter can be used for each call.
The ClientId of the client.
Specifies how the command is executed when the queue manager is a member of a queue-sharing group. This parameter applies to z/OS only.
If this parameter is present, eligible channel instances are limited to those using this connection name.
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.
If this parameter is present, eligible channel instances are limited to those using this transmission queue.
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
- ChannelName is a mandatory property. No default values is used.
- ChannelInstanceAttrs 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 ChannelName 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 channel statuses for Server-connection channels.