.. include:: /_generated_banners/mqs-ref-banner.rst

MQS Glossary
============

ErrorResponse
-------------

.. list-table::
   :header-rows: 1
   :widths: 35 15 50

   * - Field
     - Type
     - Description
   * - ``code``
     - integer
     - HTTP error code.
   * - ``error``
     - string
     - HTTP error reason.

EmptyObject
-----------
An empty JSON object.


MQGroupObject
-------------

.. list-table::
   :header-rows: 1
   :widths: 35 15 50

   * - Field
     - Type
     - Description
   * - ``workflow_id``
     - string
     - 
   * - ``timestamp``
     - number
     - 
   * - ``criteria``
     - object | null
     - 

MQProfileObject
---------------

.. list-table::
   :header-rows: 1
   :widths: 35 15 50

   * - 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
------------------------

.. list-table::
   :header-rows: 1
   :widths: 35 15 50

   * - Field
     - Type
     - Description
   * - ``mqgroup``
     - ``MQGroupObject``
     - The created MQ group object. See `MQGroupObject`_.
   * - ``mqprofiles``
     - array of ``MQProfileObject(s)``
     - A list of MQ profiles. See `MQProfileObject`_.

MQGroupActivationRequest
------------------------

.. list-table::
   :header-rows: 1
   :widths: 35 15 50

   * - Field
     - Type
     - Description
   * - ``criteria``
     - object
     - See `MQGroupObject`_ (``criteria`` field).

MQGroupReservationRequest
-------------------------

.. list-table::
   :header-rows: 1
   :widths: 35 15 50

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

PublicMQProfilesResponse
------------------------

.. list-table::
   :header-rows: 1
   :widths: 35 15 50

   * - Field
     - Type
     - Description
   * - ``mqprofiles``
     - array of ``MQProfileObject(s)``
     - A list of MQ profiles. See `MQProfileObject`_.

JWKSetResponse
--------------

.. list-table::
   :header-rows: 1
   :widths: 35 15 50

   * - Field
     - Type
     - Description
   * - ``keys``
     - array of object(s)
     - The JWKS keys.

OpenAPISchemaObject
-------------------
The OpenAPI schema.