correlId: HTTP x-msg-correlId entity-header

Set or return the correlation identifier.

Type Description
HTTP header name x-msg-correlId
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-correlId: mycorrelationid
    Strings enclosed in quotation marks are permitted; for example: 
    x-msg-correlId: "my id"

    Hex value
    A hex value prefixed with 0x: ; for example: 
    x-msg-correlId: 0x:43c1d23a
    The hex value following 0x: is limited to 48 characters representing 24 bytes. Additional data is ignored.

Default value Not applicable


Description

  • On an HTTP POST request, sets the correlation 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 correlation ID, an HTTP 504 Gateway Timeout response is returned. x-msg-correlId can be used with x-msg-msgID to select a message from a queue or topic that matches both selectors.
  • Specified in x-msg-require-headers, sets x-msg-corelId in the HTTP response message to the correlation ID of a message.
  • Horizontal white space is allowed after the 0x: prefix.
Note:

  • Specifying x-msg-correlId without a value on an HTTP GET or DELETE request; for example, x-msg-correlId:, returns the next message on the queue or topic regardless of its correlation ID.
  • If you specify a selector of 24 characters or fewer, or 0x: followed by 48 characters or fewer, IBM MQ bridge for HTTP uses an optimized selector for improved performance.
  • A JMS message selector containing JMSCorrelationID is used when selecting messages from the queue. This selector behaves as described in Selection behavior.