Jump to

• Request
• Response

Get Messages

post

/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/SAFRuntime/agents/{name}/remoteEndpoints/{name}/getMessages

Queries messages on the queue according to the 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. If the cursor expires, the associated resources are 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 or SAF message selector.

• timeout(optional): integer(int32)

  Specifies the amount of time the message cursor is valid. A value of 0 indicates the cursor does not expire.

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "selector":{
            "type":"string",
            "description":"<p>A valid JMS message selector or SAF message selector.</p>"
        },
        "timeout":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Specifies the amount of time the message cursor is valid.  A value of 0 indicates the cursor does not expire.</p>"
        }
    },
    "description":""
}

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.
• Monitor: basic
  Type: basic

  Description: A user in the Monitor security role.
• Operator: basic
  Type: basic

  Description: A user in the Operator 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