Jump to

• Request
• Response
• Examples

Retrieve the Topology of a specific Messaging Context.

get

/messagingcontexts/{messagingContextID}

A user can view a specific messaging context and its encapsulated ephemeral resources.

Request

Path Parameters

• messagingContextID: string
  The messaging context ID whose topology to return

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

An individual messaging Context.

Body ()

Root Schema : messagingContext

Type: object

Show Source

• connections(optional): array connections
• id(optional): string
  A service-generated ID for the messaging context.  This ID is relevant only to the topology API.  Each element of the array will have a different id value.  This field is always present.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"A service-generated ID for the messaging context.  This ID is relevant only to the topology API.  Each element of the array will have a different id value.  This field is always present."
        },
        "connections":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/connection"
            }
        }
    }
}

Nested Schema : connections

Type: array

Show Source

• Array of: object connection

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/connection"
    }
}

Nested Schema : connection

Type: object

Show Source

• clientId(optional): string
  The connection???s client ID; if the connection does not have a client ID, this field will not be present.
• name(optional): string
  The name under which the REST API client created the connection.  This field is always present.
• sessions(optional): array sessions
• started(optional): boolean
  A boolean that is true if the connection is currently started, and false otherwise.  This field is always present.
• temporaryQueues(optional): array temporaryQueues
• temporaryTopics(optional): array temporaryTopics

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name under which the REST API client created the connection.  This field is always present."
        },
        "clientId":{
            "type":"string",
            "description":"The connection???s client ID; if the connection does not have a client ID, this field will not be present."
        },
        "started":{
            "type":"boolean",
            "description":"A boolean that is true if the connection is currently started, and false otherwise.  This field is always present."
        },
        "sessions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/session"
            }
        },
        "temporaryQueues":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/session"
            }
        },
        "temporaryTopics":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/session"
            }
        }
    }
}

Nested Schema : sessions

Type: array

Show Source

• Array of: object session

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/session"
    }
}

Nested Schema : temporaryQueues

Type: array

Show Source

• Array of: object session

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/session"
    }
}

Nested Schema : temporaryTopics

Type: array

Show Source

• Array of: object session

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/session"
    }
}

Nested Schema : session

Type: object

Show Source

• ackMode(optional): string
  A value indicating the acknowledgement mode of the session.  Its value is auto, client, or dups_ok.  This field will be present if transacted is false; otherwise, this field will not be present.
• consumers(optional): array consumers
• durableSubscribers(optional): array durableSubscribers
• name(optional): string
  The name under which the REST API client created the session.  This field is always present.
• producers(optional): array producers
• queueBrowsers(optional): array queueBrowsers
• transacted(optional): boolean
  A boolean that is true if the session is transacted, and false otherwise.  This field is always present.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name under which the REST API client created the session.  This field is always present."
        },
        "transacted":{
            "type":"boolean",
            "description":"A boolean that is true if the session is transacted, and false otherwise.  This field is always present."
        },
        "ackMode":{
            "type":"string",
            "description":"A value indicating the acknowledgement mode of the session.&nbsp; Its value is <code>auto, client, or dups_ok</code>.&nbsp; This field will be present if transacted is false; otherwise, this field will not be present."
        },
        "producers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/producer"
            }
        },
        "consumers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/consumer"
            }
        },
        "durableSubscribers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/durableSuscriber"
            }
        },
        "queueBrowsers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/queueBrowser"
            }
        }
    }
}

Nested Schema : consumers

Type: array

Show Source

• Array of: object consumer

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/consumer"
    }
}

Nested Schema : durableSubscribers

Type: array

Show Source

• Array of: object durableSuscriber

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/durableSuscriber"
    }
}

Nested Schema : producers

Type: array

Show Source

• Array of: object producer

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/producer"
    }
}

Nested Schema : queueBrowsers

Type: array

Show Source

• Array of: object queueBrowser

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/queueBrowser"
    }
}

Nested Schema : consumer

Type: object

Show Source

• destination(optional): string
  The destination from which the producer receives messages.  This field will always be present, and will have one of the following formats -
• /queues/queueName
• /topics/topicName
• /temporaryQueues/queueName
• /temporaryTopics/topicName

localMode(optional): string

The local mode of the consumer, which defines whether a consumer on a topic will receive message sent on the same connection the consumer was created from.  If the consumer is not on a topic or temporary topic, this field will not be present.  The default is for topic consumers to receive all messages sent to the topic that match their selector, so this field will only be present if the consumer does not receive messages sent on its connection, in which case the field will be present, and will have value NO_LOCAL.

name(optional): string

The name under which the REST API client created the consumer.  This field is always present.

selector(optional): string

The selector for the consumer.  This field will only be present if the consumer has a selector.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name under which the REST API client created the consumer.  This field is always present."
        },
        "destination":{
            "type":"string",
            "description":"The destination from which the producer receives messages.&nbsp; This field will always be present, and will have one of the following formats - <li>/queues/queueName</li> <li>/topics/topicName</li> <li>/temporaryQueues/queueName</li> <li>/temporaryTopics/topicName</li>"
        },
        "selector":{
            "type":"string",
            "description":"The selector for the consumer.&nbsp; This field will only be present if the consumer has a selector."
        },
        "localMode":{
            "type":"string",
            "description":"The local mode of the consumer, which defines whether a consumer on a topic will receive message sent on the same connection the consumer was created from.&nbsp; If the consumer is not on a topic or temporary topic, this field will not be present.&nbsp; The default is for topic consumers to receive all messages sent to the topic that match their selector, so this field will only be present if the consumer does not receive messages sent on its connection, in which case the field will be present, and will have value NO_LOCAL."
        }
    }
}

Nested Schema : durableSuscriber

Type: object

Show Source

• destination(optional): string
  The destination from which the producer receives messages.  This field will always be present and will have the format -
  /topics/topicName
/temporaryTopics/temporaryTopic.
• localMode(optional): string
  The local mode of the consumer, which defines whether a consumer on a topic will receive message sent on the same connection the consumer was created from.  If the consumer is not on a topic or temporary topic, this field will not be present.  The default is for topic consumers to receive all messages sent to the topic that match their selector, so this field will only be present if the consumer does not receive messages sent on its connection, in which case the field will be present, and will have value NO_LOCAL.
• name(optional): string
  The name under which the REST API client created the durable suscriber.  This field is always present.
• selector(optional): string
  The selector for the consumer.  This field will only be present if the consumer has a selector.
• subscriptionName(optional): string
  The string that is the subscription name corresponding to the subscriber. 
  Note This is different from the name field, which gives the name by which REST API clients refer to the subscriber.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name under which the REST API client created the durable suscriber.  This field is always present."
        },
        "destination":{
            "type":"string",
            "description":"The destination from which the producer receives messages.&nbsp; This field will always be present and will have the format - <br> <code>/topics/topicName</code> <br> <code>/temporaryTopics/temporaryTopic</code>."
        },
        "subscriptionName":{
            "type":"string",
            "description":"The string that is the subscription name corresponding to the subscriber.&nbsp; <br> Note This is different from the name field, which gives the name by which REST API clients refer to the subscriber."
        },
        "selector":{
            "type":"string",
            "description":"The selector for the consumer.&nbsp; This field will only be present if the consumer has a selector."
        },
        "localMode":{
            "type":"string",
            "description":"The local mode of the consumer, which defines whether a consumer on a topic will receive message sent on the same connection the consumer was created from.&nbsp; If the consumer is not on a topic or temporary topic, this field will not be present.&nbsp; The default is for topic consumers to receive all messages sent to the topic that match their selector, so this field will only be present if the consumer does not receive messages sent on its connection, in which case the field will be present, and will have value NO_LOCAL."
        }
    }
}

Nested Schema : producer

Type: object

Show Source

• deliveryMode(optional): string
  A String giving the default delivery mode for messages sent by this producer.  This field will always be present, and will have the value persistent or non_persistent.
• destination(optional): string
  The destination from which the producer receives messages.  This field will always be present, and will have one of the following formats -
• /queues/queueName
• /topics/topicName
• /temporaryQueues/queueName
• /temporaryTopics/topicName

name(optional): string

The name under which the REST API client created the producer.  This field is always present.

timeToLive(optional): integer

The time to live, in milliseconds, that is the default time to live for messages sent by this producer.  This field will always be present, and will be formatted as an integer, not a String.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name under which the REST API client created the producer.  This field is always present."
        },
        "destination":{
            "type":"string",
            "description":"The destination from which the producer receives messages.&nbsp; This field will always be present, and will have one of the following formats - <li>/queues/queueName</li> <li>/topics/topicName</li> <li>/temporaryQueues/queueName</li> <li>/temporaryTopics/topicName</li>"
        },
        "timeToLive":{
            "type":"integer",
            "description":"The time to live, in milliseconds, that is the default time to live for messages sent by this producer.&nbsp; This field will always be present, and will be formatted as an integer, not a String."
        },
        "deliveryMode":{
            "type":"string",
            "description":"A String giving the default delivery mode for messages sent by this producer.&nbsp; This field will always be present, and will have the value <code>persistent</code> or <code>non_persistent</code>."
        }
    }
}

Nested Schema : queueBrowser

Type: object

Show Source

• name(optional): string
  The name under which the REST API client created the queue browser.  This field is always present.
• queue(optional): string
  The queue that the browser browses.  This field is always present, and will have the format /queues/queueName.
• selector(optional): string
  The selector for the browser.  This field will only be present if the browser has a selector.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name under which the REST API client created the queue browser.  This field is always present."
        },
        "queue":{
            "type":"string",
            "description":"The queue that the browser browses.&nbsp; This field is always present, and will have the format <code>/queues/queueName</code>."
        },
        "selector":{
            "type":"string",
            "description":"The selector for the browser.&nbsp; This field will only be present if the browser has a selector."
        }
    }
}

Back to Top

Examples

cURL Command

curl -s -u $USER:$PASS \
     -H "Accept: application/json" \
     -X GET "https://messaging.us2.oraclecloud.com/myService-myTenant/api/v1/messagingcontexts/CEAB023246F71F9E"

There is no request body to submit with the HTTP request.

Example of Response Body

{
    "connections": [
        {
            "name": "0", 
            "sessions": [
                {
                    "ackMode": "auto", 
                    "name": "0", 
                    "producers": [
                        {
                            "deliveryMode": "persistent", 
                            "name": "0_0", 
                            "timeToLive": 1209600000
                        }
                    ], 
                    "transacted": false
                }
            ], 
            "started": false
        }
    ], 
    "id": "CEAB023246F71F9E"
}

Back to Top