Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IBM MQ JMS API

Java Message Service API for IBM MQ.

This event API exposes 7 operations across 4 channels, and defines 4 schemas. It is described by AsyncAPI 2.6.0, at version 9.3.

The API connects through 2 servers: {host}:{port} (ibmmq), {host}:{amqpPort} (amqp).

7 operations 4 channels 4 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
9.3
Servers
{host}:{port} (ibmmq)
{host}:{amqpPort} (amqp)
Resource Areas
1

Channels & Operations 7

Across 4 channels, the API surfaces 7 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 7
SUB
queue/{queueName}
Receive a message from a queue
receiveFromQueue 1 param body
PUB
queue/{queueName}
Send a message to a queue
sendToQueue 1 param body
SUB
topic/{topicString}
Subscribe to a topic
subscribeToTopic 1 param body
PUB
topic/{topicString}
Publish a message to a topic
publishToTopic 1 param body
SUB
deadLetterQueue
Receive undeliverable messages
receiveDeadLetterMessage body
SUB
requestReply/{requestQueue}
Receive a reply message
receiveReply 1 param body
PUB
requestReply/{requestQueue}
Send a request message
sendRequest 1 param body

Messages & Schemas 4

The contract defines 4 schemas that model the data carried by its messages. Each schema is shown below with its type and property counts.

MQMessage
message
A message transmitted through IBM MQ
DeadLetterMessage
message
An undeliverable message routed to the dead-letter queue
RequestMessage
message
A request message in a request/reply pattern
ReplyMessage
message
A reply message correlated to a request

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

ibm-mq-messaging-asyncapi.yml Raw ↑