GET

qmgrName

Specifies the name of the queue manager to connect to for messaging. The queue manager must be on the same machine as the mqweb server.

The queue manager name is case-sensitive.

If the queue manager name includes a forward slash, a period, or a percent sign, these characters must be URL encoded:

• A forward slash (/) must be encoded as %2F.
• A percent sign (%) must be encoded as %25.

queueName

Specifies the name of the queue from which to browse the messages.

The queue must be defined as being local or an alias that points to a local queue.

The queue name is case sensitive.

If the queue name includes a forward slash or a percent sign, these characters must be URL encoded:

• A forward slash, /, must be encoded as %2F.
• A percent sign, %, must be encoded as %25.

correlationId=hexValue

Specifies that the HTTP method returns the next message with the corresponding correlation ID.

hexValue

The query parameter must be specified as a 48 character hexadecimal encoded string, representing 24 bytes.

For example:

../messagelist?correlationId=414d5120514d4144455620202020202067d8bf5923582e02

correlationId=ID:hexValue or correlationId=application_specific_value

Specifies that the HTTP method returns a list of messages with the corresponding correlation ID.

hexValue

The query parameter must be specified as a 48 character hexadecimal encoded string, representing 24 bytes, and preceded by the string "ID:".

For example:

../message?correlationId=ID:414d5120514d4144455620202020202067d8bf5923582e02

application_specific_value

The query parameter can be specified as an application-specific string.

For example:

../message?correlationId=My-Custom-CorrelId

messageId=hexValue

Specifies that the HTTP method returns the next message with the corresponding message ID.

hexValue

The query parameter must be specified as a 48 character hexadecimal encoded string, representing 24 bytes.

For example:

../message?messageId=414d5120514d4144455620202020202067d8ce5923582f07

messageId=ID:hexValue

Specifies that the HTTP method returns the next message with the corresponding message ID.

hexValue

The query parameter must be specified as a 48 character hexadecimal encoded string, representing 24 bytes, and preceded by the string "ID:".

For example:

../message?messageId=ID:414d5120514d4144455620202020202067d8ce5923582f07

limit=integerValue

Specifies that the HTTP method response body is limited to integerValue JSON elements.

integerValue

The query parameter must be specified as an integer value that represents the maximum number of elements that are contained in the JSON response body.

The default value is 10, and the maximum value is 2147483647.

For example:

../messagelist?limit=250

The following headers must be sent with the request:

Authorization

This header must be sent if you are using basic authentication. For more information, see Using HTTP basic authentication with the REST API.

ibm-mq-rest-csrf-token

This header must be set, but the value can be anything, including being blank.

The following headers can optionally be sent with the request:

Accept-Charset

This header can be used to indicate what character set is acceptable for the response. If specified, this header must be set as UTF-8.

Accept-Language

This header specifies the required language for any exceptions or error messages returned in the response message body.

The security principal of the caller must be granted the ability to browse messages from the specified queue:

• The queue that is specified by the {queueName} portion of the resource URL, must be BROWSE enabled.
• For the queue that is specified by the {queueName} portion of the resource URL, +GET, +INQ, and +BROWSE authority must be granted to the security principal of the caller.
• For the queue that is specified by the {queueName} portion of the resource URL, UPDATE, access must be granted to the security principal of the caller.

200

Message list received successfully.

400

Invalid data provided.

For example, an invalid query parameter value was specified.

401

Not authenticated.

The caller must be authenticated to the mqweb server and must be a member of one or more of the MQWebAdmin, MQWebAdminRO, or MQWebUser roles. The ibm-mq-rest-csrf-token header must also be specified. For more information, see Security requirements.

403

Not authorized.

The caller is authenticated to the mqweb server and is associated with a valid principal. However, the principal does not have access to all, or a subset of the required IBM MQ resources, or is not in the MQWebUser role. For more information about the access that is required, see Security requirements.

404

Queue does not exist.

500

Server issue or error code from IBM MQ.

501

The HTTP response could not be constructed.

For example, the received message has an incorrect type, or has the correct type but the body could not be processed.

502

The current security principal cannot receive the message as the messaging provider does not support the required function. For example, if the mqweb server class path is invalid.

503

Queue manager not running.

Content-Language

Specifies the language identifier of the response message in the event of any errors or exceptions. Used in conjunction with Accept-Language request header to indicate the required language for any error or exception conditions. The mqweb server default is used if the requested language is unsupported.

Content-Length

Specifies the length of the HTTP response body, even when there is no content. The value contains the length of the message data, in bytes.

Content-Type

Specifies the type of response body. The value is application/json;charset=utf-8.

Upon success, the response body is a UTF-8 encoded response. The response contains an outer JSON object that contains a single JSON array called messages. Each element in the array is a JSON object that contains information about a message on the queue. Each element contains the following attributes:

correlationId

Specifies the correlation ID of the message. The value is returned if the message contains a valid correlation ID.

correlationId

Specifies the correlation ID of the message. The value is returned if the message contains a valid correlation ID. The correlation ID is prefixed with the "ID:" string, or can be an application-specific value.

messageId

Specifies the message ID that is allocated by IBM MQ to this message. It is represented as a 48-character hexadecimal encoded string, representing 24 bytes.

messageId

Specifies the message ID that is allocated by IBM MQ to this message. It is represented as a 48-character hexadecimal encoded string, representing 24 bytes. The message ID is prefixed with the "ID:" string.

format

Specifies the MQMD format field. Under normal circumstances text messages will contain the IBM MQ MQSTR value.

The following example logs in a user called mquser with the password mquser. In cURL, the log in request might look like the following Windows example. The LTPA token is stored in the cookiejar.txt file by using the -c flag:

curl -k "https://localhost:9443/ibmmq/rest/v2/login" -X POST 
-H "Content-Type: application/json" --data "{\"username\":\"mquser\",\"password\":\"mquser\"}" 
-c c:\cookiejar.txt

• The following Windows cURL example lists the next ten available messages from queue Q1 on queue manager QM1, using default options:

  curl -k "https://localhost:9443/ibmmq/rest/v2/messaging/qmgr/QM1/queue/Q1/messagelist" 
  -X GET -b c:\cookiejar.txt -H "ibm-mq-rest-csrf-token: token-value" 
  -H "Accept: application/json"

• The following Windows cURL example lists the next two hundred available messages from queue Q1 on queue manager QM1, using default options:

  curl -k "https://localhost:9443/ibmmq/rest/v2/messaging/qmgr/QM1/queue/Q1/messagelist?limit=200" 
  -X GET -b c:\cookiejar.txt -H "ibm-mq-rest-csrf-token: token-value" 
  -H "Accept: application/json"

• The following Windows cURL example lists only those messages with the corresponding correlation ID, 0000000000000000000000000000000000000000abcdabcd, from queue Q1 on queue manager QM1:

  curl -k "https://localhost:9443/ibmmq/rest/v2/messaging/qmgr/QM1/queue/Q1/messagelist?correlationId=0000000000000000000000000000000000000000abcdabcd" 
  -X GET -b c:\cookiejar.txt -H "ibm-mq-rest-csrf-token: token-value" 
  -H "Accept: application/json"

• 

  The following Windows cURL example is the same as the previous example, but uses REST API V3. The example lists only those messages with the corresponding correlation ID, 0000000000000000000000000000000000000000abcdabcd, from queue Q1 on queue manager QM1:

  curl -k "https://localhost:9443/ibmmq/rest/v3/messaging/qmgr/QM1/queue/Q1/messagelist?correlationId=ID:0000000000000000000000000000000000000000abcdabcd" 
  -X GET -b c:\cookiejar.txt -H "ibm-mq-rest-csrf-token: token-value" 
  -H "Accept: application/json"