Jump to

• Request
• Response

Get Messages ( Selector, Timeout )

post

/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/JMSRuntime/JMSServers/{name}/destinations/{name}/getMessages

Queries messages on the queue according to the provided message selector and returns a message cursor representing the result set. The timeout parameter specifies the amount of time in seconds for which the cursor is valid. Upon timeout expiration the cursor is invalidated and the associated resources released.

Request

Supported Media Types

• application/json

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Header Parameters

• X-Requested-By: 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'.

Body ()

Must contain the following fields:

Root Schema : Arguments

Type: object

Title: Arguments

Show Source

• selector(optional): string

  A valid JMS message selector.

• timeout(optional): integer(int32)

  The last access timeout for the cursor. The cursor resources will be reclaimed if it is not accessed within the specified time interval. A value of 0 indicates no timeout.

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "selector":{
            "type":"string",
            "description":"<p>A valid JMS message selector.</p>"
        },
        "timeout":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The last access timeout for the cursor.  The cursor  resources will be reclaimed if it is not accessed within the specified  time interval.  A value of 0 indicates no timeout.</p>"
        }
    },
    "description":""
}

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the following fields:

Body ()

Root Schema : Return

Type: object

Title: Return

Show Source

• return(optional): string

  Returns the action's result.

{
    "type":"object",
    "title":"Return",
    "properties":{
        "return":{
            "type":"string",
            "description":"<p>Returns the action's result.</p>"
        }
    },
    "description":""
}

Back to Top