HTTP headers that can be used with the IBM MQ service provider
The IBM® MQ service provider expects specific HTTP headers when it calls either a two-way service, or a one-way service for sending messages.
Content-Type
header must be set to
application/json. If you specify a character set as part of this header, its
value must be utf-8
. For example,
Content-Type=application/json;charset=utf-8
Other HTTP headers can be specified on the HTTP request to change the behavior of the IBM MQ service provider. These headers are listed below. Any other HTTP headers are ignored.
- ibm-mq-md-msgID
- This header can be specified when requests are sent to a one-way service that is configured to
receive messages.
The value of this header is used to generate a message selector to select a message with the specified message ID. If an
ibm-mq-md-correlID
header is also specified, a message selector that matches both IDs is generated. - ibm-mq-md-correlID
- This header can be specified when requests are sent to either a two-way service, or a one-way
service that is configured to send messages, in which case it is used to set the
MQMD CorrelID
field of the message that is sent.This header can also be specified when requests are sent to a one-way service that is configured to receive messages. The value of this header is used to generate a message selector to select a message with the specified correlation ID. If an
ibm-mq-md-msgID
header is also specified, a message selector that matches both is generated. - ibm-mq-md-persistence
- This header can be used to override the persistence property. It applies to either one-way services that are configured for sending messages or two-way services.
- ibm-mq-md-expiry
- This header can be used to override the expiry property. It applies to either one-way services that are configured for sending messages, or two-way services.
- ibm-mq-gmo-waitInterval
- This header can be used to override the
waitInterval
property if set on the service. It is only relevant for one-way services that are configured for receiving messages or two-way services. For more information about thewaitInterval
property, see the zosconnect_mqService element in the Reference section. - ibm-mq-pmo-retain
- You can specify this header with a value of TRUE when a request that specifies a topic is sent to a one-way service that is configured for sending messages. For more information, see Retained publications in the IBM MQ documentation.
- ibm-mq-usr
- Use this header to provide message properties on the IBM MQ messages that are sent as a result of requests to either a two-way service, or a one-way service that is configured for sending messages.