TopicController

The second part of the URI must be topic to call the TopicController.

inquire

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 error object.

URL Parameters

/api/topic/inquire/<QueueManager>/<TopicName>

QueueManager

The name of the queuemanager. This parameter is required.

TopicName

The name of a topic. Generic topic names are supported. This parameter is optional.

Query Parameters

ClusterInfo

When true cluster information about topics and other topics in the repository that match the selection criteria is returned. By default this is false.

CommandScope

Specifies how the command is executed when the queuemanager is a member of a queue-sharing group. This parameter applies to z/OS only.

ExcludeSystem

When value is true, all topics starting with SYSTEM. will be discarded. This parameter is optional. By default the value is set to false.

Filter

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 discarded.

FilterOp

The operator that is being used to evaluate whether the parameter satisfies the filter-value. The default is EQ.

The following values are allowed:

A Stringfilter can use some additional operators:

FilterParam

The name of the parameter to filter on. The names are based on the names used in the WebSphere MQ information center.

FilterValue

The value to use for filtering. When a string is passed for an Integerfilter, a WebSphere MQ constant is assumed.

TopicAttrs

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

TopicName

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.

QSGDisposition

Disposition of the object within the group. Possible values are Live, Copy, Group, QMgr, Private or All. This parameter applies to z/OS only.

TopicType

Only return the topics of the given type. Possible values are Local, Cluster or All. Default is All. The value is case-sensitive.

Example

/api/topic/inquire/PIGEON/MQWEB.TOPIC.Q1
/api/topic/inquire/PIGEON/*
/api/topic/inquire/PIGEON?TopicName=*
/api/topic/inquire/PIGEON?TopicAttrs=TopicName

This sample is a PHP script that inquires all topics from a queuemanager:

<?php
/*
 * This sample will show all topics from a queuemanager.
 * MQWeb runs on localhost and is listening on port 8081. 
 */
if ( count($argv) < 2 ) {
	echo 'Please pass a queuemanager name as argument', PHP_EOL;
	exit;
}

$qmgr = $argv[1];

$url = 'http://localhost:8081/api/topic/inquire/' . $qmgr . '/*';

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

if ( ($response = curl_exec($curl)) === false )	{
	$err = curl_error($curl);
	echo 'An HTTP error occurred while getting topic information from '
		, $qmgr
		, ': '
		, $err
		, PHP_EOL;
}
else {
	$json = json_decode($response);
	
	// When there is an error object returned, something went wrong with
	// the WebSphere MQ command.
	if ( isset($json->error) ) {
		echo 'An MQ error occurred while inquiring topics from '
			, $qmgr
			, PHP_EOL;
		echo 'Reason Code: '
			,	$json->error->reason->code
			, " - "
			, $json->error->reason->desc
			, PHP_EOL;
	}
	else {
		echo 'Topics on ', $qmgr, PHP_EOL;
		echo '----------', str_repeat('-', strlen($qmgr)), PHP_EOL;
		if ( isset($json->data) && count($json->data) > 0 ) {
			foreach($json->data as $topic)
			{
				echo $topic->TopicName->value, PHP_EOL;
			}
		}
		else
		{
			echo 'No topics found', PHP_EOL;
		}
	}
}

JSON Object

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.

    {
      'TopicName' : 'T*',
      'TopicAttrs' : [
        'TopicName'
      ]
    }

There are some differences between query parameters and a JSON object:

An IntegerFilterCommand can’t be used together with a StringFilterCommand

This sample is a Perl script that inquires all topics:

#!/usr/bin/perl
use strict;
use warnings;
use feature qw(say);

use JSON;
use LWP::UserAgent;
use HTTP::Request::Common;

# This sample will show all SYSTEM topics from the given queuemanager.

my $qmgr = shift;
die("Please pass me the name of a queuemanager as argument") 
	unless defined($qmgr);

my $json = JSON->new;

my %input = ( 
	'TopicName' => 'SYSTEM*'
);
my $content = $json->encode(\%input);    

my $ua = LWP::UserAgent->new;
my $req = POST 'http://localhost:8081/api/topic/inquire/' . $qmgr;
$req->header(
	'Content-Type' => 'application/json',
	'Content-length' => length($content)
);
$req->content($content);

my $res = $ua->request($req);
die $res->status_line unless $res->is_success;
	
my $mqweb = $json->decode($res->content());
if ( exists($mqweb->{error}) ) {
	say 'An MQ error occurred while inquiring topics.';
	say 'Reason Code: '
		, $mqweb->{error}->{reason}->{code}
		, ' - '
		, $mqweb->{error}->{reason}->{desc};
}
else {
	foreach my $topic(@{$mqweb->{data}}) {
		say $topic->{TopicName}->{value};
	}
}