1. RESTful Edit Management Interface for Oracle WebLogic Server
  2. Tasks
  3. App Deployment
  4. App Deployments

View This App Deployment

get

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

View this app deployment.

Request

Path Parameters
Query Parameters
  • The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
  • The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
Security
Back to Top

Response

Supported Media Types

200 Response

Returns this app deployment.

This method can return the following links:

  • rel=action title=createPlan uri=/management/weblogic/{version}/edit/appDeployments/{name}/createPlan

    This resource's createPlan action resource.

  • rel=redeploy uri=/management/weblogic/{version}/edit/appDeployments/{name}/redeploy

    This resource's redeploy resource.

  • rel=subDeploymentCreateForm uri=/management/weblogic/{version}/edit/appDeployments/{name}/subDeploymentCreateForm

    The create form resource for this resource's subDeployments collection resource.

  • rel=subDeployments uri=/management/weblogic/{version}/edit/appDeployments/{name}/subDeployments

    This resource's subDeployments collection resource.

  • rel=update uri=/management/weblogic/{version}/edit/appDeployments/{name}/update

    This resource's update resource.

Body ()
Root Schema : App Deployment
Type: object
Show Source
  • Read Only: true

    The fully resolved location of this application's alternate descriptor directory on the Administration Server.

  • Read Only: true

    The fully resolved location of this application's alternate descriptor on the Administration Server.

  • Read Only: true

    The fully resolved location of this application's installation root directory on the Administration Server.

  • Read Only: true

    The fully resolved location of this application's deployment plan directory on the Administration Server.

  • Read Only: true

    The fully resolved location of this application's deployment plan on the Administration Server.

  • Read Only: true

    The fully resolved location of this application's source files on the Administration Server.

  • Read Only: true

    The location of this application's configuration area. This directory can contain alternate descriptor files.

    Rules:

    If the alternate descriptor directory is a relative path, it is resolved relative to InstallDir if InstallDir is not null; otherwise, it is resolved relative to the domain root.

    Use AbsoluteAltDescriptorDir to get a fully resolved value.

  • Read Only: true

    The Application Identifier of the application version uniquely identifies the application version across all versions of all applications. If the application is not versioned, the Application Identifier is the same as the application name.

  • Read Only: true

    The name of the application.

    Note that the name of the current MBean is not the name of the application.

  • This is only set for beans created as a result of conversion from an 8.1 application configured using ApplicationMBean and ComponentMBean.

    Standalone modules in 8.1 have both an ApplicationMBean name and ComponentMBean name. This attribute stores the name of the latter, to be used when the server creates the transient ComponentMBean for backward compatibility.

  • Default Value: 100

    An integer value that indicates when this unit is deployed, relative to other deployable units on a server, during startup.

    Units with lower values are deployed before those with higher values.

  • A string value that indicates the principal that should be used when deploying the file or archive during startup and shutdown. This principal will be used to set the current subject when calling out into application code for interfaces such as ApplicationLifecycleListener. If no principal name is specified, then the anonymous principal will be used.

  • Read Only: true
    Default Value: false

    Return whether the MBean was created dynamically or is persisted to config.xml

  • Read Only: true

    Return the unique id of this MBean instance

  • Read Only: true

    The path to the application's install-root directory, relative to the domain/config/deployments directory.

    When the installation directory is specified, SourcePath, PlanDir, and PlanPath are derived from this path and need not be specified.

    The default value for this is the name of the deployment.

  • The values match those defined by jsr88. This attribute may move to another MBean.

  • Read Only: true

    The user-specified name of this MBean instance.

    This name is included as one of the key properties in the MBean's javax.management.ObjectName

    Name=user-specified-name

    Constraints

    • legal null

  • Optional information that you can include to describe this configuration.

    WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the xml entity <. Carriage returns/line feeds are preserved.

    Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

  • Determines if the modules of applications will be deployed in parallel.

  • Read Only: true

    The location of this application's configuration area. This directory can contain external descriptor files as specified within the deployment plan document.

    Rules:

    If the plan directory is a relative path, it is resolved relative to InstallDir if InstallDir is not null; otherwise, it is resolved relative to the domain root.

    Use AbsolutePlanDir to get a fully resolved value.

  • Read Only: true

    The path to the deployment plan document on the Administration Server.

    Rules:

    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.

    Use AbsolutePlanPath to get a fully resolved value.

    If there is no plan, this returns no plan specified.

  • Read Only: true
    Default Value: oracle.doceng.json.BetterJsonNull@48281cf3
    Allowed Values: [ null, "nostage", "stage", "external_stage" ]

    Specifies whether an application's deployment plan is copied from a source on the Administration Server to the Managed Server's staging area during application preparation.

    Plan staging mode for an application can only be set the first time the application is deployed. Once the plan staging mode for an application is set, it cannot be changed while the application is configured in the domain. The only way to change the plan staging mode is to undeploy and then redeploy the application.

    This attribute overrides the server's plan staging mode.

  • Read Only: true
    Default Value: DDOnly
    Allowed Values: [ "DDOnly", "CustomRoles", "CustomRolesAndPolicies", "Advanced" ]

    The security model that is used to secure a deployed module.

    To set this value, you can use the weblogic.Deployer command-line tool, the Deployment Assistant in the Administration Console, the WebLogic Scripting Tool (WLST), or another JMX client.

    If you deploy a module using one of the previously mentioned tools and you do not specify a security model value, the module is secured with the security realm's default model (see weblogic.management.security.RealmMBean#getSecurityDDModel RealmMBean SecurityDDModel).

    If you deploy a module by modifying the domain's config.xml file and restarting the server, and if you do not specify a security model value for the module in config.xml, the module is secured with the DDOnly model, which is the default value of this AppDeploymentMBean attribute.

    In summary, the order of precedence for the value of this attribute is as follows:

    • If you deploy a module using a runtime deployment utility, the order of precedence is:

      1. The value set by the deployment utility.

      2. The value set as the security realm's default security model.

    • If you deploy a module by modifying config.xml and restarting the server, the order of precedence is:

      1. The value that you specify for the module in config.xml

      2. The default value of this AppDeploymentMBean SecurityDDModel attribute.

  • Read Only: true

    The path to the source of the deployable unit on the Administration Server.

    Rules:

    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.

    Use AbsoluteSourcePath to get a fully resolved value.

  • Read Only: true
    Default Value: oracle.doceng.json.BetterJsonNull@35ebbb8f
    Allowed Values: [ null, "nostage", "stage", "external_stage" ]

    Specifies whether a deployment's files are copied from a source on the Administration Server to the Managed Server's staging area during application preparation.

    Staging mode for an application can only be set the first time the application is deployed. Once the staging mode for an application is set, it cannot be changed while the application is configured in the domain. The only way to change the staging mode is to undeploy and then redeploy the application.

    This attribute overrides the server's staging mode.

  • Items
    Title: Items

    Return all tags on this Configuration MBean

  • Target References
    Title: Target References
    Contains the array of target references.

    You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

  • Read Only: true

    Returns the type of the MBean.

    Constraints

    • unharvestable
  • Default Value: false

    Only relevant for deployments in resource group templates. This flag, when specified as true, indicates that the application deployment must not be deployed in the referring partition.

  • Default Value: false

    This attribute is not used in the current release.

  • Read Only: true

    Uniquely identifies the application version across all versions of the same application.

    If the application is not versioned, this returns null.

Nested Schema : Items
Type: array
Title: Items

Return all tags on this Configuration MBean

Show Source
Nested Schema : Target References
Type: array
Title: Target References
Contains the array of target references.

You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

Show Source
Nested Schema : Target Reference
Type: object
Title: Target Reference
Contains the target reference.
Show Source
Nested Schema : Identity
Type: array
Title: Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
Show Source
Back to Top

Examples

View this app deployment.

This example uses the GET method to view this app deployment.

Example Request
curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/latest/edit/appDeployments/fairShare?links=none&fields=name,versionIdentifier,targets
Example Response
HTTP/1.1 200 OK

Response Body:
{
    "versionIdentifier": null,
    "name": "fairShare",
    "targets": [
        {"identity": [
            "servers",
            "AdminServer"
        ]},
        {"identity": [
            "clusters",
            "Cluster-0"
        ]}
    ]
}
Back to Top