RESTful Domain Runtime Management Interface for Oracle WebLogic Server

Rollout Update

post

/management/weblogic/{version}/domainRuntime/rolloutService/rolloutUpdate

Creates and starts a workflow that can be used to update OracleHome, JavaHome, Applications, or any combination of those. rolloutUpdate(target, [patchedOracleHome, backupOracleHome, isRollback], [javaHome], [applicationProperties], [options])

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

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

applicationProperties: string

the path of a formatted text file containing the information needed to upgrade applications
backupOracleHome: string

the location where the current OracleHome should be moved
isRollback: string

true if the new OracleHome is a lower patch version than the current one
javaHome: string

the path to the new JavaHome directory
options: string

comma separated list of = options
rolloutOracleHome: string

the location of the new OracleHome to use
target: string

can be the name of a domain, clusters or servers

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "applicationProperties":{
            "type":"string",
            "description":"<p>the path of a formatted text file containing the information needed to upgrade applications</p>"
        },
        "backupOracleHome":{
            "type":"string",
            "description":"<p>the location where the current OracleHome should be moved</p>"
        },
        "isRollback":{
            "type":"string",
            "description":"<p>true if the new OracleHome is a lower patch version  than the current one</p>"
        },
        "javaHome":{
            "type":"string",
            "description":"<p>the path to the new JavaHome directory</p>"
        },
        "options":{
            "type":"string",
            "description":"<p>comma separated list of <name>=<value> options</p>"
        },
        "rolloutOracleHome":{
            "type":"string",
            "description":"<p>the location of the new OracleHome to use</p>"
        },
        "target":{
            "type":"string",
            "description":"<p>can be the name of a domain, clusters or servers</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 Workflow Task Runtime Reference

Title: Workflow Task Runtime Reference

Contains the workflow task runtime reference.
Returns the action's result.

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

Nested Schema : Workflow Task Runtime Reference

Type: array

Title: Workflow Task Runtime Reference

Contains the workflow task runtime reference.

Returns the action's result.

Show Source

Array of: string

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