/management/wls/{version}/deployments/inspect

This resource inspects a deployment (archive or exploded directory) and returns information about it. This is useful for finding out information about the deployment before it has been deployed, for example, whether it's a library or an application.

The resource supports the following methods:

OPTIONS Method

The OPTIONS method on this resource returns a template entity that has been pre-populated with default values.

If you want to inspect a deployment, call this method to get the template, fill in the values, such as the deploymentPath, then use it in the POST method to inspect the deployment.

Roles

Administrator, Deployer

Response Body

The response body returned includes a DeploymentReference template entity that can be customized and then used to inspect the deployment.

Response Codes

This method returns one of the Standard HTTP Status Codes.

Example

Example 1   Getting a Template Deployment Reference Entity

This example uses the OPTIONS method to obtain a template for deployment inspection.

Example Request

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X OPTIONS http://localhost:7001/management/wls/latest/deployments/inspect

Example Response

HTTP/1.1 200 OK

Response Body:
{"item": {
    "planPath": null,
    "deploymentPath": null
}}

POST Method

The POST method on this resource examines a deployment and returns information about it.

Roles

Administrator

Request Body

The request body must include a fully populated DeploymentReference entity. Read only parameter values are ignored.

Response Body

The response body returned includes a DeploymentDescription entity.

Response Codes

This method returns one of the Standard HTTP Status Codes.

Example

Example 1   Inspecting a Versioned Library

This example uses the POST method to inspect a library prior to deployment.

Example Request

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{
    deploymentPath: '/deployments/aquarium_sv2_ivfab.ear'
}" \
-X POST http://localhost:7001/management/wls/latest/deployments/inspect

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [{
        "rel": "parent",
        "uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments"
    }],
    "item": {
        "deploymentType": "library",
        "name": "aquarium_sv2_ivfab",
        "specVersion": "2.0",
        "implVersion": "fabulous",
        "deploymentPath": "\/deployments\/aquarium_sv2_ivfab.ear"
    }
}