You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

Table of Contents

The HTTP Gateway can be accessed using your favourite http client. Some recommendations are:

  • curl
  • wget
  • Postman (Google Chrome Extension)

For the request URL format, the use of headers, response codes, etc. follow the conventions recommended for a RESTful API. This is described in detail below:

Please note, a .* wildcard value can only be used as part of the objectName and fieldValue segments. A message "Warning": "Search returned no results." will be returned if used elsewhere.

Request Web Service URL format:

http://hostname:port/objects/{QMGR}/objectType/objectName/fieldName/fieldValue
http://hostname:port/statistics/{QMGR}/objectType/objectName/fieldName/fieldValue

Filter Examples

The URL below filters statistics for QUEUE1 based on the date.

http://hostname.com:8085/statistics/TEST/STATISTICS/QUEUE1/date/2016-04-29

The URLs below filter statistics for all queues matching the .* wildcard for the date or queue name.

http://hostname.com:8085/statistics/TEST/STATISTICS/.*/date/2016-04-29
http://hostname.com:8085/statistics/TEST/STATISTICS/QU.*1/date/2016-04-29
http://hostname.com:8085/statistics/TEST/STATISTICS/QU.*1/date/2016-04.*

Where:

{QMGR} - the name of the queue manager configured
objectype - one of the following, must be in UPPERCASE. Refer to the table below.
objectname - is the name of the queue manager object, i.e. a queue name.

Example REST Web Service URLs

Object Type

Category

Example REST URL

Operating System

QMGR

OBJECT_CONFIG

http://host:8085/objects/{QMGR}/QMGR

All

QUEUE

OBJECT_CONFIG

http://host:8085/objects/{QMGR}/QUEUE

All

CHANNEL

OBJECT_CONFIG

http://host:8085/objects/{QMGR}/CHANNEL

All

SUBSCRIPTION

OBJECT_CONFIG

http://host:8085/objects/{QMGR}/SUBSCRIPTION

All

TOPIC

OBJECT_CONFIG

http://host:8085/objects/{QMGR}/TOPIC

All

PROCESS

OBJECT_CONFIG

http://host:8085/objects/{QMGR}/PROCESS

All

SERVICE

OBJECT_CONFIG

http://host:8085/objects/{QMGR}/SERVICE

All

NAMELIST

OBJECT_CONFIG

http://host:8085/objects/{QMGR}/NAMELIST

All

STORAGE_CLASS

OBJECT_CONFIG

http://host:8085/objects/{QMGR}/STORAGE_CLASS

ZOS Only

SYSTEM

OBJECT_CONFIG

http://host:8085/objects/{QMGR}/SYSTEM

ZOS Only

LOG

OBJECT_CONFIG

http://host:8085/objects/{QMGR}/LOG

ZOS Only

QUEUE_STATUS

STATUS

http://host:8085/objects/{QMGR}/QUEUE_STATUS

All

QMGR_STATUS

STATUS

http://host:8085/objects/{QMGR}/QMGR_STATUS

All

CHANNEL_STATUS

STATUS

http://host:8085/objects/{QMGR}/CHANNEL_STATUS

All

SERVICE_STATUS

STATUS

http://host:8085/objects/{QMGR}/SERVICE_STATUS

All

SUBSCRIPTION_STATUS

STATUS

http://host:8085/objects/{QMGR}/SUBSCRIPTION_STATUS

All

LISTENER_STATUS

STATUS

http://host:8085/objects/{QMGR}/LISTENER_STATUS

All

PUBSUB_STATUS

STATUS

http://host:8085/objects/{QMGR}/PUBSUB_STATUS

All

PAGESET_USAGE

STATUS

http://host:8085/objects/{QMGR}/PAGESET_USAGE

ZOS Only

CHANNEL_INITIATOR

STATUS

http://host:8085/objects/{QMGR}/CHANNEL_INITIATOR

ZOS Only

CHANNEL_EVENT

EVENT_MESSAGE

http://host:8085/statistics/{QMGR}/CHANNEL_EVENT

All

PUBSUB_EVENT

EVENT_MESSAGE

http://host:8085/statistics/{QMGR}/PUBSUB_EVENT

All

PERFM_EVENT

EVENT_MESSAGE

http://host:8085/statistics/{QMGR}/PERFM_EVENT

All

QMGR_EVENT

EVENT_MESSAGE

http://host:8085/statistics/{QMGR}/QMGR_EVENT

All

COMMAND_EVENT

EVENT_MESSAGE

http://host:8085/statistics/{QMGR}/COMMAND_EVENT

All

LOGGER_EVENT

EVENT_MESSAGE

http://host:8085/statistics/{QMGR}/LOGGER_EVENT

All

CONFIG_EVENT

EVENT_MESSAGE

http://host:8085/statistics/{QMGR}/CONFIG_EVENT

All

STATISTICS

STATS_MESSAGE

http://host:8085/statistics/{QMGR}/STATISTICS

All

RESETQSTATS

STATS_MESSAGE

http://host:8085/statistics/{QMGR}/RESETQSTATS

ZOS Only

ACCOUNTING

STATS_MESSAGE

http://host:8085/statistics/{QMGR}/ACCOUNTING

All

                                                           Table 14: Example REST Web Service URLs

Request headers

Each request must have an “Accept” header, where the value may be either application/json or application/xml. This tells the Lamaxu process whether you want JSON or XML formatted output.

If your Lamaxu process is configured with local and, or LDAP authentication, you will need to supply an “Authorization” header. A valid value may look like “Basic YWRtaW46YWRwaW4=”

Postman Example showing Accept header


  • No labels