msgId: HTTP x-msg-msgId entity-header

Set or return the message identifier.

Type Description
HTTP header name x-msg-msgId
HTTP header type Entity-header
Valid in HTTP request message DELETE, GET, POST, x-msg-require-headers
Allowed values

    String value
    For example, 
    x-msg-msgId: mymsgid
    Strings enclosed in quotation marks for example, x-msg-msgId: my id

    Hex value
    A hex value prefixed with 0x: ; for example, 
    x-msg-msgId: 0x:43c1d23a

Default value Not applicable


Description

  • On an HTTP POST request, sets the message ID of the message created.
  • On an HTTP GET or DELETE request, selects the message from the queue or topic. If no message exists with the specified message ID, an HTTP 504 Gateway Timeout response is returned. x-msg-msgId can be used with x-msg-correlID to select a message from a queue or topic that matches both selectors.
  • Specified in x-msg-require-headers, returns x-msg-msgId in the HTTP response to the message ID of a message.
  • Horizontal white space is allowed after the 0x: prefix.
Note: Specifying x-msg-msgId without a value on an HTTP GET or DELETE request; for example, x-msg-msgId:, returns the next message on the queue or topic regardless of its message ID.

A JMS message selector containing JMSMessageID is used when selecting messages from the queue. This selector behaves as described in Selection behavior.