mqs

mq-profiles

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

Parameters:

mqid (string) – The ID of the message queue, as found in the MQ profile.

Example request:

GET /v1/mqs/mq-profiles/{mqid} HTTP/1.1
Host: example.com

Status Codes:

200 OK –

The matching MQ profile.

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "mqid": "string",
    "workflow_id": "string",
    "timestamp": 1.0,
    "alias": "string",
    "is_public": true,
    "is_activated": true,
    "auth_token": "string",
    "broker_type": "string",
    "broker_address": "string"
}

400 Bad Request –

Invalid request arguments.

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "code": 1,
    "error": "string"
}

404 Not Found –

Not found.

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
    "code": 1,
    "error": "string"
}

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

See PublicMQProfilesResponse.

Parameters:

workflow_id (string) – The ID of the EWMS workflow that maps to an MQ group.

Example request:

GET /v1/mqs/workflows/{workflow_id}/mq-profiles/public HTTP/1.1
Host: example.com

Status Codes:

200 OK –

The public MQ profiles for the workflow.

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "mqprofiles": [
        {
            "mqid": "string",
            "workflow_id": "string",
            "timestamp": 1.0,
            "alias": "string",
            "is_public": true,
            "is_activated": true,
            "auth_token": "string",
            "broker_type": "string",
            "broker_address": "string"
        }
    ]
}

400 Bad Request –

Invalid request arguments.

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "code": 1,
    "error": "string"
}

404 Not Found –

Not found.

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
    "code": 1,
    "error": "string"
}

openapi

GET /v1/mqs/schema/openapi

Example request:

GET /v1/mqs/schema/openapi HTTP/1.1
Host: example.com

Status Codes:

200 OK –

The OpenAPI schema.

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

400 Bad Request –

Invalid request arguments.

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "code": 1,
    "error": "string"
}

mq-group

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

See MQGroupObject.

Parameters:

workflow_id (string) – The ID of the EWMS workflow that maps to an MQ group.

Example request:

GET /v1/mqs/workflows/{workflow_id}/mq-group HTTP/1.1
Host: example.com

Status Codes:

200 OK –

The matching MQ group object.

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "workflow_id": "string",
    "timestamp": 1.0,
    "criteria": {
        "priority": 1
    }
}

400 Bad Request –

Invalid request arguments.

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "code": 1,
    "error": "string"
}

404 Not Found –

Not found.

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
    "code": 1,
    "error": "string"
}

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

See MQGroupActivationRequest, MQGroupObjectAndProfiles.

Parameters:

workflow_id (string) – The ID of the EWMS workflow that maps to an MQ group.

Example request:

POST /v1/mqs/workflows/{workflow_id}/mq-group/activation HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "criteria": {
        "priority": 1
    }
}

Status Codes:

200 OK –

An activated group of queues.

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "mqgroup": {
        "workflow_id": "string",
        "timestamp": 1.0,
        "criteria": {
            "priority": 1
        }
    },
    "mqprofiles": [
        {
            "mqid": "string",
            "workflow_id": "string",
            "timestamp": 1.0,
            "alias": "string",
            "is_public": true,
            "is_activated": true,
            "auth_token": "string",
            "broker_type": "string",
            "broker_address": "string"
        }
    ]
}

400 Bad Request –

Invalid request arguments.

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "code": 1,
    "error": "string"
}

404 Not Found –

Not found.

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
    "code": 1,
    "error": "string"
}

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

See MQGroupReservationRequest, MQGroupObjectAndProfiles.

Parameters:

workflow_id (string) – The ID of the EWMS workflow that maps to an MQ group.

Example request:

POST /v1/mqs/workflows/{workflow_id}/mq-group/reservation HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "queue_aliases": [
        "string"
    ],
    "public": [
        "string"
    ]
}

Status Codes:

200 OK –

A successfully reserved, unactivated group of queues.

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "mqgroup": {
        "workflow_id": "string",
        "timestamp": 1.0,
        "criteria": {
            "priority": 1
        }
    },
    "mqprofiles": [
        {
            "mqid": "string",
            "workflow_id": "string",
            "timestamp": 1.0,
            "alias": "string",
            "is_public": true,
            "is_activated": true,
            "auth_token": "string",
            "broker_type": "string",
            "broker_address": "string"
        }
    ]
}

400 Bad Request –

Invalid request arguments.

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "code": 1,
    "error": "string"
}

404 Not Found –

Not found.

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
    "code": 1,
    "error": "string"
}