RESTful Server Runtime Management Interface for Oracle WebLogic Server

Get JMS Messages

post

/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/remoteEndpoints/{name}/getJMSMessages

Returns an array of JMSMessageVBean objects that match the specified JMS message selector. When the sortOn parameter is specified the array is ordered by the message header field.

Request

Supported Media Types

application/json

Path Parameters

name(required): string

The name property of the instance in the collection.
version(required): string

The version of the WebLogic REST interface.

Header Parameters

X-Requested-By(required): string

The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Must contain the following fields:

Root Schema : Arguments

Type: object

Title: Arguments

Show Source

ascending: array Items

Title: Items

Indicates whether sort order is ascending or descending
max: integer(int32)

The maximum number of messages to return
selector: string

The JMS message selector
sortOn: array Items

Title: Items

The JMS header fields to sort on. Values can include message attributes JMSMessageID, JMSTimestamp, JMSDeliveryTime, JMSType, JMSCorrelationID, JMSExpiration, JMSRedelivered, JMSPriority, JMS_BEA_Size, JMS_BEA_UnitOfOrder, JMS_BEA_Xid, JMS_BEA_State, JMS_BEA_SequenceNumber, and arbitrary message property names.

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "ascending":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"boolean",
                "description":""
            },
            "description":"<p>Indicates whether sort order is ascending or descending</p>"
        },
        "max":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The maximum number of messages to return</p>"
        },
        "selector":{
            "type":"string",
            "description":"<p>The JMS message selector</p>"
        },
        "sortOn":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The JMS header fields to sort on. Values can include message attributes JMSMessageID, JMSTimestamp, JMSDeliveryTime, JMSType, JMSCorrelationID, JMSExpiration, JMSRedelivered, JMSPriority, JMS_BEA_Size, JMS_BEA_UnitOfOrder, JMS_BEA_Xid, JMS_BEA_State, JMS_BEA_SequenceNumber, and arbitrary message property names.</p>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Indicates whether sort order is ascending or descending

Show Source

Array of: boolean

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"boolean",
        "description":""
    },
    "description":"<p>Indicates whether sort order is ascending or descending</p>"
}

Nested Schema : Items

Type: array

Title: Items

The JMS header fields to sort on. Values can include message attributes JMSMessageID, JMSTimestamp, JMSDeliveryTime, JMSType, JMSCorrelationID, JMSExpiration, JMSRedelivered, JMSPriority, JMS_BEA_Size, JMS_BEA_UnitOfOrder, JMS_BEA_Xid, JMS_BEA_State, JMS_BEA_SequenceNumber, and arbitrary message property names.

Show Source

Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The JMS header fields to sort on. Values can include message attributes JMSMessageID, JMSTimestamp, JMSDeliveryTime, JMSType, JMSCorrelationID, JMSExpiration, JMSRedelivered, JMSPriority, JMS_BEA_Size, JMS_BEA_UnitOfOrder, JMS_BEA_Xid, JMS_BEA_State, JMS_BEA_SequenceNumber, and arbitrary message property names.</p>"
}

Security

Admin: basic

Type: basic

Description: A user in the Admin security role.

Response

Supported Media Types

application/json

200 Response

Returns the following fields:

Root Schema : Return

Type: object

Title: Return

Show Source

return: object JMS Messages V

{
    "type":"object",
    "title":"Return",
    "properties":{
        "return":{
            "$ref":"#/definitions/JMS Messages V"
        }
    },
    "description":""
}

Nested Schema : JMS Messages V

Type: object

Show Source

jmsMessages: array Items

Title: Items

Read Only: true

Returns the JMS messages that match the specified filter criteria, up to the maximum number of messages specified.
totalCount: integer(int64)

Read Only: true

The total number of messages on the destination, including pending messages that are not visible. For JMS server operations, where the resulting messages could span multiple destinations, the value will represent the total number of messages matching the selector criteria.
totalFilteredCount: integer(int64)

Read Only: true

The number of messages matching the selector criteria. Note that this value may be larger than the number of messages returned.

{
    "type":"object",
    "properties":{
        "jmsMessages":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "$ref":"#/definitions/JMS Message V"
            },
            "description":"<p>Returns the JMS messages that match the specified filter criteria, up to the maximum number of messages specified.</p>"
        },
        "totalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The total number of messages on the destination, including pending messages that are not visible.  For JMS server operations, where the resulting messages could span multiple destinations, the value will represent the total number of messages matching the selector criteria.</p>"
        },
        "totalFilteredCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of messages matching the selector criteria.  Note that this value may be larger than the number of messages returned.</p>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Read Only: true

Returns the JMS messages that match the specified filter criteria, up to the maximum number of messages specified.

Show Source

Array of: object JMS Message V

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/JMS Message V"
    },
    "description":"<p>Returns the JMS messages that match the specified filter criteria, up to the maximum number of messages specified.</p>"
}

Nested Schema : JMS Message V

Type: object

Show Source

header: object JMS Message Header V
metaData: object JMS Message Meta Data V

{
    "type":"object",
    "properties":{
        "header":{
            "readOnly":true,
            "$ref":"#/definitions/JMS Message Header V"
        },
        "metaData":{
            "readOnly":true,
            "$ref":"#/definitions/JMS Message Meta Data V"
        }
    },
    "description":""
}

Nested Schema : JMS Message Header V

Type: object

Show Source

jmsCorrelationID: string

Read Only: true

Returns the correlation ID.
jmsDeliveryMode: string
Read Only: true
Returns one of the following delivery mode values:
- persistent
- nonpersistent
jmsDestination: object JMS Destination V
jmsExpiration: integer(int64)

Read Only: true

Returns the expiration.
jmsMessageID: string

Read Only: true

Returns the message ID.
jmsPriority: integer(int32)

Read Only: true

Returns the priority.
jmsRedelivered: boolean

Read Only: true

Returns the redelivered flag.
jmsReplyTo: object JMS Destination V
jmsTimestamp: integer(int64)

Read Only: true

Returns the timestamp.
jmsType: string

Read Only: true

Returns the type.
properties: array Items

Title: Items

Read Only: true

Returns the message properties

{
    "type":"object",
    "properties":{
        "jmsCorrelationID":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the correlation ID.</p>"
        },
        "jmsDeliveryMode":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns one of the following delivery mode values:</p><ul><li><p>persistent</p></li><li><p>nonpersistent</p></li></ul>"
        },
        "jmsDestination":{
            "readOnly":true,
            "$ref":"#/definitions/JMS Destination V"
        },
        "jmsExpiration":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the expiration.</p>"
        },
        "jmsMessageID":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the message ID.</p>"
        },
        "jmsPriority":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Returns the priority.</p>"
        },
        "jmsRedelivered":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Returns the redelivered flag.</p>"
        },
        "jmsReplyTo":{
            "readOnly":true,
            "$ref":"#/definitions/JMS Destination V"
        },
        "jmsTimestamp":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the timestamp.</p>"
        },
        "jmsType":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the type.</p>"
        },
        "properties":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "$ref":"#/definitions/JMS Message Property V"
            },
            "description":"<p>Returns the message properties</p>"
        }
    },
    "description":""
}

Nested Schema : JMS Message Meta Data V

Type: object

Show Source

consumerID: string

Read Only: true

Returns the consumer ID.
destinationName: string

Read Only: true

Returns the decorated name of the destination.
messageSize: integer(int64)

Read Only: true

Returns the size of the message in bytes.
messageType: string
Read Only: true
Returns the type of message. The values include:
- bytes
- map
- object
- stream
- text
- xml
sequenceNumber: integer(int64)

Read Only: true

Returns the internal sequence number.
state: string
Read Only: true
Returns the message state in string representation consisting of one or more space-delimited state strings. State values include one or more of the following:
- visible
- send
- receive
- transaction
- ordered
- delayed
- expired
- redelivery-count-exceeded
- paused
- sequenced
- unit-of-work-component
xid: string

Read Only: true

Returns the Xid of associated global transaction or null.

{
    "type":"object",
    "properties":{
        "consumerID":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the consumer ID.</p>"
        },
        "destinationName":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the decorated name of the destination.</p>"
        },
        "messageSize":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the size of the message in bytes.</p>"
        },
        "messageType":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the type of message.  The values include:</p><ul><li><p>bytes</p></li><li><p>map</p></li><li><p>object</p></li><li><p>stream</p></li><li><p>text</p></li><li><p>xml</p></li></ul>"
        },
        "sequenceNumber":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the internal sequence number.</p>"
        },
        "state":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the message state in string representation consisting of one or more space-delimited state strings.  State values include one or more of the following:</p><ul><li><p>visible</p></li><li><p>send</p></li><li><p>receive</p></li><li><p>transaction</p></li><li><p>ordered</p></li><li><p>delayed</p></li><li><p>expired</p></li><li><p>redelivery-count-exceeded</p></li><li><p>paused</p></li><li><p>sequenced</p></li><li><p>unit-of-work-component</p></li></ul>"
        },
        "xid":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the Xid of associated global transaction or null.</p>"
        }
    },
    "description":""
}

Nested Schema : JMS Destination V

Type: object

Show Source

name: string

Read Only: true

Returns the decorated destination name.
serverName: string

Read Only: true

Returns the JMS server name.
type: string

Read Only: true

Returns the destination type (queue, topic or anonymous)

{
    "type":"object",
    "properties":{
        "name":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the decorated destination name.</p>"
        },
        "serverName":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the JMS server name.</p>"
        },
        "type":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the destination type (queue, topic or anonymous)</p>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Read Only: true

Returns the message properties

Show Source

Array of: object JMS Message Property V

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/JMS Message Property V"
    },
    "description":"<p>Returns the message properties</p>"
}

Nested Schema : JMS Message Property V

Type: object

Show Source

name: string

Read Only: true

Returns the property name.
type: string

Read Only: true

Returns the property type. Type values include boolean, byte, short, int, long, float, double, and String.
value: string

Read Only: true

Returns the proeprty value.

{
    "type":"object",
    "properties":{
        "name":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the property name.</p>"
        },
        "type":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the property type.  Type values include boolean, byte, short, int, long, float, double, and String.</p>"
        },
        "value":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the proeprty value.</p>"
        }
    },
    "description":""
}