RESTful Edit Management Interface for Oracle WebLogic Server

Deploy An Application

post

/management/weblogic/{version}/edit/appDeployments

This resource is used to deploy applications that are already on the adminitration server. The application must be a supported package type (for example, an EAR or WAR module).

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

Request

Supported Media Types

application/json

Path Parameters

version(required): string

The version of the WebLogic REST interface.

Header Parameters

Prefer: string

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

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

To deploy an application you must provide the name of the application, the path to the source of the deployable unit on the administration server, and the targets to which the application will be deployed.

If the source path is relative, it is resolved relative to InstallDir/app if InstallDir is not null; otherwise, it is resolved relative to the domain root.

Root Schema : Model

Type: object

Title: Model

Show Source

name(required): string

The user-specified name of this deployment.
This name is included as one of the key properties in the MBean's javax.management.ObjectName
Name=user-specified-name
planPath: string

The path to the deployment plan document on the Administration Server.
If the plan path is a relative path, it is resolved relative to PlanDir if PlanDir is not null;otherwise, it is resolved relative to the domain root.
planVersion: string

The deployment plan's version (optional).
sourcePath(required): string

The path to the source of the deployable unit on the Administration Server.
If the source path is relative, it is resolved relative to InstallDir/app ifInstallDir is not null; otherwise, it is resolved relative to the domain root.
targets: array Target References

Title: Target References

Contains the array of target references.
The clusters and/or servers on which this application will be deployed.The deployment will only occur once if the targets overlap.

{
    "type":"object",
    "title":"Model",
    "properties":{
        "name":{
            "type":"string",
            "description":"<p>The user-specified name of this deployment.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p>"
        },
        "planPath":{
            "type":"string",
            "description":"<p>The path to the deployment plan document on the Administration Server.</p><p>If the plan path is a relative path, it is resolved relative to PlanDir if PlanDir is not null;otherwise, it is resolved relative to the domain root.</p>"
        },
        "planVersion":{
            "type":"string",
            "description":"<p>The deployment plan's version (optional).</p>"
        },
        "sourcePath":{
            "type":"string",
            "description":"<p>The path to the source of the deployable unit on the Administration Server.</p><p>If the source path is relative, it is resolved relative to <code><i>InstallDir/app</i></code> ifInstallDir is not null; otherwise, it is resolved relative to the domain root.</p>"
        },
        "targets":{
            "title":"Target References",
            "type":"array",
            "items":{
                "title":"Target Reference",
                "type":"object",
                "properties":{
                    "identity":{
                        "title":"Identity",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "description":""
                        },
                        "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
                    }
                },
                "description":"Contains the target reference."
            },
            "description":"Contains the array of target references. <p>The clusters and/or servers on which this application will be deployed.The deployment will only occur once if the targets overlap.</p>"
        }
    },
    "required":[
        "name",
        "sourcePath"
    ],
    "description":""
}

Nested Schema : Target References

Type: array

Title: Target References

Contains the array of target references.

The clusters and/or servers on which this application will be deployed.The deployment will only occur once if the targets overlap.

Show Source

Array of: object Target Reference

Title: Target Reference

Contains the target reference.

{
    "title":"Target References",
    "type":"array",
    "items":{
        "title":"Target Reference",
        "type":"object",
        "properties":{
            "identity":{
                "title":"Identity",
                "type":"array",
                "items":{
                    "type":"string",
                    "description":""
                },
                "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
            }
        },
        "description":"Contains the target reference."
    },
    "description":"Contains the array of target references. <p>The clusters and/or servers on which this application will be deployed.The deployment will only occur once if the targets overlap.</p>"
}

Nested Schema : Target Reference

Type: object

Title: Target Reference

Contains the target reference.

Show Source

identity: array Identity

Title: Identity

DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

{
    "title":"Target Reference",
    "type":"object",
    "properties":{
        "identity":{
            "title":"Identity",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
        }
    },
    "description":"Contains the target reference."
}

Nested Schema : Identity

Type: array

Title: Identity

DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

Show Source

Array of: string

{
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}

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.

Response

201 Response

Examples

Synchronously create a new app deployment.

This example uses the POST method to synchronously create a new app deployment in this collection.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{
  name: 'fairShare',
  sourcePath: '/deployments/fairShare.war',
  targets: [
    { identity: [ 'servers',  'AdminServer' ] },
    { identity: [ 'clusters', 'Cluster-0'   ] }
  ]
}" \
-X POST http://localhost:7001/management/weblogic/latest/edit/appDeployments?links=job,abort&fields=completed,progress,error,state,operationType,applicationName

Example Response

HTTP/1.1 201 Created

Location: http://localhost:7001/management/weblogic/latest/edit/appDeployments/fairShare

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/deploymentManager/deploymentProgressObjects/fairShare"
    }],
    "operationType": 3,
    "state": "STATE_COMPLETED",
    "applicationName": "fairShare",
    "progress": "success",
    "completed": true
}

Asynchronously create a new app deployment.

This example uses the POST method to asynchronously create a new app deployment in this collection.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{
  name: 'fairShare',
  sourcePath: '/deployments/fairShare.war',
  targets: [
    { identity: [ 'servers',  'AdminServer' ] },
    { identity: [ 'clusters', 'Cluster-0'   ] }
  ]
}" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/edit/appDeployments?links=job,abort&fields=completed,progress,error,state,operationType,applicationName

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/deploymentManager/deploymentProgressObjects/fairShare

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/deploymentManager/deploymentProgressObjects/fairShare"
    }],
    "operationType": 3,
    "state": "STATE_RUNNING",
    "applicationName": "fairShare",
    "progress": "processing",
    "completed": false
}