MQS Glossary

Detailed below are the central objects used in the API. This documentation is generated from the OpenAPI spec, and the original ordering is preserved. See the API endpoints docs for information detailing usage.

---

ErrorResponse

Fields:

Field	Type	Description
code	integer	HTTP error code.
error	string	HTTP error reason.

---

EmptyObject

An empty JSON object.

Used as output by:

• GET /v1/mqs

---

MQGroupObject

Used as output by:

• GET /v1/mqs/workflows/{workflow_id}/mq-group

Fields:

Field	Type	Description
workflow_id	string
timestamp	number
criteria	object | null

---

MQProfileObject

Used as output by:

• GET /v1/mqs/mq-profiles/{mqid}

Fields:

Field	Type	Description
mqid	string
workflow_id	string
timestamp	number
alias	string
is_public	boolean
is_activated	boolean
auth_token	string | null
broker_type	string | null
broker_address	string | null

---

MQGroupObjectAndProfiles

Used as output by:

• POST /v1/mqs/workflows/{workflow_id}/mq-group/activation

• POST /v1/mqs/workflows/{workflow_id}/mq-group/reservation

Fields:

Field	Type	Description
mqgroup	MQGroupObject	The created MQ group object. See MQGroupObject.
mqprofiles	array of MQProfileObject	A list of MQ profiles. See MQProfileObject.

---

MQGroupActivationRequest

Used as input by:

• POST /v1/mqs/workflows/{workflow_id}/mq-group/activation

Fields:

Field	Type	Description
criteria	MQGroupObject.criteria	See field in MQGroupObject.

---

MQGroupReservationRequest

Used as input by:

• POST /v1/mqs/workflows/{workflow_id}/mq-group/reservation

Fields:

Field	Type	Description
queue_aliases	array of string	A list of requested queues, given by user-defined aliases.
public	array of string	A list of queue aliases designated for public access outside EWMS.

---

PublicMQProfilesResponse

Used as output by:

• GET /v1/mqs/workflows/{workflow_id}/mq-profiles/public

Fields:

Field	Type	Description
mqprofiles	array of MQProfileObject	A list of MQ profiles. See MQProfileObject.

---

JWKSetResponse

Used as output by:

• GET /mqbroker-issuer/.well-known/jwks.json

Fields:

Field	Type	Description
keys	array of object	The JWKS keys.

---

OpenAPISchemaObject

The OpenAPI schema.

Used as output by:

• GET /v1/mqs/schema/openapi