Uniform Resource Identifier syntax for administering the Web Gateway

A WebSphere® MQ File Transfer Edition Uniform Resource Identifier (URI) is distinguished from other WebSphere MQ URIs by the context root specified at deploy time. The recommended context root is /wmqfte. The URI used for administration tasks is distinguished from existing WebSphere MQ File Transfer Edition URIs by the term /admin.

WebSphere MQ File Transfer Edition resources are distinguished from each other by their types. A resource is addressed by its resource type and an identifying token.

WebSphere MQ File Transfer Edition Administration Uniform Resource Identifier syntax diagram

Syntax diagram format

           

Read syntax diagramSkip visual syntax diagram
>>-connection_name--/--fte--/--admin--/------------------------->

>--+-filespace-+------------------+-+--------------------------><
   |           '-/file_space_name-' |   
   '-user---------------------------'   

Parameters

connection_name
Required. The host name and, optionally, the port of the server hosting the Web Gateway. Not case-sensitive.

fte
Required. Indicates that the URI is addressed to the Web Gateway. Case-sensitive.

admin
Required. Indicates that you are using the administrative functions of the Web Gateway. Case-sensitive.

filespace
Indicates that you are addressing a file space resource. For more information about file spaces, see File spaces. Case-sensitive.

One of the parameters filespace or user is required.

file_space_name
The name of the file space you are addressing. This is the name of the user associated with the file space. The value of file_space_name must be 255 characters or fewer in length. Case-sensitive.

Only applicable if you specify filespace. Optional if you use the HTTP verb GET, required if you use POST or DELETE. If you use the HTTP verb GET and do not provide a value for file_space_name, the Web Gateway returns a list of all file spaces.

user
Indicates that you are addressing the set of mappings between web user ID and MQMD user ID. For more information about the format of this set of mappings, see XML format for mapping web user ID to an MQMD user ID. Case-sensitive.

One of the parameters filespace or user is required.

Examples

For example, to address a file space resource that is owned by the user sarah, use the following URI:

http://example.org/wmqfte/admin/filespace/sarah/

In this example:
  • http://example.org is the host system.
  • /wmqfte indicates that the URI is a WebSphere MQ File Transfer Edition URI.
  • /admin indicates that you are accessing administrative functions of the Web Gateway.
  • /filespace indicates that the resource being addressed is a file space resource.
  • /sarah/ is the identifying token. This token is the name of the file space, which is also the name of the user who owns the file space.

For example, to address the set of mappings between user ID and MQMD ID, use the following URI:

http://example.org/wmqfte/admin/user


Reference Reference

Feedback

Timestamp icon Last updated: Tuesday, 30 January 2018
http://www.ibm.com/support/knowledgecenter/SSEP7X_7.0.4/com.ibm.wmqfte.doc/web_uri_syntax_admin.htm