RESTful Server Runtime Management Interface for Oracle WebLogic Server

Sort

post

/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/destinations/{name}/sort

Sorts the entire message result set managed by the cursor according to the JMS header attributes specified. The cursor position is set to the new position of the message corresponding to the "start" location before the sort is performed. The method returns the new cursor position.

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'.

Must contain the following fields:

Root Schema : Arguments

Type: object

Title: Arguments

Show Source

ascending(optional): array Items

Title: Items

Determines whether the sort of the corresponding fields element is in ascending or descending order.
cursorHandle(optional): string

The handle of the cursor.
fields(optional): array Items

Title: Items

The JMS header attributes on which to sort.
start(optional): integer(int64)

The location of the message before the sort that will be the first message returned after the sort. A value of -1 will place the cursor start position at the head of the new sort order.

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "ascending":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"boolean",
                "description":""
            },
            "description":"<p>Determines whether the sort of the corresponding fields element is in ascending or descending order.</p>"
        },
        "cursorHandle":{
            "type":"string",
            "description":"<p>The handle of the cursor.</p>"
        },
        "fields":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The JMS header attributes on which to sort.</p>"
        },
        "start":{
            "type":"integer",
            "format":"int64",
            "description":"<p>The location of the message before the sort that will be the first message returned after the sort.  A value of -1 will place the  cursor start position at the head of the new sort order.</p>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Determines whether the sort of the corresponding fields element is in ascending or descending order.

Show Source

Array of: boolean

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"boolean",
        "description":""
    },
    "description":"<p>Determines whether the sort of the corresponding fields element is in ascending or descending order.</p>"
}

Nested Schema : Items

Type: array

Title: Items

The JMS header attributes on which to sort.

Show Source

Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The JMS header attributes on which to sort.</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(optional): integer(int64)

Returns the action's result.

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