RESTful Domain Runtime Management Interface for Oracle WebLogic Server

Soft Restart

post

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/softRestart

Uses Node Manager to signal a system component for softRestart.

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

Request

Supported Media Types

application/json

Path Parameters

name(required): string

The name property of the instance in the collection.
version(required): string

The version of the WebLogic REST interface.

Header Parameters

Prefer: string

The 'Prefer' header parameter can be used to specify the preference on how this method runs. A value of 'respond-async' specifies a preference to submit the request and return immediately without waiting for completion. Alternatively a value of 'wait=#seconds' specifies a preference to wait for #seconds for method completion before returning. If the Prefer header is not specified or invalid, then a 300 second wait will be used.
X-Requested-By(required): string

The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Must contain the following fields:

Root Schema : Arguments

Type: object

Title: Arguments

Show Source

props: object Properties

Title: Properties

Additional Properties Allowed: additionalProperties

properties to use when soft-restarting this system component. These properties are used by the nodemanager plugin.

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "props":{
            "type":"object",
            "description":"<p>properties to use when soft-restarting this system component. These properties are used by the nodemanager plugin.</p>",
            "additionalProperties":{
                "type":"string"
            },
            "title":"Properties"
        }
    },
    "description":""
}

Nested Schema : Properties

Type: object

Title: Properties

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "description":"<p>properties to use when soft-restarting this system component. These properties are used by the nodemanager plugin.</p>",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Properties"
}

properties to use when soft-restarting this system component. These properties are used by the nodemanager plugin.

Security

Admin: basic

Type: basic

Description: A user in the Admin security role.
Operator: basic

Type: basic

Description: A user in the Operator security role.

Response

Supported Media Types

application/json

200 Response

Returns the following fields:

Root Schema : Return

Type: object

Title: Return

Show Source

return: array System Component Life Cycle Task Runtime Reference

Title: System Component Life Cycle Task Runtime Reference

Contains the system component life cycle task runtime reference.
Returns the action's result.

{
    "type":"object",
    "title":"Return",
    "properties":{
        "return":{
            "title":"System Component Life Cycle Task Runtime Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the system component life cycle task runtime reference. <p>Returns the action's result.</p>"
        }
    },
    "description":""
}

Nested Schema : System Component Life Cycle Task Runtime Reference

Type: array

Title: System Component Life Cycle Task Runtime Reference

Contains the system component life cycle task runtime reference.

Returns the action's result.

Show Source

Array of: string

{
    "title":"System Component Life Cycle Task Runtime Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the system component life cycle task runtime reference. <p>Returns the action's result.</p>"
}