1 Resources

This documentation describes the Oracle WebLogic Server Multitenant RESTful domain runtime resources that are used to monitor the specified WLS domain partition.

For a complete listing of the WLS REST reference documents and descriptions of their use, see Administering Oracle WebLogic Server with RESTful Management Services.

/management/weblogic

This resource is used to access the different versions of the resources in this domain.

The latest version is 12.2.1.3.0. The other versions, which are deprecated, are 12.2.1.0.0, 12.2.1.1.0, 12.2.1.2.0.

For future releases, latest always refers to the most recent release.

All new and non-deprecated MBean features are available in all versions. Any MBean features that were deprecated in a version will not be available in that version or later versions, but will still be available using earlier versions.

To always use the latest resources, use latest in the URLs. Note that this might require updating a client when moving to a newer version of WebLogic Server. To fix the version so that an update is not required, use 12.2.1.3.0 in the URLs.

The resource supports the following methods:

GET

Get this collection of weblogic.management.rest.bean.model.Version instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.rest.bean.model.Version entities.

This method can return the following links:

  • uri=/management/weblogic rel=canonical

    This resource.

  • uri=/management/weblogic/12.2.1.3.0 rel=current

    Access the latest version of the WLS resources in the this domain.

  • uri=/management/weblogic rel=self

    This resource.

Example

Example 1   View the versions collection.

This example uses the GET method to display the version instances in this collection.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [
        {
            "rel": "self",
            "href": "http:\//localhost:7001/management/weblogic"
        },
        {
            "rel": "canonical",
            "href": "http:\//localhost:7001/management/weblogic"
        },
        {
            "rel": "current",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.3.0"
        }
    ],
    "items": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http:\//localhost:7001/management/weblogic/12.2.1.0.0"
                },
                {
                    "rel": "canonical",
                    "href": "http:\//localhost:7001/management/weblogic/12.2.1.0.0"
                }
            ],
            "version": "12.2.1.0.0",
            "isLatest": false,
            "lifecycle": "deprecated"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http:\//localhost:7001/management/weblogic/12.2.1.1.0"
                },
                {
                    "rel": "canonical",
                    "href": "http:\//localhost:7001/management/weblogic/12.2.1.1.0"
                }
            ],
            "version": "12.2.1.1.0",
            "isLatest": false,
            "lifecycle": "deprecated"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http:\//localhost:7001/management/weblogic/12.2.1.2.0"
                },
                {
                    "rel": "canonical",
                    "href": "http:\//localhost:7001/management/weblogic/12.2.1.2.0"
                }
            ],
            "version": "12.2.1.2.0",
            "isLatest": false,
            "lifecycle": "deprecated"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http:\//localhost:7001/management/weblogic/12.2.1.3.0"
                },
                {
                    "rel": "canonical",
                    "href": "http:\//localhost:7001/management/weblogic/12.2.1.3.0"
                }
            ],
            "version": "12.2.1.3.0",
            "isLatest": true,
            "lifecycle": "active"
        }
    ]
}

/management/weblogic/{version}

This resource describes the resource trees that are used to manage a WebLogic Server domain and its managed servers. The resource trees mimic the bean trees in WLST and allow you to view and edit configuration and monitor runtime behavior.

The resource supports the following methods:

GET

Get this weblogic.management.rest.bean.model.Version instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.rest.bean.model.Version entity.

This method can return the following links:

  • uri=/management/weblogic/{version} rel=canonical

    This resource.

  • uri=/management/weblogic/{version}/currentUser rel=currentUser

  • uri=/management/weblogic/{version}/domainConfig rel=domainConfig

  • uri=/management/weblogic/{version}/domainRuntime rel=domainRuntime

  • uri=/management/weblogic/{version}/edit rel=edit

  • uri=/management/weblogic rel=parent

    The parent resource of this resource.

  • uri=/management/weblogic/{version} rel=self

    This resource.

  • uri=/management/weblogic/{version}/serverConfig rel=serverConfig

  • uri=/management/weblogic/{version}/serverRuntime rel=serverRuntime

Example

Example 1   View the latest version.

This example uses the GET method to display the latest version.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/latest

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [
        {
            "rel": "parent",
            "href": "http:\//localhost:7001/management/weblogic"
        },
        {
            "rel": "self",
            "href": "http:\//localhost:7001/management/weblogic/latest"
        },
        {
            "rel": "canonical",
            "href": "http:\//localhost:7001/management/weblogic/latest"
        },
        {
            "rel": "edit",
            "href": "http:\//localhost:7001/management/weblogic/latest/edit"
        },
        {
            "rel": "domainConfig",
            "href": "http:\//localhost:7001/management/weblogic/latest/domainConfig"
        },
        {
            "rel": "domainRuntime",
            "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime"
        },
        {
            "rel": "serverRuntime",
            "href": "http:\//localhost:7001/management/weblogic/latest/serverRuntime"
        },
        {
            "rel": "serverConfig",
            "href": "http:\//localhost:7001/management/weblogic/latest/serverConfig"
        },
        {
            "rel": "currentUser",
            "href": "http:\//localhost:7001/management/weblogic/latest/currentUser"
        }
    ],
    "version": "12.2.1.3.0",
    "isLatest": true,
    "lifecycle": "active"
}
Example 2   View a specific version.

This example uses the GET method to display a specific version.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/12.2.1.3.0

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [
        {
            "rel": "parent",
            "href": "http:\//localhost:7001/management/weblogic"
        },
        {
            "rel": "self",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.3.0"
        },
        {
            "rel": "canonical",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.3.0"
        },
        {
            "rel": "edit",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.3.0/edit"
        },
        {
            "rel": "domainConfig",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.3.0/domainConfig"
        },
        {
            "rel": "domainRuntime",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.3.0/domainRuntime"
        },
        {
            "rel": "serverRuntime",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.3.0/serverRuntime"
        },
        {
            "rel": "serverConfig",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.3.0/serverConfig"
        },
        {
            "rel": "currentUser",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.3.0/currentUser"
        }
    ],
    "version": "12.2.1.3.0",
    "isLatest": true,
    "lifecycle": "active"
}

/management/weblogic/{version}/currentUser

This resource represents an authenticated user in the domain.

The resource supports the following methods:

GET

Get this weblogic.management.rest.bean.model.CurrentUser instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.rest.bean.model.CurrentUser entity.

This method can return the following links:

Example

Example 1   Viewing the weblogic.management.rest.bean.model.CurrentUser Instance

This example uses the GET method to view this weblogic.management.rest.bean.model.CurrentUser instance.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/latest/currentUser

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [
        {
            "rel": "parent",
            "href": "http:\//localhost:7001/management/weblogic/latest"
        },
        {
            "rel": "self",
            "href": "http:\//localhost:7001/management/weblogic/latest/currentUser"
        },
        {
            "rel": "canonical",
            "href": "http:\//localhost:7001/management/weblogic/latest/currentUser"
        }
    ],
    "partitionId": "0",
    "partitionName": "DOMAIN",
    "user": "admin"
}

/management/weblogic/{version}/domainRuntime

This resource is used to monitor the entire WebLogic Server domain.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.DomainRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.DomainRuntimeMBean entity.

This method can return the following links:

Example

Example 1   Viewing the weblogic.management.runtime.DomainRuntimeMBean Instance

This example uses the GET method to view this weblogic.management.runtime.DomainRuntimeMBean instance.

Example Request

curl -v \
--user BUCAdmin:BUCAdmin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/BUC/management/weblogic/latest/domainRuntime

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [
        {
            "rel": "parent",
            "href": "http:\//localhost:7001/BUC/management/weblogic/latest"
        },
        {
            "rel": "currentDomainPartitionRuntime",
            "href": "http:\//localhost:7001/BUC/management/weblogic/latest/domainRuntime/domainPartitionRuntimes/BUCPartition"
        },
        {
            "rel": "self",
            "href": "http:\//localhost:7001/BUC/management/weblogic/latest/domainRuntime"
        },
        {
            "rel": "canonical",
            "href": "http:\//localhost:7001/BUC/management/weblogic/latest/domainRuntime"
        },
        {
            "rel": "domainPartitionRuntimes",
            "href": "http:\//localhost:7001/BUC/management/weblogic/latest/domainRuntime/domainPartitionRuntimes"
        },
        {
            "rel": "serverRuntimes",
            "href": "http:\//localhost:7001/BUC/management/weblogic/latest/domainRuntime/serverRuntimes"
        },
        {
            "rel": "search",
            "href": "http:\//localhost:7001/BUC/management/weblogic/latest/domainRuntime/search"
        }
    ],
    "identity": [],
    "name": "bean",
    "type": "DomainRuntime",
    "currentDomainPartitionRuntime": [
        "domainPartitionRuntimes",
        "BUCPartition"
    ]
}

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes

This resource manages a collection of weblogic.management.runtime.DomainPartitionRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.DomainPartitionRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.DomainPartitionRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}

This resource manages a weblogic.management.runtime.DomainPartitionRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.DomainPartitionRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.DomainPartitionRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime

This resource manages a weblogic.management.runtime.AppRuntimeStateRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.AppRuntimeStateRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.AppRuntimeStateRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getCurrentState

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Aggregate state for the application. This is defined as the most advanced state of the application's modules on the named target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

target

logical target where the app is deployed

Type: string

Response Body

Contains a JSON object with a string return field.

POST

Aggregate state for the module. This is defined as the most advanced state of the module on all servers associated with the named target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

target

logical target where module is deployed

Type: string

Response Body

Contains a JSON object with a string return field.

POST

Aggregate state for a submodule. This is defined as the most advanced state of the submodule on all servers associated with the named target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

subModuleId

subModuleId

Type: string

target

logical target where module is deployed

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getIntendedState

The resource supports the following methods:

POST

The resource supports the following methods:

POST

The state the application should be in.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a string return field.

POST

The state the application should be in on a specific target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

target

target

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleIds

The resource supports the following methods:

POST

Names of the modules contained in the application. This does not include submodules.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleTargets

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Logical targets where the submodule is deployed.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

subModuleId

subModuleId

Type: string

Response Body

Contains a JSON object with a array of string return field.

POST

Logical targets where the module is deployed.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleType

The resource supports the following methods:

POST

Indicates the type of module: EAR, WAR, etc.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getMultiVersionStateOnDemand

The resource supports the following methods:

POST

For each configured ids provided, identify all inferred ids on each of managed server to which the configured ids are targeted.

Admin Server contacts all relevant servers identified by target on demand. Some of the managed servers might be slow in responding or may not respond at all. The use of timeout ensures an upper limit on the time Admin Server will wait for response from managed servers. Though not recommended, a value of 0 timeout may be used to indefinitely wait for response from all managed servers. Admin Server only contacts the managed server that are known to be running at this time.

This result also includes servers that did not respond. But it does not include servers that were known to be shutdown at the time of request and were never contacted.

Here is an example result:

({"landscapedesign#V2.0", "soilmanagement"}, 100L) <multi-version-state xmlns="http://xmlns.oracle.com/weblogic/multi-version-state" version="1.0"> <unresponsive> <target>ms5</target> <target>ms10</target> </unresponsive> <configured-id id="landscapedesign#V2.0"> <inferred-id id="landscapedesign#V2.0.2"> <state value="STATE_ACTIVE"> <target>ms1</target> <target>ms2</target> <target>ms3</target> <target>ms4</target> </state> </inferred-id> </configured-id> <configured-id id="soilmanagement"> <inferred-id id="soilmanagement#1"> <state value="STATE_ACTIVE"/> <target>ms1</target> <target>ms2</target> <target>ms3</target> <target>ms4</target> <target>ms6</target> <target>ms7</target> <target>ms8</target> <target>ms9</target> </state> </inferred-id> </configured-id> </multi-version-state>

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

configuredIds

A list of application ids or library's deployment ids as configured in config.xml. This is the list for which state is being requested

Type: array of string

timeout

amount of time in milliseconds before the command times out. Though not recommended, a value of 0 may be used to wait indefinitely

Type: integer/int64

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeMillis

The resource supports the following methods:

POST

The time when the application will be retired.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a integer/int64 return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeoutSeconds

The resource supports the following methods:

POST

The amount of time the application is given to retire.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a integer/int32 return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getSubmoduleIds

The resource supports the following methods:

POST

Submodules associated with this module.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isActiveVersion

The resource supports the following methods:

POST

Indicates if the application is the active version, the one that new sessions will use.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

is the application id

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isAdminMode

The resource supports the following methods:

POST

Indicates if the application should only be available through the administration port. This is the desired state of the application.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

is the application id

Type: string

target

target

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager

This resource manages a weblogic.management.runtime.DeploymentManagerMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.DeploymentManagerMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.DeploymentManagerMBean entity.

This method can return the following links:

POST

Update this weblogic.management.runtime.DeploymentManagerMBean instance.

Roles

Admin, Deployer

Request Body

Must contain a weblogic.management.runtime.DeploymentManagerMBean entity.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes

This resource manages a collection of weblogic.management.runtime.AppDeploymentRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.AppDeploymentRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.AppDeploymentRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}

This resource manages a weblogic.management.runtime.AppDeploymentRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.AppDeploymentRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.AppDeploymentRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/getState

The resource supports the following methods:

POST

The state of the application for a target. Notifications will be generated for this attribute on state changes. Valid states are those supported by the weblogic.management.runtime.AppRuntimeStateRuntimeMBean The notification types are appdeployment.created, appdeployment.deleted, appdeployment.state.new, appdeployment.state.prepared, appdeployment.state.admin, appdeployment.state.active, appdeployment.state.retired, appdeployment.state.failed, appdeployment.state.update.pending, and appdeployment.state.unknown. The userdata is a Map where the keys are target names and the values are the application state for that target.

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

target

the target for the application state

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/redeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Redeploy the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to redeploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.

Type: array of string

applicationPath

A supported Java EE application or module archive, or a root diectory for the application or module. May be null.

Type: string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: null

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Redeploy the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to redeploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.

Type: array of string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: null

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Redeploy the application using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

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

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/start

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Start the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to start the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be started on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: null

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Start the application using the default options and configured targets. This is a synchronous operation that returns when the start operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

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

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/stop

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Stop the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to stop the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be stoped on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: null

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Stop the application using the default options and configured targets. This is a synchronous operation that returns when the stop operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

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

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/undeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Undeploy the application using the default options and configured targets. This is a synchronous operation that returns when the undeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

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

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Undeploy the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to undeploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be undeployed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: null

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/update

The resource supports the following methods:

POST

Allows for updating an application configuration using an changed deployment plan.

A configuration update is equivalent to replacing the application's deployment plan. The deployment plan is redeployed in-place. A new version of the application is not started, even if the new deployment plan has a different version.

The update succeeds only if changes to the deployment plan do not require the application to be restarted. Configuration changes in the new deployment plan must be limited to tuning the application. Changes to resource bindings causes the update to fail. Use redeploy() to apply resource binding changes to a production application.

This method targets only root modules. Module level targeting is not supported.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

represent the targets on which to update the application.

Type: array of string

plan

The deployment plan containing the new deployment configuration information.

Type: string

deploymentOptions

Allows for overriding the deployment options. May be null.

Type: null

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appendToExtensionLoader

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Appends a code source to the search path of the WebLogic Extension Loader, which is also referred to as the WebLogic Domain Loader. The code source file is distributed to the targets using the options specified. When the operation is complete, classes and resources in the jar file will be visible for class loading at the extension loader. Since the jar is now in place on targeted servers, the classes and resources will continue to be available even after a targeted server restarts. This is an asynchronous operation that returns immediately.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

codeSourcePath

A jar file to add to the extension loader

Type: string

targets

The targets on which to distribute the code source. This would be server names or cluster names. If null, the code source will be distributed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, retireTimeout seconds -1 (no timeout), timeout milliseconds 0 (no timeout)

Type: null

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Appends a code source to the search path of the WebLogic Extension Loader, which is also referred to as the WebLogic Domain Loader. The code source file is distributed to all targets using default options. When the operation is complete, classes and resources in the jar file will be visible for class loading at the extension loader. Since the jar is now in place on targeted servers, the classes and resources will continue to be available even after a targeted server restarts. This is an asynchronous operation that returns immediately.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

codeSourcePath

A jar file to add to the extension loader

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/confirmApplicationName

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Used by the deployment subsystem to confirm an application name.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

isRedeployment

should be true in the case where this function is called for a redeployment.

Type: boolean

appSource

is a the path to the application.

Type: string

optional

alternate app descriptor.

Type: string

tentativeName

The name proposed for the application (provided by the user, or through the manifest). Null if no name was specified by the user or through the manifest.

Type: string

tentativeApplicationId

The tentative application ID. May only be null if the application is not versioned. If tentativeName is null and the application is versioned, this should be just the version string (which includes both the implementation and specification versions).

Type: string

deploymentOptions

deployment options

Type: null

Response Body

Contains a JSON object with a string return field.

POST

Used by the deployment subsystem to confirm an application name.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

isRedeployment

should be true in the case where this function is called for a redeployment.

Type: boolean

appSource

is a the path to the application.

Type: string

optional

alternate application descriptor path

Type: string

tentativeName

The name proposed for the application (provided by the user, or through the manifest). Null if no name was specified by the user or through the manifest.

Type: string

tentativeApplicationId

The tentative application ID. May only be null if the application is not versioned. If tentativeName is null and the application is versioned, this should be just the version string (which includes both the implementation and specification versions).

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

A convenience method for distributing and starting an application.

The application source files and deployment plan are distributed to the deployment targets using the default options. This is a synchronous operation that returns when the deploy operation has completed. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.

The default options are

  • clusterDeploymentTimeout: 3600000 milliseconds

  • gracefulIgnoreSessions: false

  • gracefulProductionToAdmin: false

  • retireGracefully: true

  • retireTimeout: no timeout

  • adminMode: false

  • timeout: no timeout

If any modules are currently running, this method immediately restarts those modules using the newer files. Restarting modules in this manner is not the same as redeployment, because session state is not preserved for the active modules.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

A supported Java EE application or module archive, or a root directory for the application or module.

Type: string

plan

The deployment plan for this application. May be null.

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

A convenience method for distributing and starting an application. The application source files and deployment plan are distributed to the deployment targets using the options specified. This is an asynchronous operation that returns immediately. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.

If any modules are currently running, this method immediately restarts those modules using the newer files. Restarting modules in this manner is not the same as redeployment, because session state is not preserved for the active modules.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

A supported Java EE application or module archive, or a root directory for the application or module.

Type: string

targets

The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.

Type: array of string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: null

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects

This resource manages a collection of weblogic.management.runtime.DeploymentProgressObjectMBean instances.

The resource supports the following methods:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}

This resource manages a weblogic.management.runtime.DeploymentProgressObjectMBean instance.

The resource supports the following methods:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}/cancel

The resource supports the following methods:

POST

Attempt to cancel the deployment operation. Any actions which have yet to start will be inhibited. Any completed actions will remain in place.

Roles

Admin, Deployer

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}/getExceptions

The resource supports the following methods:

POST

If the current deployment operation has failed, this method may return zero or more exception(s) which represent the errors for this target. The array will not contain WLS exception classes; instead they will be new RuntimeExceptions containing the stack traces and messages from the original WLS Exceptions.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

target

the target where exceptions might have occurred.

Type: string

Response Body

Contains a JSON object with a array of null return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/distribute

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Distribute an application.

The application source files and deployment plan are distributed to the deployment targets using the default options. This is a synchronous operation that returns when the distribute operation has completed.

The default options are:

  • clusterDeploymentTimeout: 3600000 milliseconds

  • gracefulIgnoreSessions: false

  • gracefulProductionToAdmin: false

  • retireGracefully: true

  • retireTimeout: no timeout

  • adminMode: false,

  • timeout: no timeout

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

A supported Java EE application or module archive, or a root directory for the application or module.

Type: string

plan

The deployment plan for this application. May be null.

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Distribute an application. The application source files and deployment plan are distributed to the deployment targets using the options specified. This is an asynchronous operation that returns immediately.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

A supported Java EE application or module archive, or a root directory for the application or module.

Type: string

targets

The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be distributed on all configured targets.

Type: array of string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: null

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes

This resource manages a collection of weblogic.management.runtime.LibDeploymentRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.LibDeploymentRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.LibDeploymentRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}

This resource manages a weblogic.management.runtime.LibDeploymentRuntimeMBean instance.

The resource supports the following methods:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}/redeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Redeploy the library in the background for the targets specified with the options specified. This is an synchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to redeploy the library. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the library will be redeployed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The keys,units and default values for options are adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: null

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Redeploy the library using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are adminMode: false, timeout: no timeout

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

Roles

Admin, Deployer

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}/undeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Undeploy the library using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are adminMode boolean false timeout: no timeout

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

Roles

Admin, Deployer

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Undeploy the library in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to undeploy the library. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the library will be undeployed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are adminMode boolean false timeout milliseconds 0 (no timeout)

Type: null

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/purgeCompletedDeploymentProgressObjects

The resource supports the following methods:

POST

Removes progress objects for completed operations.

Roles

Admin, Deployer

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/redeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Redeploy the application that is deployed to a resource group template in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

Note that this API is only for redeploying applications or libraries that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for redeploying applications that are not deployed to a resource group template, and LibDeploymentRuntimeMBean should be used for redeploying libraries that are not deployed to a resource group template.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

applicationPath

A supported Java EE application or module archive, or a root diectory for the application or module. May be null.

Type: string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: null

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Redeploy the application that is deployed to a resource group template in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

Note that this API is only for redeploying applications or libraries that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for redeploying applications that are not deployed to a resource group template, and LibDeploymentRuntimeMBean should be used for redeploying libraries that are not deployed to a resource group template.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: null

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/undeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Undeploy the application that is deployed to a resource group template using the default options. This is a synchronous operation that returns when the undeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

template

The resource group template

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Undeploy the application that is deployed to a resource group template in the background with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

Note that this API is only for undeploying applications that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for undeploying applications that are not deployed to a resource group template.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: null

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/update

The resource supports the following methods:

POST

Allows for updating an application configuration using an changed deployment plan for applications deployed to a resource group template.

A configuration update is equivalent to replacing the application's deployment plan. The deployment plan is redeployed in-place. A new version of the application is not started, even if the new deployment plan has a different version.

The update succeeds only if changes to the deployment plan do not require the application to be restarted. Configuration changes in the new deployment plan must be limited to tuning the application. Changes to resource bindings causes the update to fail. Use redeploy(String, String, Properties) to apply resource binding changes to a production application.

This method targets only root modules. Module level targeting is not supported.

Note that this API is only for updating applications that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for updating applications that are not deployed to a resource group template.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: null

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager

This resource manages a weblogic.management.runtime.EditSessionConfigurationManagerMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.EditSessionConfigurationManagerMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.EditSessionConfigurationManagerMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurationCreateForm

This resource manages the create forms for the editSessionConfigurations collection resource.

The resource supports the following methods:

GET

This resource returns a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity populated with default values that can be customized then posted (using the POST method) to the editSessionConfigurations collection resource to create a new instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations

This resource manages a collection of weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instances.

The resource supports the following methods:

POST

Add a new weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance to this collection.

Roles

Admin, Deployer

Request Body

Must contain a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations/{name}

This resource manages a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.

The resource supports the following methods:

DELETE

Delete this weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.

Roles

Admin, Deployer

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges

The resource supports the following methods:

POST

Returns true if there are changes saved in the pending directory or there are changes in memory. To apply these changes, activate the session.

Roles

Admin, Deployer

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/forceDestroyEditSessionConfiguration

The resource supports the following methods:

POST

Destroys an existing named edit session configuration. This will destroy the associated edit session specific MBeanServer and remove the <domain>/edit/<name> or <domain>/partitions/<name>/edit/<name> directory and subdirectories.

Unlike destroyEditSessionConfiguration(EditSessionConfigurationRuntimeMBean), this operation does not end with error in case that session contains unactivated changes, and allows to destroy even edit sessions not owned by the caller (requires admin privileges).

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

editSession

Edit session to destroy.

Type: weblogic.management.runtime.EditSessionConfigurationRuntimeMBean reference

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime

This resource manages a weblogic.management.runtime.PartitionLifeCycleRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.PartitionLifeCycleRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.PartitionLifeCycleRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/boot

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins the transition of the partition from the SHUTDOWN state and HALTED substate to the SHUTDOWN state and BOOTED substate on the specified targets.

This operation has the effect of starting the partition's administrative resource groups on those targets, changing their states on those targets from SHUTDOWN to RUNNING

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

Please use PartitionLifeCycleRuntimeMBean.boot(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to boot this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the transition of the partition from the SHUTDOWN state and HALTED substate to the SHUTDOWN state and BOOTED substate on the specified targets.

This operation has the effect of starting the partition's administrative resource groups on those targets, changing their states on those targets from SHUTDOWN to RUNNING

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to boot this partition

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the transition of the partition from the SHUTDOWN state and HALTED substate to the SHUTDOWN state and BOOTED substate on all targeted servers.

This operation has the effect of starting the partition's administrative resource groups, changing their states from SHUTDOWN to RUNNING

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceShutdown

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins to force the shutdown of this partition with the specified timeout on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

timeout

Type: integer/int32

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to force the shutdown of this partition on all targeted servers.

On each targeted server the partition is shut down and thenrestored to its current state on that server.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to force the shut down of this partition on the specified targets.

On each target the partition is shut down and then restored to its current state on that server.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to shut down this partition

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to force the shut down of this partition on the specified targets.

On each target the partition is shut down and then restored to its current state on that server.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

Please use PartitionLifeCycleRuntimeMBean.forceShutdown(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to shut down this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceSuspend

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins the forceful transition of the partition from the RUNNING state to the ADMIN state on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the forceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to suspend this partition

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the forceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

Please use PartitionLifeCycleRuntimeMBean.forceSuspend(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to suspend this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/getState

The resource supports the following methods:

POST

The resource supports the following methods:

POST

The state of the partition on a specific server.

This method has been deprecated in favor of retrieving partition state correctly on dynamic servers. ServerMBean does not exist for dynamic servers in the domain runtime tree. So, although invoking this method from domain runtime tree works for static servers, does not work for dynamic servers.

Please use PartitionLifeCycleRuntimeMBean.getState(String serverName)

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

serverMBean

serverMBean

Type: weblogic.management.configuration.ServerMBean reference

Response Body

Contains a JSON object with a string return field.

POST

The current state of the partition on a specific server.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

serverName

name of the server on which the substate to check

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/getSubState

The resource supports the following methods:

POST

The resource supports the following methods:

POST

The current substate of the partition on a specific server.

This method has been deprecated in favor of retrieving partition substate correctly on dynamic servers. ServerMBean does not exist for dynamic servers in the domain runtime tree. So, although invoking this method from domain runtime tree works for static servers, does not work for dynamic servers.

Please use PartitionLifeCycleRuntimeMBean.getSubState(ServerLifeCycleRuntimeMBean serverLifeCycleRuntimeMBean)

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

serverMBean

the server on which the substate to check

Type: weblogic.management.configuration.ServerMBean reference

Response Body

Contains a JSON object with a string return field.

POST

The current substate of the partition on a specific server.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

serverName

name of the server on which the substate to check

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/halt

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins the forceful transition of the partition from the RUNNING state or the ADMIN state to the SHUTDOWN state and HALTED substate on a specific set of targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to halt this partition

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the forceful transition of the partition from the RUNNING state or the ADMIN state to the SHUTDOWN state and HALTED substate on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the forceful transition of the partition from the RUNNING state or the ADMIN state to the SHUTDOWN state and HALTED substate on a specific set of targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

Please use PartitionLifeCycleRuntimeMBean.halt(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to halt this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/purgeTasks

The resource supports the following methods:

POST

Clears the retained task collection.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes

This resource manages a collection of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instances.

The resource supports the following methods:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}

This resource manages a weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/forceShutdown

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins to force the shutdown of this resource group on all targeted servers, changing its state to SHUTDOWN

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to force the shutdown of this resource group on the specified targets, changing its state to SHUTDOWN

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to force a shutdown on this resource group

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to force the shutdown of this resource group on the specified targets, changing its state to SHUTDOWN

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

Please use ResourceGroupLifeCycleTaskRuntimeMBean.forceShutdown(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to force a shutdown on this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/forceSuspend

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins the forceful transition of this resource group from the RUNNING state to the ADMIN state on all targeted servers.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the forceful transition of this resource group from the RUNNING state to the ADMIN state on the specified targets.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to force a suspend of this resource group

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the forceful transition of this resource group from the RUNNING state to the ADMIN state on the specified targets.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

Please use ResourceGroupLifeCycleTaskRuntimeMBean.forceSuspend(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/getState

The resource supports the following methods:

POST

The resource supports the following methods:

POST

The state of resource group on a specific server.

Please use ResourceGroupLifeCycleTaskRuntimeMBean.getState(String serverName)

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

serverMBean

serverMBean

Type: weblogic.management.configuration.ServerMBean reference

Response Body

Contains a JSON object with a string return field.

POST

The current state of the resource group on a specific server.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

serverName

name of the server to check

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/purgeTasks

The resource supports the following methods:

POST

Clears the retained task collection.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/resume

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins the transition of this resource group from the ADMIN state to the RUNNING state on all targeted servers.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the transition of this resource group from the ADMIN state to the RUNNING state on the specified targets.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

Please use ResourceGroupLifeCycleTaskRuntimeMBean.resume(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the transition of this resource group from the ADMIN state to the RUNNING state on the specified targets.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to resume this resource group

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins to shut down this resource group gracefully on the specified targets, changing its state to SHUTDOWN. (equivalent to shutdown(targets, 0, false)).

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

Please use ResourceGroupLifeCycleTaskRuntimeMBean.shutdown(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down this resource group gracefully on the specified targets, changing its state to SHUTDOWN. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: integer/int32

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

targetNames

the specific servers on which to shut down this resource group

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down this resource group gracefully on the specified targets, changing its state to SHUTDOWN.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

Please use ResourceGroupLifeCycleTaskRuntimeMBean.shutdown(int timeout, boolean ignoreSessions, boolean waitForAllSessions, TargetMBean[] targets)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: integer/int32

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

targets

the specific targets on which to shut down this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down this resource group gracefully on all targeted servers, changing its state to SHUTDOWN.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: integer/int32

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down this resource group gracefully on the specified targets, changing its state to SHUTDOWN. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

Please use ResourceGroupLifeCycleTaskRuntimeMBean.shutdown(int timeout, boolean ignoreSessions, String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: integer/int32

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

targets

the specific targets on which to shut down this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down this resource group gracefully on the specified targets, changing its state to SHUTDOWN. (equivalent to shutdown(targets, 0, false)).

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to shut down this resource group

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down the resource group gracefully on all targeted servers, changing its state to SHUTDOWN

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down this resource group gracefully on the specified targets, changing its state to SHUTDOWN.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: integer/int32

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

targetNames

the specific servers on which to shut down this resource group

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down this resource group gracefully on all targeted servers, changing its state to SHUTDOWN. (equivalent to shutdown(timeout, ignoreSessions, false)).

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: integer/int32

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/start

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins to start this resource group on all targeted servers, changing its state to RUNNING

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to start this resource group on the specified targets, changing its state to RUNNING

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to start this resource group

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to start this resource group on the specified targets, changing its state to RUNNING

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

Please use ResourceGroupLifeCycleTaskRuntimeMBean.start(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins to start this resource group in the admin state on all targeted servers, changing its state to ADMIN

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to start this resource group in the admin state on the specified targets, changing its state to ADMIN

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to start this resource group in "admin" state

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to start this resource group in the admin state on the specified targets, changing its state to ADMIN

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

Please use ResourceGroupLifeCycleTaskRuntimeMBean.startInAdmin(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group in "admin" state

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins to transition this resource group from RUNNING to ADMIN state gracefully on the specified targets.

Applications are in admin mode. Inflight work is completed.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

Please use ResourceGroupLifeCycleTaskRuntimeMBean.suspend(timeout, boolean ignoreSessions, String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.

Type: integer/int32

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the graceful transition of this resource group from the RUNNING state to the ADMIN state on all targeted servers. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to transition the resource group from RUNNING to ADMIN state gracefully on all targeted servers.

Applications are in admin mode. Inflight work is completed.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.

Type: integer/int32

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the graceful transition of this resource group from the RUNNING state to the ADMIN state on the specified targets. (equivalent to suspend(0, false, targets)) New requests are rejected and inflight work is allowed to complete.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to suspend this resource group

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to transition this resource group from RUNNING to ADMIN state gracefully on the specified targets.

Applications are in admin mode. Inflight work is completed.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.

Type: integer/int32

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

targetNames

the specific servers on which to suspend this resource group

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the graceful transition of this resource group from the RUNNING state to the ADMIN state on the specified targets. (equivalent to suspend(0, false, targets)) New requests are rejected and inflight work is allowed to complete.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

Please use ResourceGroupLifeCycleTaskRuntimeMBean.suspend(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks

This resource manages a collection of weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instances.

The resource supports the following methods:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}

This resource manages a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instance.

The resource supports the following methods:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resume

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins the transition of the partition from the ADMIN state to the RUNNING state on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the transition of the partition from the ADMIN state to the RUNNING state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

Please use PartitionLifeCycleRuntimeMBean.resume(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to resume this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the transition of the partition from the ADMIN state to the RUNNING state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to resume this partition

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/shutdown

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins to shut down this partition gracefully on the specified targets.

(Equivalent to shutdown(targets, 0, false)).

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

Please use PartitionLifeCycleRuntimeMBean.shutdown(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to shut down this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down this partition gracefully on the specified targets.

(Equivalent to shutdown(timeout, ignoreSessions, false, targets)).

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: integer/int32

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

targetNames

the specific servers on which to shut down this partition

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down this partition gracefully on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

Please use PartitionLifeCycleRuntimeMBean.shutdown(int timeout, boolean ignoreSessions, boolean waitForAllSessions, String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: integer/int32

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

targets

the specific targets on which to shut down this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down this partition gracefully on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: integer/int32

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down this partition gracefully on the specified targets.

(Equivalent to shutdown(timeout, ignoreSessions, false, targets)).

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

Please use PartitionLifeCycleRuntimeMBean.shutdown(int timeout, boolean ignoreSessions, String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: integer/int32

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

targets

the specific targets on which to shut down this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down this partition gracefully on the specified targets.

(Equivalent to shutdown(targets, 0, false)).

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to shut down this partition

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down this partition gracefully on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down this partition gracefully on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: integer/int32

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

targetNames

the specific servers on which to shut down this partition

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to shut down this partition gracefully on all targeted servers.

(Equivalent to shutdown(timeout, ignoreSessions, false, targets)).

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: integer/int32

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/start

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins to start this partition on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to start this partition in the specified initialState within the specified timeOut on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

initialState

can be can be ADMIN or RUNNING, default is RUNNING.

Type: string

timeOut

Specifies the number of milliseconds to start a Partition. Throws InterruptedException if Partition is unable to start during that duration and leaves the Partition in UNKNOWN state. Default is 60000ms

Type: integer/int32

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to start this partition on the specified servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to start this partition

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to start this partition on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

Please use PartitionLifeCycleRuntimeMBean.start(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/startInAdmin

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins to start this partition in the ADMIN state on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to start this partition in the ADMIN state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to start this partition in "admin" state

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins to start this partition in the ADMIN state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

Please use PartitionLifeCycleRuntimeMBean.startInAdmin(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition in "admin" state

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/suspend

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

Applications are in admin mode. Inflight work is completed.

Please use PartitionLifeCycleRuntimeMBean.suspend(int timeout, boolean ignoreSessions, String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the partition to transition gracefully. The partition automatically calls forceSuspend() after timeout.

Type: integer/int32

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

targets

the specific targets on which to suspend this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on all targeted servers.

(Equivalent to suspend(0, false))

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

New requests are rejected and inflight work is allowed to complete.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

Applications are in admin mode. Inflight work is completed.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the partition to transition gracefully. The partition automatically calls forceSuspend() after timeout.

Type: integer/int32

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets. (Equivalent to suspend(0, false, targets))

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

New requests are rejected and inflight work is allowed to complete.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targetNames

the specific servers on which to suspend this partition

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

Applications are in admin mode. Inflight work is completed.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the partition to transition gracefully. The partition automatically calls forceSuspend() after timeout.

Type: integer/int32

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

targetNames

the specific servers on which to suspend this partition

Type: array of string

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets. (Equivalent to suspend(0, false, targets))

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

New requests are rejected and inflight work is allowed to complete.

Please use PartitionLifeCycleRuntimeMBean.suspend(String[] targetNames)

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to suspend this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks

This resource manages a collection of weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean instances.

The resource supports the following methods:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}

This resource manages a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionUserFileSystemManager

This resource manages a weblogic.management.runtime.PartitionUserFileSystemManagerMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.PartitionUserFileSystemManagerMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.PartitionUserFileSystemManagerMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionUserFileSystemManager/deleteFile

The resource supports the following methods:

POST

Deletes specified file

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

filePath

file path relative to partition user file system root

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionUserFileSystemManager/exists

The resource supports the following methods:

POST

Checks whether specified file exists

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

filePath

file path relative to partition user file system root

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionUserFileSystemManager/list

The resource supports the following methods:

POST

Lists files from partition user file system directory

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

dirPath

directory path relative to partition user file system root

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionUserFileSystemManager/mkdir

The resource supports the following methods:

POST

Creates partition user file system subdirectory

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

dirPath

directory path relative to partition user file system root

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionUserFileSystemManager/rmdir

The resource supports the following methods:

POST

Deletes specified directory

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

dirPath

directory path relative to partition user file system root

Type: string

Response Body

Contains a JSON object with a boolean return field.

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

This resource manages a weblogic.management.runtime.RolloutServiceRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.RolloutServiceRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.RolloutServiceRuntimeMBean entity.

This method can return the following links:

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

This resource manages a collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.WorkflowTaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}

This resource manages a weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.WorkflowTaskRuntimeMBean entity.

This method can return the following links:

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

The resource supports the following methods:

POST

Delete workflow data of finished workflow

Roles

Admin, admin

Request Body

Must contain a JSON object with the following fields:

workflowId

is ID of workflow to be deleted - {@code WorkflowTaskRuntimeMBean.getWorkflowId()}

Type: string

Response Body

Contains an empty JSON object.

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

The resource supports the following methods:

POST

Continue in workflow execution. Can be called only for terminated workflows.

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

Roles

Admin, admin

Request Body

Must contain a JSON object with the following fields:

wfTask

which should be executed - continued. {@code delegate.isStopped()} must be {@code null}

Type: weblogic.management.runtime.WorkflowTaskRuntimeMBean reference

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

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

The resource supports the following methods:

POST

Returns {@code WorkflowTaskRuntimeMBean} for given id. Progress must NOT be yet deleted and must be started by this service.

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

Roles

Admin, admin

Request Body

Must contain a JSON object with the following fields:

id

of executed workflow

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

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

This resource manages a collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.WorkflowTaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}

This resource manages a weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.WorkflowTaskRuntimeMBean entity.

This method can return the following links:

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

The resource supports the following methods:

POST

Reverts workflow execution. Can be called only for terminated workflows.

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

Roles

Admin, admin

Request Body

Must contain a JSON object with the following fields:

wfTask

which should be reverted. {@code delegate.isStopped()} must be {@code null}

Type: weblogic.management.runtime.WorkflowTaskRuntimeMBean reference

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

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

The resource supports the following methods:

POST

Creates and starts a workflow that can be used to update restart servers, one at a time. 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. See About Synchronous and Asynchronous Operations.

Roles

Admin, admin

Request Body

Must contain a JSON object with the following fields:

target

can be the name of a domain, clusters or servers

Type: string

options

comma separated list of <name>=<value> options

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

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

The resource supports the following methods:

POST

Creates and starts a workflow that can be used to update Applications. rolloutUpdate(target, [applicationProperties], [options])

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

Roles

Admin, admin

Request Body

Must contain a JSON object with the following fields:

target

can be the name of a domain, clusters or servers

Type: string

applicationProperties

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

Type: string

options

comma separated list of <name>=<value> options

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

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

This resource manages a collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.WorkflowTaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}

This resource manages a weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.WorkflowTaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/search

The resource supports the following methods:

POST

Search the domainRuntime tree.

Roles

Admin, Deployer, Monitor, Operator

Request Body

The search request body includes the search criteria.

Response Body

The search response includes the results of the search.

/management/weblogic/{version}/domainRuntime/serverRuntimes

This resource manages a collection of weblogic.management.runtime.ServerRuntimeMBean instances.

Monitors all the running servers in the WebLogic Server domain from the administration server. From this resource, you can monitor each managed server.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.ServerRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.ServerRuntimeMBean entities.

This method can return the following links: