Jump to

• Request
• Response

Distribute ( Name, Application Path, Plan )

post

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

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.

Request

Supported Media Types

• application/json

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Header Parameters

• Prefer(optional): 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: 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'.

Body ()

Must contain the following fields:

Root Schema : Arguments

Type: object

Title: Arguments

Show Source

• applicationPath(optional): string

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

• name(optional): string

  The name of the application

• plan(optional): string

  The deployment plan for this application. May be null.

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "applicationPath":{
            "type":"string",
            "description":"<p>A supported Java EE application or module archive, or a root directory for the application or module.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>The name of the application</p>"
        },
        "plan":{
            "type":"string",
            "description":"<p>The deployment plan for this application.  May be null.</p>"
        }
    },
    "description":""
}

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.
• Deployer: basic
  Type: basic

  Description: A user in the Deployer security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the following fields:

Body ()

Root Schema : Return

Type: object

Title: Return

Show Source

• return(optional): array Deployment Progress Object Reference
  Title: Deployment Progress Object Reference

  Contains the deployment progress object reference.

  Returns the action's result.

{
    "type":"object",
    "title":"Return",
    "properties":{
        "return":{
            "title":"Deployment Progress Object Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the deployment progress object reference. <p>Returns the action's result.</p>"
        }
    },
    "description":""
}

Nested Schema : Deployment Progress Object Reference

Type: array

Title: Deployment Progress Object Reference

Contains the deployment progress object reference.

Returns the action's result.

Show Source

• Array of: string

{
    "title":"Deployment Progress Object Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the deployment progress object reference. <p>Returns the action's result.</p>"
}

Back to Top