IT34463: Administrative REST API parameter ibm-mq-rest-gateway-qmgr cannot be used with the REST API discovery feature, and CORS.

APAR status

• Closed as program error.

Error description

• The Swagger documentation for the IBM MQ administrative REST API
  does not include details of the header parameter:
  
    ibm-mq-rest-gateway-qmgr
  
  which is used by the administrative REST API gateway to
  determine which gateway queue manager should be used to process
  the REST request. This means that:
  
  - If the mqweb server has not been configured with a default
  gateway queue manager, then it is not possible to use the REST
  API discovery feature provided by the mqweb server to submit
  requests to a remote queue manager.
  - If the mqweb server has been configured with a default gateway
  queue manager, and there is more than one gateway queue manager
  associated with an MQ installation, then all of the requests
  submitted using the REST API discovery feature for remote queue
  managers must use the default gateway queue manager. It is not
  possible to specify a different gateway queue manager to use on
  individual requests.
  
  In addition to this, the header parameter is not exposed via
  Cross Origin Resource Sharing (CORS). As a result, it is not
  possible to specify a gateway queue manager to use on individual
  requests submitted from Javascript running inside of a web
  browser.
  

Local fix

Problem summary

• ****************************************************************
  USERS AFFECTED:
  This issue affects users of the MQ administrative REST API
  gateway, who want to be able to specify a gateway queue manager
  on individual REST requests.
  
  
  Platforms affected:
  MultiPlatform
  
  ****************************************************************
  PROBLEM DESCRIPTION:
  When the MQ administrative REST API gateway was developed, the
  new HTTP header parameter:
  
    ibm-mq-rest-gateway-qmgr
  
  was not added to either the Swagger documentation for the MQ
  REST API or the list of allowed headers exposed via Cross Origin
  Resource Sharing (CORS).
  

Problem conclusion

• Two changes have been made to resolve this issue:
  
  -------------------------------------------------------------
  Change 1:
  ------------
  The HTTP header parameter:
  
    ibm-mq-rest-gateway-qmgr
  
  has been added to the Swagger documentation for the following
  REST API methods:
  
  Channel resources:
    ->GET /ibmmq/rest/v1/admin/qmgr/{qmgrName}/channel
    ->GET /ibmmq/rest/v1/admin/qmgr/{qmgrName}/channel/{name}
  
  Queue manager resources:
    -> GET /ibmmq/rest/v1/admin/qmgr/{qmgr}
  
  mqsc resources (Queue manager "actions"):
    -> POST /ibmmq/rest/v1/admin/action/qmgr/{qmgrName}/mqsc
  
  Queue resources:
    -> GET /ibmmq/rest/v1/admin/qmgr/{qmgrName}/queue
    -> POST /ibmmq/rest/v1/admin/qmgr/{qmgrName}/queue
    -> DELETE /ibmmq/rest/v1/admin/qmgr/{qmgrName}/queue/{qName}
    -> GET /ibmmq/rest/v1/admin/qmgr/{qmgrName}/queue/{qName}
    -> PATCH /ibmmq/rest/v1/admin/qmgr/{qmgrName}/queue/{qName}
  
  Subscription resources:
    -> GET /ibmmq/rest/v1/admin/qmgr/{qmgrName}/subscription
    -> GET
  /ibmmq/rest/v1/admin/qmgr/{qmgrName}/subscription/{name}
  
  This allows a gateway queue manager to be specified on
  individual REST requests submitted by the API Explorer provided
  by the REST API discovery feature.
  
  -------------------------------------------------------------
  Change 2:
  ------------
  The header parameter:
  
    ibm-mq-rest-gateway-qmgr
  
  is now exposed via CORS. This allows a gateway queue manager to
  be specified on individual requests submitted from Javascript
  running inside of a web browser.
  
  ---------------------------------------------------------------
  The fix is targeted for delivery in the following PTFs:
  
  Version    Maintenance Level
  v9.1 LTS   9.1.0.8
  v9.2 LTS   9.2.0.2
  v9.x CD    9.2.2
  
  The latest available maintenance can be obtained from
  'WebSphere MQ Recommended Fixes'
  http://www-1.ibm.com/support/docview.wss?rs=171&uid=swg27006037
  
  If the maintenance level is not yet available information on
  its planned availability can be found in 'WebSphere MQ
  Planned Maintenance Release Dates'
  http://www-1.ibm.com/support/docview.wss?rs=171&uid=swg27006309
  ---------------------------------------------------------------
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

• Fixed component name

  IBM MQ BASE MP

• Fixed component ID

  5724H7271

Applicable component levels