RESTful Server Runtime Management Interface for Oracle WebLogic Server

Export Messages

post

/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/exportMessages

Exports the messages matching the selector to the specified file in XML representation.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header.

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

Prefer: string

The 'Prefer' header parameter can be used to specify the preference on how this method runs. A value of 'respond-async' specifies a preference to submit the request and return immediately without waiting for completion. Alternatively a value of 'wait=#seconds' specifies a preference to wait for #seconds for method completion before returning. If the Prefer header is not specified or invalid, then a 300 second wait will be used.
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

file: string

The absolute path of the file to which the matching messages will be written.
selector: string

A JMS message selector.
timeout: integer(int32)

The maximum amount of time in seconds to perform the export operation. A value of 0 indicates no timeout applies.

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "file":{
            "type":"string",
            "description":"<p>The absolute path of the file to which the matching messages will be written.</p>"
        },
        "selector":{
            "type":"string",
            "description":"<p>A JMS message selector.</p>"
        },
        "timeout":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The maximum amount of time in seconds to perform the export operation. A value of 0 indicates no timeout applies.</p>"
        }
    },
    "description":""
}

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: array JMS Message Management Task Runtime Reference

Title: JMS Message Management Task Runtime Reference

Contains the JMS message management task runtime reference.
Returns the action's result.

{
    "type":"object",
    "title":"Return",
    "properties":{
        "return":{
            "title":"JMS Message Management Task Runtime Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the JMS message management task runtime reference. <p>Returns the action's result.</p>"
        }
    },
    "description":""
}

Nested Schema : JMS Message Management Task Runtime Reference

Type: array

Title: JMS Message Management Task Runtime Reference

Contains the JMS message management task runtime reference.

Returns the action's result.

Show Source

Array of: string

{
    "title":"JMS Message Management Task Runtime Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the JMS message management task runtime reference. <p>Returns the action's result.</p>"
}