Oracle® Fusion Middleware

RESTful Domain Runtime Reference for Oracle WebLogic Server

12c (12.2.1)

E64956-02

November 2015

This reference describes the RESTful domain runtime resources that are used to manage WebLogic Server.

Oracle Fusion Middleware RESTful Domain Runtime Reference for Oracle WebLogic Server, 12c (12.2.1)

E64956-02

Copyright © 2015, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Contents

Preface

- Documentation Accessibility

- Conventions

1 Resources

- /management/weblogic

- GET

- /management/weblogic/{version}

- GET

- /management/weblogic/{version}/currentUser

- GET

- /management/weblogic/{version}/domainRuntime

- GET

- /management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime

- GET

- /management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getCurrentState

- POST

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getIntendedState

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleIds

- POST

- /management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleTargets

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleType

- POST

- /management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeMillis

- POST

- /management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeoutSeconds

- POST

- /management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getSubmoduleIds

- POST

- /management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isActiveVersion

- POST

- /management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isAdminMode

- POST

- /management/weblogic/{version}/domainRuntime/batchJobRepositoryRuntime

- GET

- /management/weblogic/{version}/domainRuntime/consoleRuntime

- GET

- /management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURL

- POST

- /management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURLs

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/consoleRuntime/getObjectNameContext

- POST

- /management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURL

- POST

- /management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURLs

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager

- GET

- /management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes

- GET

- /management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}

- GET

- /management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/getState

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/redeploy

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/start

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/stop

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/undeploy

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/update

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/confirmApplicationName

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/deploy

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects

- GET

- /management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}

- GET

- /management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/getExceptions

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/distribute

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes

- GET

- /management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}

- GET

- /management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/redeploy

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/undeploy

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/purgeCompletedDeploymentProgressObjects

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/redeploy

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/undeploy

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/deploymentManager/update

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getCurrentState

- POST

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getIntendedState

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleIds

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleTargets

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleType

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeMillis

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeoutSeconds

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getSubmoduleIds

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isActiveVersion

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isAdminMode

- POST

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

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/getState

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/redeploy

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/start

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/stop

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/undeploy

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/update

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/confirmApplicationName

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploy

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}/getExceptions

- POST

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

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}/redeploy

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}/undeploy

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/purgeCompletedDeploymentProgressObjects

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/redeploy

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/undeploy

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/update

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations

- GET

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations/{name}

- DELETE

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/forceDestroyEditSessionConfiguration

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceShutdown

- POST

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceSuspend

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/getState

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/purgeTasks

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/forceShutdown

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/forceSuspend

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/getState

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/purgeTasks

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/resume

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown

- POST

- POST

- POST

- POST

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/start

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend

- POST

- POST

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resume

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/shutdown

- POST

- POST

- POST

- POST

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/start

- POST

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/startInAdmin

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/suspend

- POST

- POST

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/editSessionConfigurationManager

- GET

- /management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations

- GET

- POST

- /management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}

- DELETE

- GET

- /management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges

- POST

- /management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/forceDestroyEditSessionConfiguration

- POST

- /management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime

- GET

- /management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/getScalingTasks

- POST

- /management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/purgeScalingTasks

- POST

- /management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleDown

- POST

- /management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleUp

- POST

- /management/weblogic/{version}/domainRuntime/forceShutdownPartitionWait

- POST

- /management/weblogic/{version}/domainRuntime/logRuntime

- GET

- /management/weblogic/{version}/domainRuntime/logRuntime/ensureLogOpened

- POST

- /management/weblogic/{version}/domainRuntime/logRuntime/flushLog

- POST

- /management/weblogic/{version}/domainRuntime/logRuntime/forceLogRotation

- POST

- /management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime

- GET

- /management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/printMDBStatus

- POST

- /management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/resumeMDBs

- POST

- /management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/suspendMDBs

- POST

- /management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime

- GET

- /management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrate

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateJTA

- POST

- /management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateSingleton

- POST

- /management/weblogic/{version}/domainRuntime/migrationDataRuntimes

- GET

- /management/weblogic/{version}/domainRuntime/migrationDataRuntimes/{name}

- GET

- /management/weblogic/{version}/domainRuntime/nodeManagerRuntimes

- GET

- /management/weblogic/{version}/domainRuntime/nodeManagerRuntimes/{name}

- GET

- /management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime

- GET

- /management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/getPolicyRefStatus

- POST

- /management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/isOWSMAttachable

- POST

- /management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/removePolicyReference

- POST

- /management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/setPolicyRefStatus

- POST

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes

- GET

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}

- GET

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceShutdown

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceSuspend

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/getState

- POST

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/purgeTasks

- POST

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/resume

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown

- POST

- POST

- POST

- POST

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/start

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend

- POST

- POST

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks

- GET

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/restartSystemResource

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/canResume

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextExecuteStep

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextRevertStep

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/waitFor

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/deleteWorkflow

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/execScript

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/executeWorkflow

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/getWorkflowTask

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/canResume

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextExecuteStep

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextRevertStep

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/waitFor

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/initializeRolloutOracleHome

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/restartNodeManager

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/revertWorkflow

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/rollingRestart

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/rolloutApplications

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/rolloutJavaHome

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/rolloutOracleHome

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/rolloutUpdate

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/shutdownServer

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/startServer

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/canResume

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextExecuteStep

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextRevertStep

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/waitFor

- POST

- /management/weblogic/{version}/domainRuntime/search

- POST

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes

- GET

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}

- GET

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceShutdown

- POST

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceSuspend

- POST

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv4URL

- POST

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv6URL

- POST

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/resume

- POST

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown

- POST

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/start

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInAdmin

- POST

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInStandby

- POST

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/suspend

- POST

- POST

- POST

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks

- GET

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/serverRuntimes

- GET

- /management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes

- GET

- /management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes/{name}

- GET

- /management/weblogic/{version}/domainRuntime/SNMPAgentRuntime

- GET

- /management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/invalidateLocalizedKeyCache

- POST

- /management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/outputCustomMBeansMIBModule

- POST

- /management/weblogic/{version}/domainRuntime/startPartitionWait

- POST

- /management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes

- GET

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

- GET

- /management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/shutdown

- POST

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

- POST

- /management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/start

- POST

- /management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks

- GET

- /management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel

- POST

- /management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks

- GET

- /management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}

- GET

- /management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

- POST

2 Entities

- java.lang.Throwable

- java.util.Date

- java.util.Properties

- weblogic.health.HealthState

- weblogic.health.Symptom

- weblogic.management.rest.bean.model.CurrentUser

- weblogic.management.rest.bean.model.Version

- weblogic.management.runtime.AppDeploymentRuntimeMBean

- weblogic.management.runtime.AppRuntimeStateRuntimeMBean

- weblogic.management.runtime.BatchJobRepositoryRuntimeMBean

- weblogic.management.runtime.ConsoleRuntimeMBean

- weblogic.management.runtime.DeploymentManagerMBean

- weblogic.management.runtime.DeploymentProgressObjectMBean

- weblogic.management.runtime.DomainPartitionRuntimeMBean

- weblogic.management.runtime.DomainRuntimeMBean

- weblogic.management.runtime.EditSessionConfigurationManagerMBean

- weblogic.management.runtime.EditSessionConfigurationRuntimeMBean

- weblogic.management.runtime.ElasticServiceManagerRuntimeMBean

- weblogic.management.runtime.LibDeploymentRuntimeMBean

- weblogic.management.runtime.LogRuntimeMBean

- weblogic.management.runtime.MessageDrivenControlEJBRuntimeMBean

- weblogic.management.runtime.MigratableServiceCoordinatorRuntimeMBean

- weblogic.management.runtime.MigrationDataRuntimeMBean

- weblogic.management.runtime.NodeManagerRuntimeMBean

- weblogic.management.runtime.PartitionLifeCycleRuntimeMBean

- weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean

- weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean

- weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean

- weblogic.management.runtime.RolloutServiceRuntimeMBean

- weblogic.management.runtime.SNMPAgentRuntimeMBean

- weblogic.management.runtime.ServerLifeCycleRuntimeMBean

- weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean

- weblogic.management.runtime.ServerRuntimeMBean

- weblogic.management.runtime.ServiceMigrationDataRuntimeMBean

- weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean

- weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean

- weblogic.management.runtime.TaskRuntimeMBean

- weblogic.management.runtime.WorkflowTaskRuntimeMBean

- weblogic.management.runtime.WseePolicySubjectManagerRuntimeMBean

Preface

This preface describes the document accessibility features and conventions used in this guide, RESTful Domain Runtime Reference for Oracle WebLogic Server.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Conventions

The following text conventions are used in this document:

Convention

Meaning

boldface

Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic

Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace

Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

1 Resources

This documentation describes the Oracle WebLogic Server RESTful domain runtime resources that are used to monitor the entire WLS domain.

For a complete listing of the WLS REST reference documents and descriptions of their use, see Administering Oracle WebLogic Server with RESTful Management Services.

/management/weblogic

This resource is used to access different versions (if applicable) of the resources that are in this domain.

For the 12.2.1 release, there are just two versions: 12.2.1 and latest, where latest is another name for 12.2.1. For future releases, latest always refers to the most recent release.

To always use the latest resources, make sure to use latest in the URLs. Note that this might require updating a client when moving to a newer version of WebLogic Server. To fix the version so that an update is not required, use 12.2.1 in the URLs.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.rest.bean.model.Version instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.rest.bean.model.Version entities.

This method can return the following links:

- uri=/management/weblogic rel=canonical
This resource.

- uri=/management/weblogic/12.2.1.0 rel=current
Access the latest version of the WLS resources in the this domain.

- uri=/management/weblogic rel=self
This resource.

Example

Example 1   View the versions collection.

This example uses the GET method to display the version instances in this collection.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic

Example Response

HTTP/1.1 200 OK

Response Body:
{
"links": [
{
"rel": "self",
"href": "http:\//localhost:7001/management/weblogic"
},
{
"rel": "canonical",
"href": "http:\//localhost:7001/management/weblogic"
},
{
"rel": "current",
"href": "http:\//localhost:7001/management/weblogic/12.2.1.0"
}
],
"items": [{
"links": [
{
"rel": "self",
"href": "http:\//localhost:7001/management/12.2.1.0"
},
{
"rel": "canonical",
"href": "http:\//localhost:7001/management/12.2.1.0"
}
],
"version": "12.2.1.0",
"isLatest": true,
"lifecycle": "active"
}]
}

/management/weblogic/{version}

This resource describes the resource trees that are used to manage a WebLogic Server domain and its managed servers. The resource trees mimic the bean trees in WLST and allow you to view and edit configuration and monitor runtime behavior.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.rest.bean.model.Version instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.rest.bean.model.Version entity.

This method can return the following links:

- uri=/management/weblogic/{version} rel=canonical
This resource.

- uri=/management/weblogic/{version}/currentUser rel=currentUser

- uri=/management/weblogic/{version}/domainConfig rel=domainConfig

- uri=/management/weblogic/{version}/domainRuntime rel=domainRuntime

- uri=/management/weblogic/{version}/edit rel=edit

- uri=/management/weblogic rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version} rel=self
This resource.

- uri=/management/weblogic/{version}/serverConfig rel=serverConfig

- uri=/management/weblogic/{version}/serverRuntime rel=serverRuntime

Example

Example 1   View the latest version.

This example uses the GET method to display the latest version.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/latest

Example Response

HTTP/1.1 200 OK

Response Body:
{
"links": [
{
"rel": "parent",
"href": "http:\//localhost:7001/management/weblogic"
},
{
"rel": "self",
"href": "http:\//localhost:7001/management/weblogic/latest"
},
{
"rel": "canonical",
"href": "http:\//localhost:7001/management/weblogic/latest"
},
{
"rel": "edit",
"href": "http:\//localhost:7001/management/weblogic/latest/edit"
},
{
"rel": "domainConfig",
"href": "http:\//localhost:7001/management/weblogic/latest/domainConfig"
},
{
"rel": "domainRuntime",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime"
},
{
"rel": "serverRuntime",
"href": "http:\//localhost:7001/management/weblogic/latest/serverRuntime"
},
{
"rel": "serverConfig",
"href": "http:\//localhost:7001/management/weblogic/latest/serverConfig"
},
{
"rel": "currentUser",
"href": "http:\//localhost:7001/management/weblogic/latest/currentUser"
}
],
"version": "12.2.1.0",
"isLatest": true,
"lifecycle": "active"
}

Example 2   View a specific version.

This example uses the GET method to display a specific version.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/12.2.1.0

Example Response

HTTP/1.1 200 OK

Response Body:
{
"links": [
{
"rel": "parent",
"href": "http:\//localhost:7001/management/weblogic"
},
{
"rel": "self",
"href": "http:\//localhost:7001/management/weblogic/12.2.1.0"
},
{
"rel": "canonical",
"href": "http:\//localhost:7001/management/weblogic/12.2.1.0"
},
{
"rel": "edit",
"href": "http:\//localhost:7001/management/weblogic/12.2.1.0/edit"
},
{
"rel": "domainConfig",
"href": "http:\//localhost:7001/management/weblogic/12.2.1.0/domainConfig"
},
{
"rel": "domainRuntime",
"href": "http:\//localhost:7001/management/weblogic/12.2.1.0/domainRuntime"
},
{
"rel": "serverRuntime",
"href": "http:\//localhost:7001/management/weblogic/12.2.1.0/serverRuntime"
},
{
"rel": "serverConfig",
"href": "http:\//localhost:7001/management/weblogic/12.2.1.0/serverConfig"
},
{
"rel": "currentUser",
"href": "http:\//localhost:7001/management/weblogic/12.2.1.0/currentUser"
}
],
"version": "12.2.1.0",
"isLatest": true,
"lifecycle": "active"
}

/management/weblogic/{version}/currentUser

This resource represents an authenticated user in the domain.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.rest.bean.model.CurrentUser instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.rest.bean.model.CurrentUser entity.

This method can return the following links:

- uri=/management/weblogic/{version}/currentUser rel=canonical
This resource.

- uri=/management/weblogic/{version} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/currentUser rel=self
This resource.

Example

Example 1   Viewing the weblogic.management.rest.bean.model.CurrentUser Instance

This example uses the GET method to view this weblogic.management.rest.bean.model.CurrentUser instance.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/latest/currentUser

Example Response

HTTP/1.1 200 OK

Response Body:
{
"links": [
{
"rel": "parent",
"href": "http:\//localhost:7001/management/weblogic/latest"
},
{
"rel": "self",
"href": "http:\//localhost:7001/management/weblogic/latest/currentUser"
},
{
"rel": "canonical",
"href": "http:\//localhost:7001/management/weblogic/latest/currentUser"
}
],
"partitionId": "0",
"partitionName": "DOMAIN",
"user": "admin"
}

/management/weblogic/{version}/domainRuntime

This resource is used to monitor the entire WebLogic Server domain.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.DomainRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.DomainRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime rel=SNMPAgentRuntime
This resource's SNMPAgentRuntime singleton resource.

- uri=/management/weblogic/{version}/domainRuntime/forceShutdownPartitionWait rel=action title=forceShutdownPartitionWait
This resource's forceShutdownPartitionWait action resource.

- uri=/management/weblogic/{version}/domainRuntime/restartSystemResource rel=action title=restartSystemResource
This resource's restartSystemResource action resource.

- uri=/management/weblogic/{version}/domainRuntime/startPartitionWait rel=action title=startPartitionWait
This resource's startPartitionWait action resource.

- uri=/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime rel=appRuntimeStateRuntime
This resource's appRuntimeStateRuntime singleton resource.

- uri=/management/weblogic/{version}/domainRuntime/batchJobRepositoryRuntime rel=batchJobRepositoryRuntime
This resource's batchJobRepositoryRuntime singleton resource.

- uri=/management/weblogic/{version}/domainRuntime rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/consoleRuntime rel=consoleRuntime
This resource's consoleRuntime singleton resource.

- rel=currentDomainPartitionRuntime
This resource's currentDomainPartitionRuntime reference to a weblogic.management.runtime.DomainPartitionRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager rel=deploymentManager
This resource's deploymentManager singleton resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes rel=domainPartitionRuntimes
This resource's domainPartitionRuntimes collection resource.

- uri=/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager rel=editSessionConfigurationManager
This resource's editSessionConfigurationManager singleton resource.

- uri=/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime rel=elasticServiceManagerRuntime
This resource's elasticServiceManagerRuntime singleton resource.

- uri=/management/weblogic/{version}/domainRuntime/logRuntime rel=logRuntime
This resource's logRuntime singleton resource.

- uri=/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime rel=messageDrivenControlEJBRuntime
This resource's messageDrivenControlEJBRuntime singleton resource.

- uri=/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime rel=migratableServiceCoordinatorRuntime
This resource's migratableServiceCoordinatorRuntime singleton resource.

- uri=/management/weblogic/{version}/domainRuntime/migrationDataRuntimes rel=migrationDataRuntimes
This resource's migrationDataRuntimes collection resource.

- uri=/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes rel=nodeManagerRuntimes
This resource's nodeManagerRuntimes collection resource.

- uri=/management/weblogic/{version} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime rel=policySubjectManagerRuntime
This resource's policySubjectManagerRuntime singleton resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes rel=resourceGroupLifeCycleRuntimes
This resource's resourceGroupLifeCycleRuntimes collection resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService rel=rolloutService
This resource's rolloutService singleton resource.

- uri=/management/weblogic/{version}/domainRuntime/search rel=search
This resource's search resource.

- uri=/management/weblogic/{version}/domainRuntime rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes rel=serverLifeCycleRuntimes
This resource's serverLifeCycleRuntimes collection resource.

- uri=/management/weblogic/{version}/domainRuntime/serverRuntimes rel=serverRuntimes
This resource's serverRuntimes resource.

- uri=/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes rel=serviceMigrationDataRuntimes
This resource's serviceMigrationDataRuntimes collection resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes rel=systemComponentLifeCycleRuntimes
This resource's systemComponentLifeCycleRuntimes collection resource.

Example

Example 1   Viewing the weblogic.management.runtime.DomainRuntimeMBean Instance

This example uses the GET method to view this weblogic.management.runtime.DomainRuntimeMBean instance.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/latest/domainRuntime?fields=activationTime&links=self

Example Response

HTTP/1.1 200 OK

Response Body:
{
"links": [{
"rel": "self",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime"
}],
"activationTime": "2015-08-14T00:25:21.830-04"
}

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime

This resource manages a weblogic.management.runtime.AppRuntimeStateRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.AppRuntimeStateRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.AppRuntimeStateRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getCurrentState rel=action title=getCurrentState
This resource's getCurrentState action resource.

- uri=/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getIntendedState rel=action title=getIntendedState
This resource's getIntendedState action resource.

- uri=/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleIds rel=action title=getModuleIds
This resource's getModuleIds action resource.

- uri=/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleTargets rel=action title=getModuleTargets
This resource's getModuleTargets action resource.

- uri=/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleType rel=action title=getModuleType
This resource's getModuleType action resource.

- uri=/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeMillis rel=action title=getRetireTimeMillis
This resource's getRetireTimeMillis action resource.

- uri=/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeoutSeconds rel=action title=getRetireTimeoutSeconds
This resource's getRetireTimeoutSeconds action resource.

- uri=/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getSubmoduleIds rel=action title=getSubmoduleIds
This resource's getSubmoduleIds action resource.

- uri=/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isActiveVersion rel=action title=isActiveVersion
This resource's isActiveVersion action resource.

- uri=/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isAdminMode rel=action title=isAdminMode
This resource's isAdminMode action resource.

- uri=/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime rel=self
This resource.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getCurrentState

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

- POST

POST

Aggregate state for the application. This is defined as the most advanced state of the application's modules on the named target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

target

logical target where the app is deployed

Type: string

Response Body

Contains a JSON object with a string return field.

POST

Aggregate state for the module. This is defined as the most advanced state of the module on all servers associated with the named target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

target

logical target where module is deployed

Type: string

Response Body

Contains a JSON object with a string return field.

POST

Aggregate state for a submodule. This is defined as the most advanced state of the submodule on all servers associated with the named target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

subModuleId

subModuleId

Type: string

target

logical target where module is deployed

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getIntendedState

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

The state the application should be in.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a string return field.

POST

The state the application should be in on a specific target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

target

target

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleIds

The resource supports the following methods:

- POST

POST

Names of the modules contained in the application. This does not include submodules.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleTargets

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Logical targets where the submodule is deployed.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

subModuleId

subModuleId

Type: string

Response Body

Contains a JSON object with a array of string return field.

POST

Logical targets where the module is deployed.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleType

The resource supports the following methods:

- POST

POST

Indicates the type of module: EAR, WAR, etc.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeMillis

The resource supports the following methods:

- POST

POST

The time when the application will be retired.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a long return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeoutSeconds

The resource supports the following methods:

- POST

POST

The amount of time the application is given to retire.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a int return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getSubmoduleIds

The resource supports the following methods:

- POST

POST

Submodules associated with this module.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isActiveVersion

The resource supports the following methods:

- POST

POST

Indicates if the application is the active version, the one that new sessions will use.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

is the application id

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isAdminMode

The resource supports the following methods:

- POST

POST

Indicates if the application should only be available through the administration port. This is the desired state of the application.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

is the application id

Type: string

target

target

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/batchJobRepositoryRuntime

This resource manages a weblogic.management.runtime.BatchJobRepositoryRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.BatchJobRepositoryRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.BatchJobRepositoryRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/batchJobRepositoryRuntime rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/batchJobRepositoryRuntime rel=self
This resource.

/management/weblogic/{version}/domainRuntime/consoleRuntime

This resource manages a weblogic.management.runtime.ConsoleRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.ConsoleRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ConsoleRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURL rel=action title=getDefaultPageURL
This resource's getDefaultPageURL action resource.

- uri=/management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURLs rel=action title=getDefaultPageURLs
This resource's getDefaultPageURLs action resource.

- uri=/management/weblogic/{version}/domainRuntime/consoleRuntime/getObjectNameContext rel=action title=getObjectNameContext
This resource's getObjectNameContext action resource.

- uri=/management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURL rel=action title=getSpecificPageURL
This resource's getSpecificPageURL action resource.

- uri=/management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURLs rel=action title=getSpecificPageURLs
This resource's getSpecificPageURLs action resource.

- uri=/management/weblogic/{version}/domainRuntime/consoleRuntime rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/consoleRuntime rel=self
This resource.

/management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURL

The resource supports the following methods:

- POST

POST

Gets the URL for the default page of an object. You can optionally specify the kind of default page (e.g. configuration or monitoring). For example, use this method to get a WLS cluster's default page's URL. Use this method when possible since it isolates the caller from the specific console page labels. This method does not check whether the page exists. To find out, use the URL and see if it works.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

context

Identifies the object the page should display or manage. Most pages display or manage WLS mbeans (such as a server or cluster). For them, call "getObjectNameContext", passing in the JMX object name, to get the context to pass to this method. See the console programmers' guide for more information on contexts.

Type: array of string

perspective

Specifies which kind of default page to return (e.g. configuration or monitoring). Pass in null to get the default page for the object. See the console programmers' guide for more information on perspectives.

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURLs

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Gets the URLs for the default pages for a set of objects. This method works exactly like getDefaultPageURL, except that it lets you get the URLS for a set of pages in one JMX call (to increase network performance).

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

contexts

An array of contexts identifying the object each page should display or manage.

Type: array of array of string

perspectives

An array of perspectives identifying which kind of default page to return for each object.

Type: array of string

Response Body

Contains a JSON object with a array of string return field.

POST

Gets the URLs for the default pages for a set of objects. This method works exactly like getDefaultPageURL, except that it lets you get the URLS for a set of pages in one JMX call (to increase network performance).

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

contexts

An array of contexts identifying the object each page should display or manage.

Type: array of array of string

perspective

Specifies which kind of default page to return for all of the pages.

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/consoleRuntime/getObjectNameContext

The resource supports the following methods:

- POST

POST

Gets a context for a WLS mbean. This method does not check whether the mbean exists. The results of this method are usually passed into getDefaultPageURL or getSpecificPageURL.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

objectName

the JMX object name of a WLS mbean

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURL

The resource supports the following methods:

- POST

POST

Gets the URL for a specific console page. For example, use this method to get a WLS server's SSL configuration page's URL or the servers table page's URL. Note: WLS reserves the right to change its portal page names in future releases. Therefore, customers are advised to use "getDefaultPageURL" if possible so that they'll be isolated from these kinds of changes. This method does not check whether the page exists. To find out, use the URL and see if it works.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

page

The portal page label of the desired console page.

Type: string

context

Identifies the object the page should display or manage. Most pages display or manage WLS mbeans (such as a server or cluster). For them, call "getObjectNameContext", passing in the JMX object name, to get the context to pass to this method. See the console programmers' guide for more information on contexts.

Type: array of string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURLs

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Gets the URLs for a set of specific console page. This method works exactly like getSpecificPageURL, except that it lets you get the URLS for a set of pages in one JMX call (to increase network performance).

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

page

The portal page label of the desired console pages.

Type: string

contexts

An array of contexts identifying the object each page should display or manage.

Type: array of array of string

Response Body

Contains a JSON object with a array of string return field.

POST

Gets the URLs for a set of specific console pages. This method works exactly like getSpecificPageURL, except that it lets you get the URLS for a set of pages in one JMX call (to increase network performance).

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

pages

An array of portal page labels of the desired console pages.

Type: array of string

contexts

An array of contexts identifying the object each page should display or manage.

Type: array of array of string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/deploymentManager

This resource manages a weblogic.management.runtime.DeploymentManagerMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.DeploymentManagerMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.DeploymentManagerMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/confirmApplicationName rel=action title=confirmApplicationName
This resource's confirmApplicationName action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/deploy rel=action title=deploy
This resource's deploy action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/distribute rel=action title=distribute
This resource's distribute action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/purgeCompletedDeploymentProgressObjects rel=action title=purgeCompletedDeploymentProgressObjects
This resource's purgeCompletedDeploymentProgressObjects action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/redeploy rel=action title=redeploy
This resource's redeploy action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/undeploy rel=action title=undeploy
This resource's undeploy action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/update rel=action title=update
This resource's update action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes rel=appDeploymentRuntimes
This resource's appDeploymentRuntimes collection resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects rel=deploymentProgressObjects
This resource's deploymentProgressObjects collection resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes rel=libDeploymentRuntimes
This resource's libDeploymentRuntimes collection resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager rel=self
This resource.

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes

This resource manages a collection of weblogic.management.runtime.AppDeploymentRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.AppDeploymentRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.AppDeploymentRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes rel=self
This resource.

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}

This resource manages a weblogic.management.runtime.AppDeploymentRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.AppDeploymentRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.AppDeploymentRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/getState rel=action title=getState
This resource's getState action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/redeploy rel=action title=redeploy
This resource's redeploy action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/start rel=action title=start
This resource's start action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/stop rel=action title=stop
This resource's stop action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/undeploy rel=action title=undeploy
This resource's undeploy action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/update rel=action title=update
This resource's update action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name} rel=self
This resource.

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/getState

The resource supports the following methods:

- POST

POST

The state of the application for a target. Notifications will be generated for this attribute on state changes. Valid states are those supported by the weblogic.management.runtime.AppRuntimeStateRuntimeMBean The notification types are appdeployment.created, appdeployment.deleted, appdeployment.state.new, appdeployment.state.prepared, appdeployment.state.admin, appdeployment.state.active, appdeployment.state.retired, appdeployment.state.failed, appdeployment.state.update.pending, and appdeployment.state.unknown. The userdata is a Map where the keys are target names and the values are the application state for that target.

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

target

the target for the application state

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/redeploy

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Redeploy the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to redeploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.

Type: array of string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Redeploy the application using the default options and configured targets. This is a synchronous operation that returns when the redeploy 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. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/start

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Start the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to start the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be started on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Start the application using the default options and configured targets. This is a synchronous operation that returns when the start 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. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/stop

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Stop the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to stop the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be stoped on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Stop the application using the default options and configured targets. This is a synchronous operation that returns when the stop 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. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/undeploy

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Undeploy the application using the default options and configured targets. This is a synchronous operation that returns when the undeploy 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. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Undeploy the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to undeploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be undeployed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/update

The resource supports the following methods:

- POST

POST

Allows for updating an application configuration using an changed deployment plan.

A configuration update is equivalent to replacing the application's deployment plan. The deployment plan is redeployed in-place. A new version of the application is not started, even if the new deployment plan has a different version.

The update succeeds only if changes to the deployment plan do not require the application to be restarted. Configuration changes in the new deployment plan must be limited to tuning the application. Changes to resource bindings causes the update to fail. Use redeploy() to apply resource binding changes to a production application.

This method targets only root modules. Module level targeting is not supported.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

represent the targets on which to update the application.

Type: array of string

plan

The deployment plan containing the new deployment configuration information.

Type: string

deploymentOptions

Allows for overriding the deployment options. May be null.

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/confirmApplicationName

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Used by the deployment subsystem to confirm an application name.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

isRedeployment

should be true in the case where this function is called for a redeployment.

Type: boolean

appSource

is a the path to the application.

Type: string

optional

alternate app descriptor.

Type: string

tentativeName

The name proposed for the application (provided by the user, or through the manifest). Null if no name was specified by the user or through the manifest.

Type: string

tentativeApplicationId

The tentative application ID. May only be null if the application is not versioned. If tentativeName is null and the application is versioned, this should be just the version string (which includes both the implementation and specification versions).

Type: string

deploymentOptions

deployment options

Type: java.util.Properties

Response Body

Contains a JSON object with a string return field.

POST

Used by the deployment subsystem to confirm an application name.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

isRedeployment

should be true in the case where this function is called for a redeployment.

Type: boolean

appSource

is a the path to the application.

Type: string

optional

alternate application descriptor path

Type: string

tentativeName

The name proposed for the application (provided by the user, or through the manifest). Null if no name was specified by the user or through the manifest.

Type: string

tentativeApplicationId

The tentative application ID. May only be null if the application is not versioned. If tentativeName is null and the application is versioned, this should be just the version string (which includes both the implementation and specification versions).

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/deploy

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

A convenience method for distributing and starting 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 deploy operation has completed. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.

The default options are

- clusterDeploymentTimeout: 3600000 milliseconds

- gracefulIgnoreSessions: false

- gracefulProductionToAdmin: false

- retireGracefully: true

- retireTimeout: no timeout

- adminMode: false

- timeout: no timeout

If any modules are currently running, this method immediately restarts those modules using the newer files. Restarting modules in this manner is not the same as redeployment, because session state is not preserved for the active modules.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

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

Type: string

plan

The deployment plan for this application. May be null.

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

A convenience method for distributing and starting an application. The application source files and deployment plan are distributed to the deployment targets using the options specified. This is an asynchronous operation that returns immediately. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.

If any modules are currently running, this method immediately restarts those modules using the newer files. Restarting modules in this manner is not the same as redeployment, because session state is not preserved for the active modules.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

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

Type: string

targets

The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.

Type: array of string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects

This resource manages a collection of weblogic.management.runtime.DeploymentProgressObjectMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.DeploymentProgressObjectMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.DeploymentProgressObjectMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects rel=self
This resource.

Example

Example 1   View the weblogic.management.runtime.DeploymentProgressObjectMBean Collection

This example uses the GET method to display the weblogic.management.runtime.DeploymentProgressObjectMBean instances in this collection.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/latest/domainRuntime/deploymentManager/deploymentProgressObjects?fields=completed,progress,applicationName,operationType&links=none

Example Response

HTTP/1.1 200 OK

Response Body:
{"items": [{
"operationType": 3,
"applicationName": "fairShare",
"progress": "success",
"completed": true
}]}

/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}

This resource manages a weblogic.management.runtime.DeploymentProgressObjectMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.DeploymentProgressObjectMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.DeploymentProgressObjectMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/getExceptions rel=action title=getExceptions
This resource's getExceptions action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name} rel=self
This resource.

/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempt to cancel the deployment operation. Any actions which have yet to start will be inhibited. Any completed actions will remain in place.

Roles

Admin, Deployer

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/getExceptions

The resource supports the following methods:

- POST

POST

If the current deployment operation has failed, this method may return zero or more exception(s) which represent the errors for this target. The array will not contain WLS exception classes; instead they will be new RuntimeExceptions containing the stack traces and messages from the original WLS Exceptions.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

target

the target where exceptions might have occurred.

Type: string

Response Body

Contains a JSON object with a array of java.lang.Throwable return field.

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

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

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. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

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

Type: string

plan

The deployment plan for this application. May be null.

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Distribute an application. The application source files and deployment plan are distributed to the deployment targets using the options specified. This is an asynchronous operation that returns immediately.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

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

Type: string

targets

The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be distributed on all configured targets.

Type: array of string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes

This resource manages a collection of weblogic.management.runtime.LibDeploymentRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.LibDeploymentRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.LibDeploymentRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes rel=self
This resource.

/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}

This resource manages a weblogic.management.runtime.LibDeploymentRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.LibDeploymentRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.LibDeploymentRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/redeploy rel=action title=redeploy
This resource's redeploy action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/undeploy rel=action title=undeploy
This resource's undeploy action resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name} rel=self
This resource.

/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/redeploy

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Redeploy the library in the background for the targets specified with the options specified. This is an synchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to redeploy the library. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the library will be redeployed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The keys,units and default values for options are adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Redeploy the library using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are adminMode: false, timeout: no timeout

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

Roles

Admin, Deployer

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/undeploy

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Undeploy the library using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are adminMode boolean false timeout: no timeout

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

Roles

Admin, Deployer

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Undeploy the library in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to undeploy the library. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the library will be undeployed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are adminMode boolean false timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/purgeCompletedDeploymentProgressObjects

The resource supports the following methods:

- POST

POST

Removes progress objects for completed operations.

Roles

Admin, Deployer

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/deploymentManager/redeploy

The resource supports the following methods:

- POST

POST

Redeploy the application that is deployed to a resource group template in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

Note that this API is only for redeploying applications or libraries that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for redeploying applications that are not deployed to a resource group template, and LibDeploymentRuntimeMBean should be used for redeploying libraries that are not deployed to a resource group template.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/undeploy

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Undeploy the application that is deployed to a resource group template using the default options. This is a synchronous operation that returns when the undeploy 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. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

template

The resource group template

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Undeploy the application that is deployed to a resource group template in the background with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

Note that this API is only for undeploying applications that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for undeploying applications that are not deployed to a resource group template.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/update

The resource supports the following methods:

- POST

POST

Allows for updating an application configuration using an changed deployment plan for applications deployed to a resource group template.

A configuration update is equivalent to replacing the application's deployment plan. The deployment plan is redeployed in-place. A new version of the application is not started, even if the new deployment plan has a different version.

The update succeeds only if changes to the deployment plan do not require the application to be restarted. Configuration changes in the new deployment plan must be limited to tuning the application. Changes to resource bindings causes the update to fail. Use redeploy(String, String, Properties) to apply resource binding changes to a production application.

This method targets only root modules. Module level targeting is not supported.

Note that this API is only for updating applications that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for updating applications that are not deployed to a resource group template.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes

This resource manages a collection of weblogic.management.runtime.DomainPartitionRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.DomainPartitionRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.DomainPartitionRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes rel=self
This resource.

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

This resource manages a weblogic.management.runtime.DomainPartitionRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.DomainPartitionRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.DomainPartitionRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime rel=appRuntimeStateRuntime
This resource's appRuntimeStateRuntime singleton resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager rel=deploymentManager
This resource's deploymentManager singleton resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager rel=editSessionConfigurationManager
This resource's editSessionConfigurationManager singleton resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime rel=partitionLifeCycleRuntime
This resource's partitionLifeCycleRuntime singleton resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name} rel=self
This resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime

This resource manages a weblogic.management.runtime.AppRuntimeStateRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.AppRuntimeStateRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.AppRuntimeStateRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getCurrentState rel=action title=getCurrentState
This resource's getCurrentState action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getIntendedState rel=action title=getIntendedState
This resource's getIntendedState action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleIds rel=action title=getModuleIds
This resource's getModuleIds action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleTargets rel=action title=getModuleTargets
This resource's getModuleTargets action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleType rel=action title=getModuleType
This resource's getModuleType action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeMillis rel=action title=getRetireTimeMillis
This resource's getRetireTimeMillis action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeoutSeconds rel=action title=getRetireTimeoutSeconds
This resource's getRetireTimeoutSeconds action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getSubmoduleIds rel=action title=getSubmoduleIds
This resource's getSubmoduleIds action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isActiveVersion rel=action title=isActiveVersion
This resource's isActiveVersion action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isAdminMode rel=action title=isAdminMode
This resource's isAdminMode action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime rel=self
This resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getCurrentState

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

- POST

POST

Aggregate state for the application. This is defined as the most advanced state of the application's modules on the named target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

target

logical target where the app is deployed

Type: string

Response Body

Contains a JSON object with a string return field.

POST

Aggregate state for the module. This is defined as the most advanced state of the module on all servers associated with the named target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

target

logical target where module is deployed

Type: string

Response Body

Contains a JSON object with a string return field.

POST

Aggregate state for a submodule. This is defined as the most advanced state of the submodule on all servers associated with the named target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

subModuleId

subModuleId

Type: string

target

logical target where module is deployed

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getIntendedState

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

The state the application should be in.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a string return field.

POST

The state the application should be in on a specific target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

target

target

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleIds

The resource supports the following methods:

- POST

POST

Names of the modules contained in the application. This does not include submodules.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleTargets

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Logical targets where the submodule is deployed.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

subModuleId

subModuleId

Type: string

Response Body

Contains a JSON object with a array of string return field.

POST

Logical targets where the module is deployed.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleType

The resource supports the following methods:

- POST

POST

Indicates the type of module: EAR, WAR, etc.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeMillis

The resource supports the following methods:

- POST

POST

The time when the application will be retired.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a long return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeoutSeconds

The resource supports the following methods:

- POST

POST

The amount of time the application is given to retire.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a int return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getSubmoduleIds

The resource supports the following methods:

- POST

POST

Submodules associated with this module.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isActiveVersion

The resource supports the following methods:

- POST

POST

Indicates if the application is the active version, the one that new sessions will use.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

is the application id

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isAdminMode

The resource supports the following methods:

- POST

POST

Indicates if the application should only be available through the administration port. This is the desired state of the application.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

is the application id

Type: string

target

target

Type: string

Response Body

Contains a JSON object with a boolean return field.

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

This resource manages a weblogic.management.runtime.DeploymentManagerMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.DeploymentManagerMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.DeploymentManagerMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/confirmApplicationName rel=action title=confirmApplicationName
This resource's confirmApplicationName action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploy rel=action title=deploy
This resource's deploy action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/distribute rel=action title=distribute
This resource's distribute action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/purgeCompletedDeploymentProgressObjects rel=action title=purgeCompletedDeploymentProgressObjects
This resource's purgeCompletedDeploymentProgressObjects action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/redeploy rel=action title=redeploy
This resource's redeploy action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/undeploy rel=action title=undeploy
This resource's undeploy action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/update rel=action title=update
This resource's update action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes rel=appDeploymentRuntimes
This resource's appDeploymentRuntimes collection resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects rel=deploymentProgressObjects
This resource's deploymentProgressObjects collection resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes rel=libDeploymentRuntimes
This resource's libDeploymentRuntimes collection resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager rel=self
This resource.

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

This resource manages a collection of weblogic.management.runtime.AppDeploymentRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.AppDeploymentRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.AppDeploymentRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes rel=self
This resource.

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

This resource manages a weblogic.management.runtime.AppDeploymentRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.AppDeploymentRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.AppDeploymentRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/getState rel=action title=getState
This resource's getState action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/redeploy rel=action title=redeploy
This resource's redeploy action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/start rel=action title=start
This resource's start action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/stop rel=action title=stop
This resource's stop action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/undeploy rel=action title=undeploy
This resource's undeploy action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/update rel=action title=update
This resource's update action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name} rel=self
This resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/getState

The resource supports the following methods:

- POST

POST

The state of the application for a target. Notifications will be generated for this attribute on state changes. Valid states are those supported by the weblogic.management.runtime.AppRuntimeStateRuntimeMBean The notification types are appdeployment.created, appdeployment.deleted, appdeployment.state.new, appdeployment.state.prepared, appdeployment.state.admin, appdeployment.state.active, appdeployment.state.retired, appdeployment.state.failed, appdeployment.state.update.pending, and appdeployment.state.unknown. The userdata is a Map where the keys are target names and the values are the application state for that target.

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

target

the target for the application state

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/redeploy

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Redeploy the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to redeploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.

Type: array of string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Redeploy the application using the default options and configured targets. This is a synchronous operation that returns when the redeploy 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. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/start

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Start the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to start the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be started on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Start the application using the default options and configured targets. This is a synchronous operation that returns when the start 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. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/stop

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Stop the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to stop the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be stoped on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Stop the application using the default options and configured targets. This is a synchronous operation that returns when the stop 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. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/undeploy

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Undeploy the application using the default options and configured targets. This is a synchronous operation that returns when the undeploy 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. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Undeploy the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to undeploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be undeployed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/update

The resource supports the following methods:

- POST

POST

Allows for updating an application configuration using an changed deployment plan.

A configuration update is equivalent to replacing the application's deployment plan. The deployment plan is redeployed in-place. A new version of the application is not started, even if the new deployment plan has a different version.

The update succeeds only if changes to the deployment plan do not require the application to be restarted. Configuration changes in the new deployment plan must be limited to tuning the application. Changes to resource bindings causes the update to fail. Use redeploy() to apply resource binding changes to a production application.

This method targets only root modules. Module level targeting is not supported.

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

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

represent the targets on which to update the application.

Type: array of string

plan

The deployment plan containing the new deployment configuration information.

Type: string

deploymentOptions

Allows for overriding the deployment options. May be null.

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

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

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Used by the deployment subsystem to confirm an application name.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

isRedeployment

should be true in the case where this function is called for a redeployment.

Type: boolean

appSource

is a the path to the application.

Type: string

optional

alternate app descriptor.

Type: string

tentativeName

The name proposed for the application (provided by the user, or through the manifest). Null if no name was specified by the user or through the manifest.

Type: string

tentativeApplicationId

The tentative application ID. May only be null if the application is not versioned. If tentativeName is null and the application is versioned, this should be just the version string (which includes both the implementation and specification versions).

Type: string

deploymentOptions

deployment options

Type: java.util.Properties

Response Body

Contains a JSON object with a string return field.

POST

Used by the deployment subsystem to confirm an application name.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

isRedeployment

should be true in the case where this function is called for a redeployment.

Type: boolean

appSource

is a the path to the application.

Type: string

optional

alternate application descriptor path

Type: string

tentativeName

The name proposed for the application (provided by the user, or through the manifest). Null if no name was specified by the user or through the manifest.

Type: string

tentativeApplicationId

The tentative application ID. May only be null if the application is not versioned. If tentativeName is null and the application is versioned, this should be just the version string (which includes both the implementation and specification versions).

Type: string

Response Body

Contains a JSON object with a string return field.

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

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

A convenience method for distributing and starting 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 deploy operation has completed. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.

The default options are

- clusterDeploymentTimeout: 3600000 milliseconds

- gracefulIgnoreSessions: false

- gracefulProductionToAdmin: false

- retireGracefully: true

- retireTimeout: no timeout

- adminMode: false

- timeout: no timeout

If any modules are currently running, this method immediately restarts those modules using the newer files. Restarting modules in this manner is not the same as redeployment, because session state is not preserved for the active modules.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

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

Type: string

plan

The deployment plan for this application. May be null.

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

A convenience method for distributing and starting an application. The application source files and deployment plan are distributed to the deployment targets using the options specified. This is an asynchronous operation that returns immediately. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.

If any modules are currently running, this method immediately restarts those modules using the newer files. Restarting modules in this manner is not the same as redeployment, because session state is not preserved for the active modules.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

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

Type: string

targets

The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.

Type: array of string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

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

This resource manages a collection of weblogic.management.runtime.DeploymentProgressObjectMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.DeploymentProgressObjectMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.DeploymentProgressObjectMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects rel=self
This resource.

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

This resource manages a weblogic.management.runtime.DeploymentProgressObjectMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.DeploymentProgressObjectMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.DeploymentProgressObjectMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}/getExceptions rel=action title=getExceptions
This resource's getExceptions action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name} rel=self
This resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempt to cancel the deployment operation. Any actions which have yet to start will be inhibited. Any completed actions will remain in place.

Roles

Admin, Deployer

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}/getExceptions

The resource supports the following methods:

- POST

POST

If the current deployment operation has failed, this method may return zero or more exception(s) which represent the errors for this target. The array will not contain WLS exception classes; instead they will be new RuntimeExceptions containing the stack traces and messages from the original WLS Exceptions.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

target

the target where exceptions might have occurred.

Type: string

Response Body

Contains a JSON object with a array of java.lang.Throwable return field.

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

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

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. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

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

Type: string

plan

The deployment plan for this application. May be null.

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Distribute an application. The application source files and deployment plan are distributed to the deployment targets using the options specified. This is an asynchronous operation that returns immediately.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

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

Type: string

targets

The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be distributed on all configured targets.

Type: array of string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

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

This resource manages a collection of weblogic.management.runtime.LibDeploymentRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.LibDeploymentRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.LibDeploymentRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes rel=self
This resource.

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

This resource manages a weblogic.management.runtime.LibDeploymentRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.LibDeploymentRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.LibDeploymentRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}/redeploy rel=action title=redeploy
This resource's redeploy action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}/undeploy rel=action title=undeploy
This resource's undeploy action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name} rel=self
This resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}/redeploy

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Redeploy the library in the background for the targets specified with the options specified. This is an synchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to redeploy the library. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the library will be redeployed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The keys,units and default values for options are adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Redeploy the library using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are adminMode: false, timeout: no timeout

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

Roles

Admin, Deployer

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}/undeploy

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Undeploy the library using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are adminMode boolean false timeout: no timeout

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

Roles

Admin, Deployer

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Undeploy the library in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to undeploy the library. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the library will be undeployed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are adminMode boolean false timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

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

The resource supports the following methods:

- POST

POST

Removes progress objects for completed operations.

Roles

Admin, Deployer

Response Body

Contains an empty JSON object.

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

The resource supports the following methods:

- POST

POST

Redeploy the application that is deployed to a resource group template in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

Note that this API is only for redeploying applications or libraries that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for redeploying applications that are not deployed to a resource group template, and LibDeploymentRuntimeMBean should be used for redeploying libraries that are not deployed to a resource group template.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

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

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Undeploy the application that is deployed to a resource group template using the default options. This is a synchronous operation that returns when the undeploy 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. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

template

The resource group template

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Undeploy the application that is deployed to a resource group template in the background with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

Note that this API is only for undeploying applications that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for undeploying applications that are not deployed to a resource group template.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

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

The resource supports the following methods:

- POST

POST

Allows for updating an application configuration using an changed deployment plan for applications deployed to a resource group template.

A configuration update is equivalent to replacing the application's deployment plan. The deployment plan is redeployed in-place. A new version of the application is not started, even if the new deployment plan has a different version.

The update succeeds only if changes to the deployment plan do not require the application to be restarted. Configuration changes in the new deployment plan must be limited to tuning the application. Changes to resource bindings causes the update to fail. Use redeploy(String, String, Properties) to apply resource binding changes to a production application.

This method targets only root modules. Module level targeting is not supported.

Note that this API is only for updating applications that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for updating applications that are not deployed to a resource group template.

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

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager

This resource manages a weblogic.management.runtime.EditSessionConfigurationManagerMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.EditSessionConfigurationManagerMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.EditSessionConfigurationManagerMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/forceDestroyEditSessionConfiguration rel=action title=forceDestroyEditSessionConfiguration
This resource's forceDestroyEditSessionConfiguration action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations rel=editSessionConfigurations
This resource's editSessionConfigurations collection resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager rel=self
This resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations

This resource manages a collection of weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instances.

The resource supports the following methods:

- GET

- POST

GET

Get this collection of weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations rel=self
This resource.

POST

Add a new weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance to this collection.

Roles

Admin, Deployer

Request Body

Must contain a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations/{name}

This resource manages a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.

The resource supports the following methods:

- DELETE

- GET

DELETE

Delete this weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.

Roles

Admin, Deployer

GET

Get this weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges rel=action title=containsUnactivatedChanges
This resource's containsUnactivatedChanges action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations/{name} rel=self
This resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges

The resource supports the following methods:

- POST

POST

Returns true if there are changes saved in the pending directory or there are changes in memory. To apply these changes, activate the session.

Roles

Admin, Deployer

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/forceDestroyEditSessionConfiguration

The resource supports the following methods:

- POST

POST

Destroys an existing named edit session configuration. This will destroy the associated edit session specific MBeanServer and remove the <domain>/edit/<name> or <domain>/partitions/<name>/edit/<name> directory and subdirectories.

Unlike destroyEditSessionConfiguration(EditSessionConfigurationRuntimeMBean), this operation does not end with error in case that session contains unactivated changes, and allows to destroy even edit sessions not owned by the caller (requires admin privileges).

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

editSession

Edit session to destroy.

Type: weblogic.management.runtime.EditSessionConfigurationRuntimeMBean reference

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime

This resource manages a weblogic.management.runtime.PartitionLifeCycleRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.PartitionLifeCycleRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.PartitionLifeCycleRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceShutdown rel=action title=forceShutdown
This resource's forceShutdown action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceSuspend rel=action title=forceSuspend
This resource's forceSuspend action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/getState rel=action title=getState
This resource's getState action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/purgeTasks rel=action title=purgeTasks
This resource's purgeTasks action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resume rel=action title=resume
This resource's resume action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/shutdown rel=action title=shutdown
This resource's shutdown action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/start rel=action title=start
This resource's start action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/startInAdmin rel=action title=startInAdmin
This resource's startInAdmin action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/suspend rel=action title=suspend
This resource's suspend action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes rel=resourceGroupLifeCycleRuntimes
This resource's resourceGroupLifeCycleRuntimes collection resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks rel=tasks
This resource's tasks collection resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceShutdown

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

- POST

POST

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

timeout

Type: int

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Forces the shutdown of the partition.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Forces the shutdown of the partition on specified targets.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceSuspend

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Forcefully suspends the partition.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Forcefully suspends the partition on specified targets.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/getState

The resource supports the following methods:

- POST

POST

Get the state of partition on a specific server.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

serverMBean

serverMBean

Type: weblogic.management.configuration.ServerMBean reference

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/purgeTasks

The resource supports the following methods:

- POST

POST

Clears the retained task collection.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes

This resource manages a collection of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes rel=self
This resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}

This resource manages a weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/forceShutdown rel=action title=forceShutdown
This resource's forceShutdown action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/forceSuspend rel=action title=forceSuspend
This resource's forceSuspend action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/getState rel=action title=getState
This resource's getState action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/purgeTasks rel=action title=purgeTasks
This resource's purgeTasks action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/resume rel=action title=resume
This resource's resume action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown rel=action title=shutdown
This resource's shutdown action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/start rel=action title=start
This resource's start action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin rel=action title=startInAdmin
This resource's startInAdmin action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend rel=action title=suspend
This resource's suspend action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks rel=tasks
This resource's tasks collection resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/forceShutdown

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Forces the shutdown of the resource group on specified targets.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Forces the shutdown of the resource group.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/forceSuspend

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Forcefully suspends the resource group on specified targets.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Forcefully suspends the resource group.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/getState

The resource supports the following methods:

- POST

POST

Get the state of resource group on a specific server.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

serverMBean

serverMBean

Type: weblogic.management.configuration.ServerMBean reference

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/purgeTasks

The resource supports the following methods:

- POST

POST

Clears the retained task collection.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/resume

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Transitions the resource group from ADMIN to RUNNING state on specified targets.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Transitions the resource group from ADMIN to RUNNING state.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

- POST

- POST

- POST

- POST

POST

Shuts down the resource group gracefully. (equivalent to shutdown(targets, 0, false)).

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down the resource group gracefully on all targets.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully shuts down a resource group.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

targets

the specific targets on which to shut down this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully shuts down a resource group.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down a resource group gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: int

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down a resource group gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: int

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

targets

the specific targets on which to shut down this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/start

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Starts resource group.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Starts the resource group on specified targets.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Starts the resource group in the admin state in specified targets

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group in "admin" state

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Starts the resource group in the admin state in all the targets

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

- POST

- POST

POST

Transitions the resource group from RUNNING to ADMIN state gracefully on specified targets.

Applications are in admin mode. Inflight work is completed.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.

Type: int

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully suspends the resource group to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully suspends the resource group to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Transitions the resource group from RUNNING to ADMIN state gracefully.

Applications are in admin mode. Inflight work is completed.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.

Type: int

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks

This resource manages a collection of weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}

This resource manages a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resume

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Transitions the partition from ADMIN to RUNNING state.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Transitions the partition from ADMIN to RUNNING state on specified targets..

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/shutdown

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

- POST

- POST

- POST

- POST

POST

Shuts down the partition gracefully. (equivalent to shutdown(targets, 0, false)).

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully shuts down a partition.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

targets

the specific targets on which to shut down this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully shuts down a partition.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down a partition gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: int

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

targets

the specific targets on which to shut down this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down the partition gracefully on all targets.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down a partition gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: int

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/start

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

- POST

POST

Starts partition.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Starts the partition in initalState within the specified timeOut

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

initialState

can be can be ADMIN or RUNNING, Default is RUNNING

Type: string

timeOut

Specifies the number of milliseconds to start a Partition. Throws InterruptedException if Partition is unable to start during that duration and leaves the Partition in UNKNOWN state. Default is 60000ms

Type: int

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Starts the partition on specified targets.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/startInAdmin

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Starts the partition in the admin state.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Starts the partition in the admin state.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition in "admin" state

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/suspend

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

- POST

- POST

POST

Transitions the partition from RUNNING to ADMIN state gracefully on specified targets.

Applications are in admin mode. Inflight work is completed.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the partition to transition gracefully. The partition automatically calls forceSuspend() after timeout.

Type: int

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

targets

the specific targets on which to start this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully suspends the partition to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Transitions the partition from RUNNING to ADMIN state gracefully.

Applications are in admin mode. Inflight work is completed.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the partition to transition gracefully. The partition automatically calls forceSuspend() after timeout.

Type: int

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully suspends the partition to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks

This resource manages a collection of weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}

This resource manages a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager

This resource manages a weblogic.management.runtime.EditSessionConfigurationManagerMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.EditSessionConfigurationManagerMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.EditSessionConfigurationManagerMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/forceDestroyEditSessionConfiguration rel=action title=forceDestroyEditSessionConfiguration
This resource's forceDestroyEditSessionConfiguration action resource.

- uri=/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations rel=editSessionConfigurations
This resource's editSessionConfigurations collection resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager rel=self
This resource.

/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations

This resource manages a collection of weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instances.

The resource supports the following methods:

- GET

- POST

GET

Get this collection of weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations rel=self
This resource.

POST

Add a new weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance to this collection.

Roles

Admin, Deployer

Request Body

Must contain a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity.

/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}

This resource manages a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.

The resource supports the following methods:

- DELETE

- GET

DELETE

Delete this weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.

Roles

Admin, Deployer

GET

Get this weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges rel=action title=containsUnactivatedChanges
This resource's containsUnactivatedChanges action resource.

- uri=/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name} rel=self
This resource.

/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges

The resource supports the following methods:

- POST

POST

Returns true if there are changes saved in the pending directory or there are changes in memory. To apply these changes, activate the session.

Roles

Admin, Deployer

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/forceDestroyEditSessionConfiguration

The resource supports the following methods:

- POST

POST

Destroys an existing named edit session configuration. This will destroy the associated edit session specific MBeanServer and remove the <domain>/edit/<name> or <domain>/partitions/<name>/edit/<name> directory and subdirectories.

Unlike destroyEditSessionConfiguration(EditSessionConfigurationRuntimeMBean), this operation does not end with error in case that session contains unactivated changes, and allows to destroy even edit sessions not owned by the caller (requires admin privileges).

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

editSession

Edit session to destroy.

Type: weblogic.management.runtime.EditSessionConfigurationRuntimeMBean reference

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime

This resource manages a weblogic.management.runtime.ElasticServiceManagerRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.ElasticServiceManagerRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ElasticServiceManagerRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/getScalingTasks rel=action title=getScalingTasks
This resource's getScalingTasks action resource.

- uri=/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/purgeScalingTasks rel=action title=purgeScalingTasks
This resource's purgeScalingTasks action resource.

- uri=/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleDown rel=action title=scaleDown
This resource's scaleDown action resource.

- uri=/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleUp rel=action title=scaleUp
This resource's scaleUp action resource.

- uri=/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime rel=self
This resource.

/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/getScalingTasks

The resource supports the following methods:

- POST

POST

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

clusterName

Cluster name

Type: string

size

The number of ScalingTaskRuntimeMBean to return starting with the most recent.

Type: int

Response Body

Contains a JSON object with a array of weblogic.management.runtime.ScalingTaskRuntimeMBean references return field.

/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/purgeScalingTasks

The resource supports the following methods:

- POST

POST

Purge scaling tasks for a service which have completed at least "age" seconds ago. Tasks which are currently running will not be purged.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

clusterName

Cluster name

Type: string

age

Age of tasks to be purged in seconds

Type: int

Response Body

Contains a JSON object with a int return field.

/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleDown

The resource supports the following methods:

- POST

POST

Perform a scale down operation

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

clusterName

Cluster name

Type: string

scaleFactor

the size by which the service must be scaled up

Type: int

Response Body

Contains a JSON object with a weblogic.management.runtime.ScalingTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleUp

The resource supports the following methods:

- POST

POST

Perform a scale up operation

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

clusterName

Cluster name

Type: string

scaleFactor

the size by which the service must be scaled up

Type: int

Response Body

Contains a JSON object with a weblogic.management.runtime.ScalingTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/forceShutdownPartitionWait

The resource supports the following methods:

- POST

POST

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

partitionMBean

partitionMBean

Type: weblogic.management.configuration.PartitionMBean reference

timeout

Specifies the number of milliseconds to stop a Partition. Throws InterruptedException if Partition is unable to stop during that duration and leaves the Partition in UNKNOWN state. Default is 60000ms

Type: int

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/logRuntime

This resource manages a weblogic.management.runtime.LogRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.LogRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.LogRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/logRuntime/ensureLogOpened rel=action title=ensureLogOpened
This resource's ensureLogOpened action resource.

- uri=/management/weblogic/{version}/domainRuntime/logRuntime/flushLog rel=action title=flushLog
This resource's flushLog action resource.

- uri=/management/weblogic/{version}/domainRuntime/logRuntime/forceLogRotation rel=action title=forceLogRotation
This resource's forceLogRotation action resource.

- uri=/management/weblogic/{version}/domainRuntime/logRuntime rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/logRuntime rel=self
This resource.

/management/weblogic/{version}/domainRuntime/logRuntime/ensureLogOpened

The resource supports the following methods:

- POST

POST

Ensures that that the output stream to the underlying is opened if it got closed previously due to errors.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/logRuntime/flushLog

The resource supports the following methods:

- POST

POST

Flushes the buffer to the log file on disk.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/logRuntime/forceLogRotation

The resource supports the following methods:

- POST

POST

Forces the rotation of the underlying log immediately.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime

This resource manages a weblogic.management.runtime.MessageDrivenControlEJBRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.MessageDrivenControlEJBRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.MessageDrivenControlEJBRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/printMDBStatus rel=action title=printMDBStatus
This resource's printMDBStatus action resource.

- uri=/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/resumeMDBs rel=action title=resumeMDBs
This resource's resumeMDBs action resource.

- uri=/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/suspendMDBs rel=action title=suspendMDBs
This resource's suspendMDBs action resource.

- uri=/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime rel=self
This resource.

/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/printMDBStatus

The resource supports the following methods:

- POST

POST

Prints the MDBStatus for the specific type of MDB

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

ejbName

ejbName

Type: string

applicationName

applicationName

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/resumeMDBs

The resource supports the following methods:

- POST

POST

Resumes the specific type of MDB by calling start on the JMS Connection.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

ejbName

ejbName

Type: string

applicationName

applicationName

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/suspendMDBs

The resource supports the following methods:

- POST

POST

Suspends the specific type of MDB by calling stop on the JMS Connection.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

ejbName

ejbName

Type: string

applicationName

applicationName

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime

This resource manages a weblogic.management.runtime.MigratableServiceCoordinatorRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.MigratableServiceCoordinatorRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.MigratableServiceCoordinatorRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrate rel=action title=migrate
This resource's migrate action resource.

- uri=/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateJTA rel=action title=migrateJTA
This resource's migrateJTA action resource.

- uri=/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateSingleton rel=action title=migrateSingleton
This resource's migrateSingleton action resource.

- uri=/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime rel=self
This resource.

/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrate

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Migrates all services deployed to the migratableTarget to the destination server. This method assumes that the source and the destination server are up and running. Precondition: The migratableTarget must contain at least one server. The destination server must be a member of the migratableTarget's list of candidate servers. If automatic migration mode is disabled, the destination server must not be the currently hosting server (i.e. head of candidate list of the migratableTarget). Postcondition: If automatic migration mode is disabled and if the migration succeeded, the head of the candidate server list in the migratableTarget will be the destination server.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

migratableTarget

- all services targeted to this target are to be migrated to the destination server. THIS MUST BE A CONFIG MBEAN

Type: weblogic.management.configuration.MigratableTargetMBean reference

destination

- the new server where the services deployed to migratableTarget shall be activated

Type: weblogic.management.configuration.ServerMBean reference

Response Body

Contains an empty JSON object.

POST

Migrates all services deployed to the migratableTarget to the destination server. Use this method if either the source or the destination or both are not running. Precondition: The migratableTarget must contain at least one server. The destination server must be a member of the migratableTarget's list of candidate servers. If automatic migration mode is disabled, the destination server must not be the currently hosting server (i.e. head of candidate list of the migratableTarget). Postcondition: If automatic migration mode is disabled and if the migration succeeded, the head of the candidate server list in the migratableTarget will be the destination server.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

migratableTarget

- all services targeted to this target are to be migrated to the destination server. THIS MUST BE A CONFIG MBEAN

Type: weblogic.management.configuration.MigratableTargetMBean reference

destination

- the new server where the services deployed to migratableTarget shall be activated

Type: weblogic.management.configuration.ServerMBean reference

sourceUp

- the currently active server is up and running. If false, the administrator must ensure that the services deployed to migratableTarget are NOT active.

Type: boolean

destinationUp

- the destination server is up and running.

Type: boolean

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateJTA

The resource supports the following methods:

- POST

POST

Migrates the JTARecoveryManager deployed to a migratableTarget to the destination server.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

migratableTarget

migratableTarget

Type: weblogic.management.configuration.MigratableTargetMBean reference

destination

destination

Type: weblogic.management.configuration.ServerMBean reference

sourceUp

sourceUp

Type: boolean

destinationUp

destinationUp

Type: boolean

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateSingleton

The resource supports the following methods:

- POST

POST

Migrates the singleton service specified by the SingletonServiceMBean to the destination server. This method assumes that the source and the destination server are up and running. Precondition: The SingletonServiceMBean must contain at least one server. The destination server must be a member of the SingletonServiceMBean's list of candidate servers. If automatic migration mode is disabled, the destination server must not be the currently hosting server (i.e. head of candidate list of the migratableTarget). Postcondition: If automatic migration mode is disabled and if the migration succeeded, the head of the candidate server list in the migratableTarget will be the destination server.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

singletonService

- SingletonService to be migrated to the destination server. THIS MUST BE A CONFIG MBEAN

Type: weblogic.management.configuration.SingletonServiceMBean reference

destination

- the new server where the singleton service shall be activated

Type: weblogic.management.configuration.ServerMBean reference

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/migrationDataRuntimes

This resource manages a collection of weblogic.management.runtime.MigrationDataRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.MigrationDataRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.MigrationDataRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/migrationDataRuntimes rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/migrationDataRuntimes rel=self
This resource.

/management/weblogic/{version}/domainRuntime/migrationDataRuntimes/{name}

This resource manages a weblogic.management.runtime.MigrationDataRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.MigrationDataRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.MigrationDataRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/migrationDataRuntimes/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/migrationDataRuntimes rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/migrationDataRuntimes/{name} rel=self
This resource.

/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes

This resource manages a collection of weblogic.management.runtime.NodeManagerRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.NodeManagerRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.NodeManagerRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes rel=self
This resource.

/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes/{name}

This resource manages a weblogic.management.runtime.NodeManagerRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.NodeManagerRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.NodeManagerRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes/{name} rel=self
This resource.

/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime

This resource manages a weblogic.management.runtime.WseePolicySubjectManagerRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.WseePolicySubjectManagerRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.WseePolicySubjectManagerRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/getPolicyRefStatus rel=action title=getPolicyRefStatus
This resource's getPolicyRefStatus action resource.

- uri=/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/isOWSMAttachable rel=action title=isOWSMAttachable
This resource's isOWSMAttachable action resource.

- uri=/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/removePolicyReference rel=action title=removePolicyReference
This resource's removePolicyReference action resource.

- uri=/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/setPolicyRefStatus rel=action title=setPolicyRefStatus
This resource's setPolicyRefStatus action resource.

- uri=/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime rel=self
This resource.

/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/getPolicyRefStatus

The resource supports the following methods:

- POST

POST

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

policySubject

policySubject

Type: string

policyReferenceURI

policyReferenceURI

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/isOWSMAttachable

The resource supports the following methods:

- POST

POST

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

policySubject

policySubject

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/removePolicyReference

The resource supports the following methods:

- POST

POST

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

policySubject

policySubject

Type: string

policyReferenceURI

policyReferenceURI

Type: string

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/setPolicyRefStatus

The resource supports the following methods:

- POST

POST

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

policySubject

policySubject

Type: string

policyReferenceURI

policyReferenceURI

Type: string

enable

enable

Type: boolean

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes

This resource manages a collection of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes rel=self
This resource.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}

This resource manages a weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceShutdown rel=action title=forceShutdown
This resource's forceShutdown action resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceSuspend rel=action title=forceSuspend
This resource's forceSuspend action resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/getState rel=action title=getState
This resource's getState action resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/purgeTasks rel=action title=purgeTasks
This resource's purgeTasks action resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/resume rel=action title=resume
This resource's resume action resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown rel=action title=shutdown
This resource's shutdown action resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/start rel=action title=start
This resource's start action resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin rel=action title=startInAdmin
This resource's startInAdmin action resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend rel=action title=suspend
This resource's suspend action resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks rel=tasks
This resource's tasks collection resource.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceShutdown

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Forces the shutdown of the resource group on specified targets.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Forces the shutdown of the resource group.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceSuspend

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Forcefully suspends the resource group on specified targets.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Forcefully suspends the resource group.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/getState

The resource supports the following methods:

- POST

POST

Get the state of resource group on a specific server.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

serverMBean

serverMBean

Type: weblogic.management.configuration.ServerMBean reference

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/purgeTasks

The resource supports the following methods:

- POST

POST

Clears the retained task collection.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/resume

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Transitions the resource group from ADMIN to RUNNING state on specified targets.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Transitions the resource group from ADMIN to RUNNING state.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

- POST

- POST

- POST

- POST

POST

Shuts down the resource group gracefully. (equivalent to shutdown(targets, 0, false)).

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down the resource group gracefully on all targets.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully shuts down a resource group.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

targets

the specific targets on which to shut down this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully shuts down a resource group.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down a resource group gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: int

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down a resource group gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: int

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

targets

the specific targets on which to shut down this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/start

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Starts resource group.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Starts the resource group on specified targets.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Starts the resource group in the admin state in specified targets

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group in "admin" state

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Starts the resource group in the admin state in all the targets

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

- POST

- POST

POST

Transitions the resource group from RUNNING to ADMIN state gracefully on specified targets.

Applications are in admin mode. Inflight work is completed.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.

Type: int

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully suspends the resource group to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully suspends the resource group to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Transitions the resource group from RUNNING to ADMIN state gracefully.

Applications are in admin mode. Inflight work is completed.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.

Type: int

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks

This resource manages a collection of weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}

This resource manages a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/restartSystemResource

The resource supports the following methods:

- POST

POST

Restarts a system resource on all nodes to which it is deployed.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

resource

resource

Type: weblogic.management.configuration.SystemResourceMBean reference

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService

This resource manages a weblogic.management.runtime.RolloutServiceRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.RolloutServiceRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.RolloutServiceRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/deleteWorkflow rel=action title=deleteWorkflow
This resource's deleteWorkflow action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/execScript rel=action title=execScript
This resource's execScript action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/executeWorkflow rel=action title=executeWorkflow
This resource's executeWorkflow action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/getWorkflowTask rel=action title=getWorkflowTask
This resource's getWorkflowTask action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/initializeRolloutOracleHome rel=action title=initializeRolloutOracleHome
This resource's initializeRolloutOracleHome action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/restartNodeManager rel=action title=restartNodeManager
This resource's restartNodeManager action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/revertWorkflow rel=action title=revertWorkflow
This resource's revertWorkflow action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/rollingRestart rel=action title=rollingRestart
This resource's rollingRestart action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/rolloutApplications rel=action title=rolloutApplications
This resource's rolloutApplications action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/rolloutJavaHome rel=action title=rolloutJavaHome
This resource's rolloutJavaHome action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/rolloutOracleHome rel=action title=rolloutOracleHome
This resource's rolloutOracleHome action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/rolloutUpdate rel=action title=rolloutUpdate
This resource's rolloutUpdate action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/shutdownServer rel=action title=shutdownServer
This resource's shutdownServer action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/startServer rel=action title=startServer
This resource's startServer action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows rel=allWorkflows
This resource's allWorkflows collection resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows rel=inactiveWorkflows
This resource's inactiveWorkflows collection resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows rel=stoppedWorkflows
This resource's stoppedWorkflows collection resource.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows

This resource manages a collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.WorkflowTaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows rel=self
This resource.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}

This resource manages a weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.WorkflowTaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/canResume rel=action title=canResume
This resource's canResume action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextExecuteStep rel=action title=showNextExecuteStep
This resource's showNextExecuteStep action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextRevertStep rel=action title=showNextRevertStep
This resource's showNextRevertStep action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/waitFor rel=action title=waitFor
This resource's waitFor action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/cancel

The resource supports the following methods:

- POST

POST

Sets the cancel flag for the workflow. A canceled workflow will stop as soon as possible. If a command implements the CommandCancelInterface, it will be notified when this flag is set, otherwise, the command will either check it periodically, or the workflow will cancel when the current command completes.

The state of a cancelled command will be {@code CANCELED} or {@code REVERT_CANCELED}.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/canResume

The resource supports the following methods:

- POST

POST

It is possible to resume (execute or revert) a workflow if it was already executed and is in a FAIL, REVERT_FAIL, CANCELED or REVERT_CANCELED state.

Roles

Admin

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextExecuteStep

The resource supports the following methods:

- POST

POST

Get the next step that will be executed if the workflow is eligible to be resumed and the user were to call execute on it.

Roles

Admin

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextRevertStep

The resource supports the following methods:

- POST

POST

Get the next step that will be reverted if the workflow is eligible to be resumed and the user were to call revert on it.

Roles

Admin

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/waitFor

The resource supports the following methods:

- POST

POST

Waits for the process to finish.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/deleteWorkflow

The resource supports the following methods:

- POST

POST

Delete workflow data of finished workflow

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

workflowId

is ID of workflow to be deleted - {@code WorkflowTaskRuntimeMBean.getWorkflowId()}

Type: string

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/execScript

The resource supports the following methods:

- POST

POST

Run a custom script from the domain/bin/patching directory on the specified Machine.

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

machineName

Name of MachineMBean where the NodeManager runs

Type: string

scriptName

Name of script to run

Type: string

timeoutMillis

millis to wait for script exec to complete. Once the specified time has elapsed the script process is halted and the NodeManager returns the error denoting the timeout. Default is 0 where we block until completion.

Type: long

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/executeWorkflow

The resource supports the following methods:

- POST

POST

Continue in workflow execution. Can be called only for terminated workflows.

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

wfTask

which should be executed - continued. {@code delegate.isStopped()} must be {@code null}

Type: weblogic.management.runtime.WorkflowTaskRuntimeMBean reference

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/getWorkflowTask

The resource supports the following methods:

- POST

POST

Returns {@code WorkflowTaskRuntimeMBean} for given id. Progress must NOT be yet deleted and must be started by this service.

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

id

of executed workflow

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows

This resource manages a collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.WorkflowTaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows rel=self
This resource.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}

This resource manages a weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.WorkflowTaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/canResume rel=action title=canResume
This resource's canResume action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextExecuteStep rel=action title=showNextExecuteStep
This resource's showNextExecuteStep action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextRevertStep rel=action title=showNextRevertStep
This resource's showNextRevertStep action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/waitFor rel=action title=waitFor
This resource's waitFor action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/cancel

The resource supports the following methods:

- POST

POST

Sets the cancel flag for the workflow. A canceled workflow will stop as soon as possible. If a command implements the CommandCancelInterface, it will be notified when this flag is set, otherwise, the command will either check it periodically, or the workflow will cancel when the current command completes.

The state of a cancelled command will be {@code CANCELED} or {@code REVERT_CANCELED}.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/canResume

The resource supports the following methods:

- POST

POST

It is possible to resume (execute or revert) a workflow if it was already executed and is in a FAIL, REVERT_FAIL, CANCELED or REVERT_CANCELED state.

Roles

Admin

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextExecuteStep

The resource supports the following methods:

- POST

POST

Get the next step that will be executed if the workflow is eligible to be resumed and the user were to call execute on it.

Roles

Admin

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextRevertStep

The resource supports the following methods:

- POST

POST

Get the next step that will be reverted if the workflow is eligible to be resumed and the user were to call revert on it.

Roles

Admin

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/waitFor

The resource supports the following methods:

- POST

POST

Waits for the process to finish.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/initializeRolloutOracleHome

The resource supports the following methods:

- POST

POST

Creates but does not start a workflow that can be used to update OracleHome. rolloutUpdate(target, [patchedOracleHome, backupOracleHome, isRollback], [options])

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

target

can be the name of a domain, clusters or servers

Type: string

rolloutOracleHome

the location of the new OracleHome to use

Type: string

backupOracleHome

the location where the current OracleHome should be moved

Type: string

isRollback

true if the new OracleHome is a lower patch version than the current one

Type: string

options

comma separated list of <name>=<value> options

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.RolloutTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/restartNodeManager

The resource supports the following methods:

- POST

POST

Restart NodeManager. The java based NodeManager process will exit and the startNodeManager script will detect the need to restart and will restart the NodeManager using the same original call path that was used to start the NodeManager. If this call path was using a symbolic link, then the NodeManager will be started from the location of the symbolic link which may have the affect of starting the NodeManager with an updated set of binaries or scripts.

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

machineName

Name of MachineMBean where NodeManager runs

Type: string

isAdminServer

true if the affected server is the AdminServer

Type: boolean

timeoutMillis

How long to wait for the client to reconnect to the NodeManager after it restarts. Timeout exceeded will consider the task failed and the NodeManager not reachable. Default is 3 minutes.

Type: long

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/revertWorkflow

The resource supports the following methods:

- POST

POST

Reverts workflow execution. Can be called only for terminated workflows.

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

wfTask

which should be reverted. {@code delegate.isStopped()} must be {@code null}

Type: weblogic.management.runtime.WorkflowTaskRuntimeMBean reference

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/rollingRestart

The resource supports the following methods:

- POST

POST

Creates and starts a workflow that can be used to update restart servers, one at a time. rolloutUpdate(target, [patchedOracleHome, backupOracleHome, isRollback], [javaHome], [applicationProperties], [options])

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

target

can be the name of a domain, clusters or servers

Type: string

options

comma separated list of <name>=<value> options

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/rolloutApplications

The resource supports the following methods:

- POST

POST

Creates and starts a workflow that can be used to update Applications. rolloutUpdate(target, [applicationProperties], [options])

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

target

can be the name of a domain, clusters or servers

Type: string

applicationProperties

the path of a formatted text file containing the information needed to upgrade applications

Type: string

options

comma separated list of <name>=<value> options

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/rolloutJavaHome

The resource supports the following methods:

- POST

POST

Creates and starts a workflow that can be used to update JavaHome. rolloutUpdate(target, [javaHome], [options])

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

target

can be the name of a domain, clusters or servers

Type: string

javaHome

the path to the new JavaHome directory

Type: string

options

comma separated list of <name>=<value> options

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/rolloutOracleHome

The resource supports the following methods:

- POST

POST

Creates and starts a workflow that can be used to update OracleHome. rolloutUpdate(target, [patchedOracleHome, backupOracleHome, isRollback], [options])

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

target

can be the name of a domain, clusters or servers

Type: string

rolloutOracleHome

the location of the new OracleHome to use

Type: string

backupOracleHome

the location where the current OracleHome should be moved

Type: string

isRollback

true if the new OracleHome is a lower patch version than the current one

Type: string

options

comma separated list of <name>=<value> options

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.RolloutTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/rolloutUpdate

The resource supports the following methods:

- POST

POST

Creates and starts a workflow that can be used to update OracleHome, JavaHome, Applications, or any combination of those. rolloutUpdate(target, [patchedOracleHome, backupOracleHome, isRollback], [javaHome], [applicationProperties], [options])

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

target

can be the name of a domain, clusters or servers

Type: string

rolloutOracleHome

the location of the new OracleHome to use

Type: string

backupOracleHome

the location where the current OracleHome should be moved

Type: string

isRollback

true if the new OracleHome is a lower patch version than the current one

Type: string

javaHome

the path to the new JavaHome directory

Type: string

applicationProperties

the path of a formatted text file containing the information needed to upgrade applications

Type: string

options

comma separated list of <name>=<value> options

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/shutdownServer

The resource supports the following methods:

- POST

POST

Shutdowns the named server.

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

serverName

Name of the server that needs to be shutdown

Type: string

sessionTimeout

shutdownTimeout Time limit (in seconds) for server to complete a graceful shutdown. The default is 0 indicating no timeout.

Type: int

ignoreSessions

Drop sessions immediately rather than waiting for them to complete or timeout.

Type: boolean

waitForAllSessions

Wait for all sessions (even sessions backed by a server) to complete.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/startServer

The resource supports the following methods:

- POST

POST

Starts the managed server (using the new path location).

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

serverName

Name of managed server to be started

Type: string

sessionTimeout

(required for revert) shutdownTimeout Time limit (in seconds) for server to complete a graceful shutdown.

Type: int

ignoreSessions

(required for revert) Drop sessions immediately rather than waiting for them to complete or timeout.

Type: boolean

waitForAllSessions

Wait for all sessions (even sessions backed by a server) to complete.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows

This resource manages a collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.WorkflowTaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows rel=self
This resource.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}

This resource manages a weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.WorkflowTaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/canResume rel=action title=canResume
This resource's canResume action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextExecuteStep rel=action title=showNextExecuteStep
This resource's showNextExecuteStep action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextRevertStep rel=action title=showNextRevertStep
This resource's showNextRevertStep action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/waitFor rel=action title=waitFor
This resource's waitFor action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/cancel

The resource supports the following methods:

- POST

POST

Sets the cancel flag for the workflow. A canceled workflow will stop as soon as possible. If a command implements the CommandCancelInterface, it will be notified when this flag is set, otherwise, the command will either check it periodically, or the workflow will cancel when the current command completes.

The state of a cancelled command will be {@code CANCELED} or {@code REVERT_CANCELED}.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/canResume

The resource supports the following methods:

- POST

POST

It is possible to resume (execute or revert) a workflow if it was already executed and is in a FAIL, REVERT_FAIL, CANCELED or REVERT_CANCELED state.

Roles

Admin

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextExecuteStep

The resource supports the following methods:

- POST

POST

Get the next step that will be executed if the workflow is eligible to be resumed and the user were to call execute on it.

Roles

Admin

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextRevertStep

The resource supports the following methods:

- POST

POST

Get the next step that will be reverted if the workflow is eligible to be resumed and the user were to call revert on it.

Roles

Admin

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/waitFor

The resource supports the following methods:

- POST

POST

Waits for the process to finish.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/search

The resource supports the following methods:

- POST

POST

Search the domainRuntime tree.

Request Body

The search request body includes the search criteria.

Response Body

The search response includes the results of the search.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes

This resource manages a collection of weblogic.management.runtime.ServerLifeCycleRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.ServerLifeCycleRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.ServerLifeCycleRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes rel=self
This resource.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}

This resource manages a weblogic.management.runtime.ServerLifeCycleRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.ServerLifeCycleRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ServerLifeCycleRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceShutdown rel=action title=forceShutdown
This resource's forceShutdown action resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceSuspend rel=action title=forceSuspend
This resource's forceSuspend action resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv4URL rel=action title=getIPv4URL
This resource's getIPv4URL action resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv6URL rel=action title=getIPv6URL
This resource's getIPv6URL action resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/resume rel=action title=resume
This resource's resume action resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown rel=action title=shutdown
This resource's shutdown action resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/start rel=action title=start
This resource's start action resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInAdmin rel=action title=startInAdmin
This resource's startInAdmin action resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInStandby rel=action title=startInStandby
This resource's startInStandby action resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/suspend rel=action title=suspend
This resource's suspend action resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks rel=tasks
This resource's tasks collection resource.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceShutdown

The resource supports the following methods:

- POST

POST

Immediately transitions a server to the SHUTDOWN state. The server immediately terminates all current work, moves through the SHUTTING_DOWN state, and ends in the SHUTDOWN state.

You can forcefully shut down a server from any state except UNKNOWN

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the forceShutdown Action

This example uses the POST method to synchronously invoke the forceShutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/forceShutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_15_forceShutdown"
}],
"progress": "success",
"serverName": "Cluster-0-Server-1",
"operation": "forceShutdown",
"taskStatus": "TASK COMPLETED",
"completed": true
}

Example 2   Asynchronously Invoke the forceShutdown Action

This example uses the POST method to asynchronously invoke the forceShutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/forceShutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_23_forceShutdown

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_23_forceShutdown"
}],
"progress": "processing",
"serverName": "Cluster-0-Server-1",
"operation": "forceShutdown",
"taskStatus": "TASK IN PROGRESS",
"completed": false
}

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceSuspend

The resource supports the following methods:

- POST

POST

Transitions the server from RUNNING to ADMIN state forcefully cancelling inflight work.

Work that cannot be cancelled is dropped. Applications are brought into the admin mode forcefully.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the forceSuspend Action

This example uses the POST method to synchronously invoke the forceSuspend action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/forceSuspend?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_8_forceSuspend"
}],
"progress": "success",
"serverName": "Cluster-0-Server-1",
"operation": "forceSuspend",
"taskStatus": "TASK COMPLETED",
"completed": true
}

Example 2   Asynchronously Invoke the forceSuspend Action

This example uses the POST method to asynchronously invoke the forceSuspend action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/forceSuspend?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_20_forceSuspend"
}],
"progress": "success",
"serverName": "Cluster-0-Server-1",
"operation": "forceSuspend",
"taskStatus": "TASK COMPLETED",
"completed": true
}

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv4URL

The resource supports the following methods:

- POST

POST

The IPv4 URL that clients use when connecting to this server using the specified protocol.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

protocol

the desired protocol

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv6URL

The resource supports the following methods:

- POST

POST

The IPv6 URL that clients use when connecting to this server using the specified protocol.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

protocol

the desired protocol

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/resume

The resource supports the following methods:

- POST

POST

Transitions the server from ADMIN to RUNNING state.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the resume Action

This example uses the POST method to synchronously invoke the resume action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/resume?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_6_resume"
}],
"progress": "success",
"serverName": "Cluster-0-Server-1",
"operation": "resume",
"taskStatus": "TASK COMPLETED",
"completed": true
}

Example 2   Asynchronously Invoke the resume Action

This example uses the POST method to asynchronously invoke the resume action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/resume?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_18_resume

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_18_resume"
}],
"progress": "processing",
"serverName": "Cluster-0-Server-1",
"operation": "resume",
"taskStatus": "TASK IN PROGRESS",
"completed": false
}

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

- POST

POST

Gracefully transitions a server to the SHUTDOWN state. The server completes all current work before it shuts down.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the shutdown Action

This example uses the POST method to synchronously invoke the shutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/shutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_9_shutdown"
}],
"progress": "success",
"serverName": "Cluster-0-Server-1",
"operation": "shutdown",
"taskStatus": "TASK COMPLETED",
"completed": true
}

Example 2   Asynchronously Invoke the shutdown Action

This example uses the POST method to asynchronously invoke the shutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/shutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_21_shutdown

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_21_shutdown"
}],
"progress": "processing",
"serverName": "Cluster-0-Server-1",
"operation": "shutdown",
"taskStatus": "TASK IN PROGRESS",
"completed": false
}

POST

Gracefully shutdown the server after handling inflight work. The following inflight work is handled :

- Pending transaction's and TLOG checkpoint

- Pending HTTP sessions

- Pending JMS work

- Pending work in the Work Managers

- RMI requests with tx context or administrator calls

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the shutdown Action

This example uses the POST method to synchronously invoke the shutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{ timeout: 20, ignoreSessions: true, waitForAllSessions: true }" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/shutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_13_shutdown"
}],
"progress": "success",
"serverName": "Cluster-0-Server-1",
"operation": "shutdown",
"taskStatus": "TASK COMPLETED",
"completed": true
}

Example 2   Asynchronously Invoke the shutdown Action

This example uses the POST method to asynchronously invoke the shutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{ timeout: 20, ignoreSessions: true, waitForAllSessions: true }" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/shutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_27_shutdown

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_27_shutdown"
}],
"progress": "processing",
"serverName": "Cluster-0-Server-1",
"operation": "shutdown",
"taskStatus": "TASK IN PROGRESS",
"completed": false
}

POST

Gracefully transitions a server to the SHUTDOWN state. The server completes all current work before it shuts down.

This method is the same as calling:

shutdown(timeout, ignoreSessions, false);

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the shutdown Action

This example uses the POST method to synchronously invoke the shutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{ timeout: 20, ignoreSessions: true }" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/shutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_11_shutdown"
}],
"progress": "success",
"serverName": "Cluster-0-Server-1",
"operation": "shutdown",
"taskStatus": "TASK COMPLETED",
"completed": true
}

Example 2   Asynchronously Invoke the shutdown Action

This example uses the POST method to asynchronously invoke the shutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{ timeout: 20, ignoreSessions: true }" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/shutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_25_shutdown

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_25_shutdown"
}],
"progress": "processing",
"serverName": "Cluster-0-Server-1",
"operation": "shutdown",
"taskStatus": "TASK IN PROGRESS",
"completed": false
}

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/start

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Uses the Node Manager to start a Managed Server.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the start Action

This example uses the POST method to synchronously invoke the start action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/start

Example Response

HTTP/1.1 200 OK

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_4_start"
}],
"identity": [
"serverLifeCycleRuntimes",
"Cluster-0-Server-1",
"tasks",
"_4_start"
],
"running": false,
"systemTask": false,
"endTimeAsLong": 1439526469180,
"name": "_4_start",
"progress": "success",
"description": "Starting Cluster-0-Server-1 server ...",
"serverName": "Cluster-0-Server-1",
"taskError": null,
"startTimeAsLong": 1439526454241,
"type": "ServerLifeCycleTaskRuntime",
"operation": "start",
"taskStatus": "TASK COMPLETED",
"parentTask": null,
"completed": true,
"intervalToPoll": 1000,
"startTime": "2015-08-14T00:27:34.241-04",
"endTime": "2015-08-14T00:27:49.180-04"
}

Example 2   Asynchronously Invoke the start Action

This example uses the POST method to asynchronously invoke the start action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/start?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_16_start

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_16_start"
}],
"progress": "processing",
"serverName": "Cluster-0-Server-1",
"operation": "start",
"taskStatus": "TASK IN PROGRESS",
"completed": false
}

POST

Uses the Node Manager to start a Managed Server on the given machine

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

disableMsiMode:

if true, the server will not start in Managed Server Independence mode

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInAdmin

The resource supports the following methods:

- POST

POST

Uses the Node Manager to start a Managed Server and place it in the ADMIN state.

The server transitions through the following states:

SHUTDOWN>SUSPENDING>STANDBYADMIN

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInStandby

The resource supports the following methods:

- POST

POST

Uses the Node Manager to start a Managed Server and place it in the STANDBY state.

The server transitions through the following states:

SHUTDOWN>SUSPENDING>STANDBY

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/suspend

The resource supports the following methods:

- POST

POST

The resource supports the following methods:

- POST

- POST

POST

Gracefully suspends server to ADMIN state. New requests are rejected and inflight work is allowed to complete.

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

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the suspend Action

This example uses the POST method to synchronously invoke the suspend action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/suspend?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_5_suspendWithTimeout"
}],
"progress": "success",
"serverName": "Cluster-0-Server-1",
"operation": "suspendWithTimeout",
"taskStatus": "TASK COMPLETED",
"completed": true
}

Example 2   Asynchronously Invoke the suspend Action

This example uses the POST method to asynchronously invoke the suspend action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/suspend?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_17_suspendWithTimeout

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_17_suspendWithTimeout"
}],
"progress": "processing",
"serverName": "Cluster-0-Server-1",
"operation": "suspendWithTimeout",
"taskStatus": "TASK IN PROGRESS",
"completed": false
}

POST

Transitions the server from RUNNING to ADMIN state gracefully.

Applications are in admin mode. Inflight work is completed.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for server to transition gracefully. The server calls forceSuspend() after timeout.

Type: int

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the suspend Action

This example uses the POST method to synchronously invoke the suspend action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{ timeout: 10, ignoreSessions: true }" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/suspend?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_7_suspendWithTimeout"
}],
"progress": "success",
"serverName": "Cluster-0-Server-1",
"operation": "suspendWithTimeout",
"taskStatus": "TASK COMPLETED",
"completed": true
}

Example 2   Asynchronously Invoke the suspend Action

This example uses the POST method to asynchronously invoke the suspend action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{ timeout: 10, ignoreSessions: true }" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/suspend?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_19_suspendWithTimeout

Response Body:
{
"links": [{
"rel": "job",
"href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_19_suspendWithTimeout"
}],
"progress": "processing",
"serverName": "Cluster-0-Server-1",
"operation": "suspendWithTimeout",
"taskStatus": "TASK IN PROGRESS",
"completed": false
}

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks

This resource manages a collection of weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks rel=self
This resource.

Example

Example 1   View the weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean Collection

This example uses the GET method to display the weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean instances in this collection.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks?fields=completed,progress,serverName,operation&links=none

Example Response

HTTP/1.1 200 OK

Response Body:
{"items": [
{
"progress": "success",
"serverName": "Cluster-0-Server-1",
"operation": "start",
"completed": true
},
{
"progress": "success",
"serverName": "Cluster-0-Server-1",
"operation": "shutdown",
"completed": true
},
{
"progress": "success",
"serverName": "Cluster-0-Server-1",
"operation": "start",
"completed": true
}
]}

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}

This resource manages a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/serverRuntimes

Monitors all the running servers in the WebLogic Server domain from the administration server. From this resource, you can monitor each managed server.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.ServerRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ServerRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/serverRuntimes rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/serverRuntimes rel=self
This resource.

/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes

This resource manages a collection of weblogic.management.runtime.ServiceMigrationDataRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.ServiceMigrationDataRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.ServiceMigrationDataRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes rel=self
This resource.

/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes/{name}

This resource manages a weblogic.management.runtime.ServiceMigrationDataRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.ServiceMigrationDataRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ServiceMigrationDataRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes/{name} rel=self
This resource.

/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime

This resource manages a weblogic.management.runtime.SNMPAgentRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.SNMPAgentRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.SNMPAgentRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/invalidateLocalizedKeyCache rel=action title=invalidateLocalizedKeyCache
This resource's invalidateLocalizedKeyCache action resource.

- uri=/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/outputCustomMBeansMIBModule rel=action title=outputCustomMBeansMIBModule
This resource's outputCustomMBeansMIBModule action resource.

- uri=/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime rel=self
This resource.

/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/invalidateLocalizedKeyCache

The resource supports the following methods:

- POST

POST

Immediately invalidates the cached security keys for the specified WebLogic Server user.

An SNMP security key is an encrypted version of an SNMP agent's engine ID and an authentication password or privacy password. WebLogic Server generates one security key for each entry that you create in the SNMP credential map. When a WebLogic Server SNMP agent receives an SNMPv3 request, it compares the key that is in the request with its WebLogic Server keys. If it finds a match, it processes the request. The SNMP agent also encodes these keys in its responses and notifications. (You configure which keys are encoded when you create a trap destination.)

Instead of regenerating the keys for each SNMPv3 communication, WebLogic Server caches the keys. To make sure that the cache contains the latest set of SNMP credentials, WebLogic Server periodically invalidates the cache. After the cache is invalidated, the next time an SNMP agent requests credentials, WebLogic Server regenerates the cache.

Note that making a change to the credential map does not automatically update the cache. Instead, the cache is updated only after it has been invalidated.

Instead of waiting for WebLogic Server to invalidate the cached entry for a key, you can invalidate it immediately.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

username

Name of the user

Type: string

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/outputCustomMBeansMIBModule

The resource supports the following methods:

- POST

POST

Returns WebLogic Server's MIB module for custom MBeans as a java.lang.String. You can save the String to a file and then load the file into a MIB browser.

When you register custom MBeans in the WebLogic Server Runtime MBean Server, WebLogic Server adds entries to a runtime MIB module that it maintains for custom MBeans. For each custom MBean type, WebLogic Server adds a table to the MIB module. For each instance of the custom MBean, it adds a table row. While WebLogic Server does not persist the MIB module as a file or other data structure, the OIDs in the module remain constant across server sessions.

Roles

Admin

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/startPartitionWait

The resource supports the following methods:

- POST

POST

Starts the Partition with initialState and within timeOut msec. This is synchronous operation, where the function will not return untill the partition is started or an exception is thrown

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

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

partitionMBean

partitionMBean

Type: weblogic.management.configuration.PartitionMBean reference

initialState

can be ADMIN or RUNNING, Default is RUNNING

Type: string

timeOut

Specifies the number of milliseconds to start a Partition. Throws InterruptedException if Partition is unable to start during that duration and leaves the Partition in UNKNOWN state. Default is 60000ms

Type: int

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

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

This resource manages a collection of weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes rel=self
This resource.

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

This resource manages a weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/shutdown rel=action title=shutdown
This resource's shutdown action resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/softRestart rel=action title=softRestart
This resource's softRestart action resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/start rel=action title=start
This resource's start action resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks rel=tasks
This resource's tasks collection resource.

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

The resource supports the following methods:

- POST

POST

Uses Node Manager to shut down a system component.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

props

properties to use when shutting down this system component. These properties are used by the nodemanager plugin.

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean reference return field.

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

The resource supports the following methods:

- POST

POST

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. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

props

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

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean reference return field.

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

The resource supports the following methods:

- POST

POST

Uses Node Manager to start a system component.

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

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

props

properties to use when starting this system component. These properties are used by the nodemanager plugin.

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean reference return field.

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

This resource manages a collection of weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks rel=self
This resource.

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

This resource manages a weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

- GET

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} rel=parent
The parent resource of this resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=self
This resource.

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

- GET

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel rel=action title=cancel
This resource's cancel action resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name} rel=canonical
This resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks rel=parent
The parent resource of this resource.

- rel=parentTask
This resource's parentTask reference to a weblogic.management.runtime.TaskRuntimeMBean resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name} rel=self
This resource.

- uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/subTasks rel=subTasks
This resource's subTasks collection resource.

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

- POST

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

2 Entities

The following sections describe the data models on which the REST resources operate. These data models describe the information exchanged in REST resources.

java.lang.Throwable

This entity represents errors and exceptions.

The properties of the java.lang.Throwable entity are as follows:

cause

This property contains the stack trace of errors and exceptions.

Type: java.lang.Throwable

message

This property contains the reason why the error or exception was thrown.

Type: string

java.util.Date

This entity represents a date as a string in ISO 8601 format, yyyy-MM-ddTHH:mm:ss.SSSX

java.util.Properties

This entity represents a JSONObject with a property for each property in the properties object, where the key is the property's name the the value is a string containing the property's value.

weblogic.health.HealthState

This entity represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.

The properties of the weblogic.health.HealthState entity are as follows:

partitionName

This property indicates the partition name for which the health state is reported.

Type: string

state

This property indicates the reported state as:

- OK - Service is healthy.

- WARN - Service could have problems in the future

- CRITICAL - Something must be done now to prevent service failure

- FAILED - Service has failed and must be restarted

- OVERLOADED - Service is functioning normally but there is too much work in it

- UNKNOWN - Service state cannot be determined

Type: string

subsystemName

This property indicates the service for which the health state is reported.

Type: string

symptoms

This property idicates the cause ot the reported state.

Type: array of weblogic.health.Symptom

weblogic.health.Symptom

This entity represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.

The properties of the weblogic.health.Symptom entity are as follows:

info

This property provides additional information about the symptom if available.

Type: string

instanceId

This property represents an identifier for the symptom.

Type: string

severity

This property indicates a low, medium, or high severity level.

Type: string

type

This property represents the cause of the symptom (low memory, network error, stuck threads, and so on).

Type: string

weblogic.management.rest.bean.model.CurrentUser

The authenticated user that is making the request.

The properties of the weblogic.management.rest.bean.model.CurrentUser entity are as follows:

partitionId

The ID of the partition where the component that is being invoked resides.

Type: string

partitionName

The human readable name of the partition ID.

Type: string

user

The login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.

Type: string

weblogic.management.rest.bean.model.Version

A Version entity describes a version of the WebLogic Server resources.

The properties of the weblogic.management.rest.bean.model.Version entity are as follows:

isLatest

True if this is the default version.

Type: boolean

lifecycle

The lifecycle of this version: active or deprecated

Type: string

version

The name of this version.

Type: string

weblogic.management.runtime.AppDeploymentRuntimeMBean

This MBean provides deployment operations for an application. Currently only start and stop are supported. In the future, this MBean may be enhanced with operations to support deployment applications to the domain as well as extended WLS deployment features such as production redeployment and partial deployment of modules in an enterprise application.

The properties of the weblogic.management.runtime.AppDeploymentRuntimeMBean entity are as follows:

applicationName

The application's name.

Type: string

Constraints: Read Only, Restart Required

applicationVersion

The application's version identifier.

Type: string

Constraints: Read Only, Restart Required

modules

The list of modules for the application. These modules can be used in module level targeting.

Type: array of string

Constraints: Read Only, Restart Required

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

partitionName

The name of the partition the application is in.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.AppRuntimeStateRuntimeMBean

Provides access to runtime state for deployed applications.

The properties of the weblogic.management.runtime.AppRuntimeStateRuntimeMBean entity are as follows:

applicationIds

Type: array of string

Constraints: Read Only, Restart Required

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.BatchJobRepositoryRuntimeMBean

The properties of the weblogic.management.runtime.BatchJobRepositoryRuntimeMBean entity are as follows:

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.ConsoleRuntimeMBean

Runtime services for the console.

The properties of the weblogic.management.runtime.ConsoleRuntimeMBean entity are as follows:

enabled

Is the console enabled?

Type: boolean

Constraints: Read Only, Restart Required

homePageURL

Gets the URL for the console's home page

Type: string

Constraints: Read Only, Restart Required

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.DeploymentManagerMBean

This MBean provides deployment operations.

A DeploymentManager object is a stateless interface into the WebLogic Server deployment framework. It currently provides access to the AppDeploymentRuntimeMBeans that allow the user to start and stop deployments. In the future, this MBean may be enhanced with operations to support deployment applications to the domain, as well as extended WebLogic Server deployment features, such as production redeployment and partial deployment of modules in an enterprise application.

This MBean emits notifications when an application is created or removed and when the application state changes. The notification types are:

- appdeployment.created

- appdeployment.deleted

- appdeployment.state.new

- appdeployment.state.prepared

- appdeployment.state.admin

- appdeployment.state.active

- appdeployment.state.retired

- appdeployment.state.failed

- appdeployment.state.update.pending

- appdeployment.state.unknown

The userdata is the object name of the application.

The properties of the weblogic.management.runtime.DeploymentManagerMBean entity are as follows:

maximumDeploymentProgressObjectsCount

The maximum number of progress objects allowed.

Type: int

Constraints: Restart Required

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.DeploymentProgressObjectMBean

This MBean is the user API for monitoring deployment operations and exists only on an Administration Server. Currently only start and stop operations initiated by AppDeploymentRuntimeMBean are supported.

The properties of the weblogic.management.runtime.DeploymentProgressObjectMBean entity are as follows:

applicationName

The name of the application for the current deployment operation.

Type: string

Constraints: Read Only, Restart Required

completed

This property indicates whether an asynchronous job has completed.

Type: boolean

deploymentMessages

Provides an ordered array of status messages generated for the current deployment operation.

Type: array of string

Constraints: Read Only, Restart Required

endTime

This property indicates the time when the asynchronous job ended.

Type: java.util.Date

failedTargets

The targets on which the current deployment operation failed.

Type: array of string

Constraints: Read Only, Restart Required

id

The unique ID for the current deployment operation.

Type: string

Constraints: Read Only, Restart Required

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

operationType

The deployment operation type for the current deployment operation. Possible values are 1 (start) and 2 (stop).

Type: int

Constraints: Read Only, Restart Required

progress

This property indicates whether an asynchronous job has succeeded, failed, or is in progress.

Type: string

rootExceptions

If the current deployment operation has failed, this method may return zero or more exception(s) which represent the root cause of the failure. The array will not contain WLS exception classes; instead they will be new Exceptions containing the stack traces and messages from the original WLS Exceptions.

Type: array of java.lang.Throwable

Constraints: Read Only, Restart Required

startTime

This property indicates the time when an asynchronous job was started.

Type: java.util.Date

startTimeAsLong

The time that the current deployment operation began. The value is in milliseconds consistent with the system time.

Type: long

Constraints: Read Only, Restart Required

state

The state of the current deployment operation. Possible values are STATE_INITIALIZED, STATE_RUNNING, STATE_COMPLETED, STATE_FAILED and STATE_DEFERRED.

Type: string

Constraints: Read Only, Restart Required

targets

The targets specified for the current deployment operation.

Type: array of string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.DomainPartitionRuntimeMBean

This class is used for domain level partition handling.

The properties of the weblogic.management.runtime.DomainPartitionRuntimeMBean entity are as follows:

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

partitionID

Returns partition ID value for corresponding partition.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.DomainRuntimeMBean

This class is used for monitoring a WebLogic domain. A domain may contain zero or more clusters. A cluster may be looked up by a logical name.

The properties of the weblogic.management.runtime.DomainRuntimeMBean entity are as follows:

activationTime

The time when the domain became active.

Type: java.util.Date

Constraints: Read Only, Restart Required

currentDomainPartitionRuntime

Returns the domain partition runtime MBean for the "current" partition

Type: weblogic.management.runtime.DomainPartitionRuntimeMBean reference

Constraints: Read Only, Restart Required

name

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

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.EditSessionConfigurationManagerMBean

The properties of the weblogic.management.runtime.EditSessionConfigurationManagerMBean entity are as follows:

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.EditSessionConfigurationRuntimeMBean

The properties of the weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity are as follows:

creator

The original creator of the edit session.

Type: string

Constraints: Read Only, Restart Required

currentEditor

The current editor of the edit session. The editor owns the lock.

Type: string

Constraints: Read Only, Restart Required

description

The description of the edit session configuration.

Type: string

Constraints: Read Only, Restart Required

editSessionName

The name of the edit session configuration.

Type: string

Constraints: Read Only, Restart Required

editSessionServerJndi

The JNDI name of the related EditSessionServer

Type: string

Constraints: Read Only, Restart Required

mergeNeeded

Returns true if another edit session activates its changes after the last activation of this edit session or after its creation but before this edit session was ever activated.

It indicates that this edit session configuration is probably not the actual runtime configuration. Use the resolve method to merge changes to this configuration.

If this edit session configuration was also modified then there can be conflicts between this session and the runtime configuration. Use the resolve method to remove possible inconsistencies.

Type: boolean

Constraints: Read Only, Restart Required

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

partitionName

The partition name to which this edit session belongs.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.ElasticServiceManagerRuntimeMBean

The properties of the weblogic.management.runtime.ElasticServiceManagerRuntimeMBean entity are as follows:

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.LibDeploymentRuntimeMBean

This MBean provides deployment operations for a library..

The properties of the weblogic.management.runtime.LibDeploymentRuntimeMBean entity are as follows:

implementationVersion

The library's implementation version, null if none is set

Type: string

Constraints: Read Only, Restart Required

libraryIdentifier

The library's identifier.

Type: string

Constraints: Read Only, Restart Required

libraryName

The library's name.

Type: string

Constraints: Read Only, Restart Required

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

partitionName

The name of the partition the library is in.

Type: string

Constraints: Read Only, Restart Required

specificationVersion

The library's specification version, null if none is set

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.LogRuntimeMBean

This interface defines the control operations for a log in the WebLogic Server.

The properties of the weblogic.management.runtime.LogRuntimeMBean entity are as follows:

logFileStreamOpened

Gets the opened state of the log file stream represented by this instance.

Type: boolean

Constraints: Read Only, Restart Required

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.MessageDrivenControlEJBRuntimeMBean

This interface contains controls to suspend and resume the MDBs. This RuntimeMBean is deployed only on the AdminServer.

The properties of the weblogic.management.runtime.MessageDrivenControlEJBRuntimeMBean entity are as follows:

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.MigratableServiceCoordinatorRuntimeMBean

This class is used for monitoring the Migratable Service Coordinator.

The properties of the weblogic.management.runtime.MigratableServiceCoordinatorRuntimeMBean entity are as follows:

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.MigrationDataRuntimeMBean

Runtime information about one past or ongoing migration.

The properties of the weblogic.management.runtime.MigrationDataRuntimeMBean entity are as follows:

clusterMasterName

Name of the server that acted as the cluster master for this migration.

Type: string

Constraints: Read Only, Restart Required

clusterName

Name of the server that acted as the cluster master for this migration.

Type: string

Constraints: Read Only, Restart Required

machineMigratedFrom

Machine from which the server was migrated from

Type: string

Constraints: Read Only, Restart Required

machineMigratedTo

Machine to which the server was migrated to or is in the process of being migrated to.

Type: string

Constraints: Read Only, Restart Required

machinesAttempted

Get all the machines attempted for migration.

Type: array of string

Constraints: Read Only, Restart Required

migrationEndTime

End time of migration

Type: long

Constraints: Read Only, Restart Required

migrationStartTime

Start time of migration

Type: long

Constraints: Read Only, Restart Required

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

serverName

Name of the server migrated

Type: string

Constraints: Read Only, Restart Required

status

Name of the server migrated

Type: int

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.NodeManagerRuntimeMBean

Provides methods for retrieving runtime information about a server instance and for transitioning a server from one state to another.

The properties of the weblogic.management.runtime.NodeManagerRuntimeMBean entity are as follows:

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

reachable

Type: boolean

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.PartitionLifeCycleRuntimeMBean

The properties of the weblogic.management.runtime.PartitionLifeCycleRuntimeMBean entity are as follows:

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

state

The current state of the partition.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean

Exposes information about a long-running task related to the partition life cycle.

The properties of the weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean entity are as follows:

completed

This property indicates whether an asynchronous job has completed.

Type: boolean

description

A description of this task.

Type: string

Constraints: Read Only, Restart Required

endTime

This property indicates the time when the asynchronous job ended.

Type: java.util.Date

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

operation

Returns the name of the current operation.

Type: string

Constraints: Read Only, Restart Required

parentTask

The task of which this task is a part.

A value of null indicates that this task is not a subtask.

Type: weblogic.management.runtime.TaskRuntimeMBean reference

Constraints: Read Only, Restart Required

partitionName

Returns the name of the partition being operated on.

Type: string

Constraints: Read Only, Restart Required

progress

The progress of this task.

Type: string

Constraints: Read Only, Restart Required

running

Indicates whether the task is still running.

Type: boolean

Constraints: Read Only, Restart Required

startTime

This property indicates the time when an asynchronous job was started.

Type: java.util.Date

startTimeAsLong

The time at which this task was started.

Type: long

Constraints: Read Only, Restart Required

systemTask

Indicates whether this task was initiated by the server versus a user.

Type: boolean

Constraints: Read Only, Restart Required

taskError

Returns an exception describing the error, if any, that occurred while performing this task.

Type: java.lang.Throwable

Constraints: Read Only, Restart Required

taskStatus

The status of this task.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean

The properties of the weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean entity are as follows:

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

state

Current resource group state.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean

The properties of the weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean entity are as follows:

completed

This property indicates whether an asynchronous job has completed.

Type: boolean

description

A description of this task.

Type: string

Constraints: Read Only, Restart Required

endTime

This property indicates the time when the asynchronous job ended.

Type: java.util.Date

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

operation

Returns the name of the current operation.

Type: string

Constraints: Read Only, Restart Required

parentTask

The task of which this task is a part.

A value of null indicates that this task is not a subtask.

Type: weblogic.management.runtime.TaskRuntimeMBean reference

Constraints: Read Only, Restart Required

progress

The progress of this task.

Type: string

Constraints: Read Only, Restart Required

resourceGroupName

Returns the name of the resource group being operated on.

Type: string

Constraints: Read Only, Restart Required

running

Indicates whether the task is still running.

Type: boolean

Constraints: Read Only, Restart Required

startTime

This property indicates the time when an asynchronous job was started.

Type: java.util.Date

startTimeAsLong

The time at which this task was started.

Type: long

Constraints: Read Only, Restart Required

systemTask

Indicates whether this task was initiated by the server versus a user.

Type: boolean

Constraints: Read Only, Restart Required

taskError

Returns an exception describing the error, if any, that occurred while performing this task.

Type: java.lang.Throwable

Constraints: Read Only, Restart Required

taskStatus

The status of this task.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.RolloutServiceRuntimeMBean

The properties of the weblogic.management.runtime.RolloutServiceRuntimeMBean entity are as follows:

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.SNMPAgentRuntimeMBean

Runtime information for an SNMP agent that is running in the current WebLogic Server domain.

The properties of the weblogic.management.runtime.SNMPAgentRuntimeMBean entity are as follows:

SNMPAgentName

Gets the name of the SNMPAgent MBean configuration that is currently active. Returns null if no SNMPAgent configuration is currently active on this Server.

Type: string

Constraints: Read Only, Restart Required

UDPListenPort

The UDP port on which this SNMP agent is listening for incoming requests from SNMP managers.

SNMP agents can also communicate through the host server's TCP listen port (7001 by default) or through a TCP port that is configured by a custom network channel.

Type: int

Constraints: Read Only, Restart Required

attributeChangeTrapCount

The number of attribute change notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

Type: long

Constraints: Read Only, Restart Required

counterMonitorTrapCount

The number of counter monitor notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

Type: long

Constraints: Read Only, Restart Required

failedAuthenticationCount

The number of requests that this agent has rejected because of incorrect user credentials.

Type: int

Constraints: Read Only, Restart Required

failedAuthorizationCount

The number of requests that this agent has rejected because an authenticated user does not have sufficient privileges to view the requested information. You use the WebLogic Server security realm to assign privileges to users.

Type: int

Constraints: Read Only, Restart Required

failedEncryptionCount

The number of requests that this agent has rejected because of incorrect privacy (encryption) credentials

Type: int

Constraints: Read Only, Restart Required

gaugeMonitorTrapCount

The number of gauge monitor notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

Type: long

Constraints: Read Only, Restart Required

logMessageTrapCount

The number of log message notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

Type: long

Constraints: Read Only, Restart Required

masterAgentXPort

The port that this SNMP agent uses to communicate with subagents.

The agent uses subagents to provide access to custom MBeans (MBeans that you create and register) and to other Oracle software components. WebLogic Server SNMP agents do not enable users to register their own subagents.

Type: int

Constraints: Read Only, Restart Required

monitorTrapCount

The total number of all notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

Type: long

Constraints: Read Only, Restart Required

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

running

Indicates whether this SNMP agent is running.

Type: boolean

Constraints: Read Only, Restart Required

serverStartTrapCount

The number of serverStart notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

Type: long

Constraints: Read Only, Restart Required

serverStopTrapCount

The number of serverShutdown notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

Type: long

Constraints: Read Only, Restart Required

stringMonitorTrapCount

The number of string monitor notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

Type: long

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.ServerLifeCycleRuntimeMBean

Provides methods that transition servers from one state to another. This class is instantiated only on the Administration Server, but you can use it to transition the states of Managed Servers as well as Administration Servers.

You cannot use it to start an Administration Server, and if you want to use it to start Managed Servers, you must first set up a Node Manager on each Managed Server's host machine.

If you want to use the methods that transition a server into the ADMIN state, you must first set up an administration channel for that server.

The properties of the weblogic.management.runtime.ServerLifeCycleRuntimeMBean entity are as follows:

middlewareHome

The Oracle Middleware installation directory.

Type: string

Constraints: Read Only, Restart Required

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

nodeManagerRestartCount

Number of times the server has been restarted using the NodeManager since creation. The first start does not count. The count is valid only if the NodeManager is used to start and restart the server everytime.

Type: int

Constraints: Read Only, Restart Required

state

The current state of the server.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogicHome

The directory where the WebLogic Server instance (server) is installed, without the trailing "/server".

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean

Exposes monitoring information about a server's lifecycle. Remote clients as well as clients running within a server can access this information.

An operation (task) to change a server's state will fork a separate thread to perform the actual work and immediately return an instance of this MBean to the caller. The caller can then use this MBean to track the task's progress as desired.

The properties of the weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean entity are as follows:

completed

This property indicates whether an asynchronous job has completed.

Type: boolean

description

A description of this task.

Type: string

Constraints: Read Only, Restart Required

endTime

This property indicates the time when the asynchronous job ended.

Type: java.util.Date

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

operation

Gets the name of the method that was invoked on the ServerLifeCycleRuntime to initiate this task.

Type: string

Constraints: Read Only, Restart Required

parentTask

The task of which this task is a part.

A value of null indicates that this task is not a subtask.

Type: weblogic.management.runtime.TaskRuntimeMBean reference

Constraints: Read Only, Restart Required

progress

The progress of this task.

Type: string

Constraints: Read Only, Restart Required

running

Indicates whether the task is still running.

Type: boolean

Constraints: Read Only, Restart Required

serverName

The name of the server.

Type: string

Constraints: Read Only, Restart Required

startTime

This property indicates the time when an asynchronous job was started.

Type: java.util.Date

startTimeAsLong

The time at which this task was started.

Type: long

Constraints: Read Only, Restart Required

systemTask

Indicates whether this task was initiated by the server versus a user.

Type: boolean

Constraints: Read Only, Restart Required

taskError

Returns an exception describing the error, if any, that occurred while performing this task.

Type: java.lang.Throwable

Constraints: Read Only, Restart Required

taskStatus

The status of this task.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.ServerRuntimeMBean

Provides methods for retrieving runtime information about a server instance and for transitioning a server from one state to another.

The properties of the weblogic.management.runtime.ServerRuntimeMBean entity are as follows:

SSLListenPortEnabled

Indicates whether the default SSL listen port is enabled on the server

Type: boolean

Constraints: Read Only, Restart Required

activationTime

The time when the server was started.

Type: long

Constraints: Read Only, Restart Required

adminServer

Indicates whether the server is an Administration Server.

Type: boolean

Constraints: Read Only, Restart Required

adminServerHost

The address on which the Administration Server is listening for connections. For example, this might return the string: santiago

Type: string

Constraints: Read Only, Restart Required

adminServerListenPort

The port on which the Administration Server is listening for connections.

Type: int

Constraints: Read Only, Restart Required

adminServerListenPortSecure

Indicates whether the port that the server uses for administrative traffic is configured to use a secure protocol.

Type: boolean

Constraints: Read Only, Restart Required

administrationPortEnabled

Indicates whether the administration port is enabled on the server

Type: boolean

Constraints: Read Only, Restart Required

administrationURL

The URL that the server and its clients use for administrative connections.

If no administration channel is enabled, then this method returns the URL for connections through the default channel. If the default channel is de-activated, this method returns the URL for a secure channel. If no secure channel is enabled, the method returns null.

The returned URL will be consistent with dynamic channel updates.

Type: string

Constraints: Read Only, Restart Required

currentDirectory

The absolute path of the directory from which the server was started.

This may be used in conjunction with other relative paths in ServerMBean to compute full paths.

Type: string

Constraints: Read Only, Restart Required

currentMachine

Return the machine on which the server is running. This will be different from the configuration if the server gets migrated automatically.

Type: string

Constraints: Restart Required

defaultURL

The URL that clients use to connect to this server's default network channel.

The returned value indicates the default protocol, listen address and listen port:

protocol://listen-addresslisten-port

Note: The default protocol, listen address and listen port are persisted in the domain's config.xml file, however when a server instance is started, command-line options can override these persisted values. This getDefaultURL method returns the URL values that are currently being used, not necessarily the values that are specified in config.xml

The returned URL will be consistent with dynamic channel updates.

Type: string

Constraints: Read Only, Restart Required

healthState

The health state of the server as reported by the server's self-health monitoring.

For example, the server can report if it is overloaded by too many requests, if it needs more memory resources, or if it will soon fail for other reasons.

Type: weblogic.health.HealthState

Constraints: Read Only, Restart Required

listenPortEnabled

Indicates whether the default listen port is enabled on the server.

Type: boolean

Constraints: Read Only, Restart Required

middlewareHome

The Oracle Middleware installation directory.

Type: string

Constraints: Read Only, Restart Required

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

openSocketsCurrentCount

The current number of sockets registered for socket muxing on this server.

Type: int

Constraints: Read Only, Restart Required

overallHealthState

Determine the overall health state of this server, taking into account the health of each of its subsystems.

Type: weblogic.health.HealthState

Constraints: Read Only, Restart Required

restartRequired

Indicates whether the server must be restarted in order to activate configuration changes.

Type: boolean

Constraints: Read Only, Restart Required

serverClasspath

Get the classpath for this server including domain/lib contents that are automatically picked up and appended to the classpath.

Type: string

Constraints: Read Only, Restart Required

state

The current life cycle state of this server.

For example, a server can be in a RUNNING state in which it can receive and process requests or in an ADMIN state in which it can receive only administrative requests.

Type: string

Constraints: Read Only, Restart Required

stateVal

Returns current state of the server as in integer. weblogic.management.runtime.ServerStates has more information about the available server states

Type: int

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogicHome

The directory where the WebLogic Server instance (server) is installed, without the trailing "/server".

Type: string

Constraints: Read Only, Restart Required

weblogicVersion

The version of this WebLogic Server instance (server).

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.ServiceMigrationDataRuntimeMBean

Runtime information about one past or ongoing migration.

The properties of the weblogic.management.runtime.ServiceMigrationDataRuntimeMBean entity are as follows:

clusterName

Name of the cluster

Type: string

Constraints: Read Only, Restart Required

coordinatorName

Name of the server that acted as the coordinator for this migration.

Type: string

Constraints: Read Only, Restart Required

destinationsAttempted

Get all the destinations attempted for migration.

Type: array of string

Constraints: Read Only, Restart Required

migratedFrom

Where this object was migrated from

Type: string

Constraints: Read Only, Restart Required

migratedTo

Where this object was migrated to

Type: string

Constraints: Read Only, Restart Required

migrationEndTime

End time of migration

Type: long

Constraints: Read Only, Restart Required

migrationStartTime

Start time of migration

Type: long

Constraints: Read Only, Restart Required

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

serverName

Name of the object migrated

Type: string

Constraints: Read Only, Restart Required

status

Status of the migration (SUCCESSFUL, IN_PROGRESS, or FAILED)

Type: int

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean

Provides methods that transition system component from one state to another. This class is instantiated only on the Administration Server, but you can use it to transition the states of all managed system component servers.

To start system components, you must first configure a Node Manager on each component's host machine.

The properties of the weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean entity are as follows:

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

nodeManagerRestartCount

The number of times the server has been restarted using the Node Manager since its creation. The first start does not count. The count is valid only if the Node Manager is used to start and restart the server every time.

Type: int

Constraints: Read Only, Restart Required

state

The current state of the server.

Server states are described in "Managing Server Startup and Shutdown for Oracle WebLogic Server."

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean

Exposes monitoring information about a system component's life cycle.

An operation (task) to change a system component's state will fork a separate thread to perform the actual work and immediately return an instance of this MBean to the caller. The caller can then use this MBean to track the task's progress as desired.

The properties of the weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean entity are as follows:

completed

This property indicates whether an asynchronous job has completed.

Type: boolean

description

A description of this task.

Type: string

Constraints: Read Only, Restart Required

endTime

This property indicates the time when the asynchronous job ended.

Type: java.util.Date

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

operation

Gets the name of the method that was invoked on the ServerLifeCycleRuntime to initiate this task.

Type: string

Constraints: Read Only, Restart Required

parentTask

The task of which this task is a part.

A value of null indicates that this task is not a subtask.

Type: weblogic.management.runtime.TaskRuntimeMBean reference

Constraints: Read Only, Restart Required

progress

The progress of this task.

Type: string

Constraints: Read Only, Restart Required

running

Indicates whether the task is still running.

Type: boolean

Constraints: Read Only, Restart Required

serverName

The name of the server.

Type: string

Constraints: Read Only, Restart Required

startTime

This property indicates the time when an asynchronous job was started.

Type: java.util.Date

startTimeAsLong

The time at which this task was started.

Type: long

Constraints: Read Only, Restart Required

systemTask

Indicates whether this task was initiated by the server versus a user.

Type: boolean

Constraints: Read Only, Restart Required

taskError

Returns an exception describing the error, if any, that occurred while performing this task.

Type: java.lang.Throwable

Constraints: Read Only, Restart Required

taskStatus

The status of this task.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.TaskRuntimeMBean

Exposes monitoring information about an ongoing and potentially long-running administrative process. This should be taken to mean, at minimum, any OA&M operation involving I/O. Examples include starting and stopping servers, deploying and undeploying applications, or migrating services.

An MBean operation of this sort should fork a separate thread to perform the actual work and immediately return an instance of TaskRuntimeMBean to the caller. The caller can then use this to track the task's progress as desired. Users can also query for all instances of TaskRuntimeMBean to get a summary of both currently-running and recently-completed tasks.

Instance of TaskRuntimeMBean continue to exist in the MBeanServer after the completion of the work they describe. They will eventually either be explicitly deregistered by the user, or removed by a scavenger process which periodically purges instances of TaskRuntimeMBean that have been completed for some time.

The properties of the weblogic.management.runtime.TaskRuntimeMBean entity are as follows:

completed

This property indicates whether an asynchronous job has completed.

Type: boolean

description

A description of this task.

Type: string

Constraints: Read Only, Restart Required

endTime

This property indicates the time when the asynchronous job ended.

Type: java.util.Date

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

parentTask

The task of which this task is a part.

A value of null indicates that this task is not a subtask.

Type: weblogic.management.runtime.TaskRuntimeMBean reference

Constraints: Read Only, Restart Required

progress

The progress of this task.

Type: string

Constraints: Read Only, Restart Required

running

Indicates whether the task is still running.

Type: boolean

Constraints: Read Only, Restart Required

startTime

This property indicates the time when an asynchronous job was started.

Type: java.util.Date

startTimeAsLong

The time at which this task was started.

Type: long

Constraints: Read Only, Restart Required

systemTask

Indicates whether this task was initiated by the server versus a user.

Type: boolean

Constraints: Read Only, Restart Required

taskError

Returns an exception describing the error, if any, that occurred while performing this task.

Type: java.lang.Throwable

Constraints: Read Only, Restart Required

taskStatus

The status of this task.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.WorkflowTaskRuntimeMBean

TaskRuntimeMBean for any workflow (WorkflowProgress) executed using management orchestration framework.

The properties of the weblogic.management.runtime.WorkflowTaskRuntimeMBean entity are as follows:

completed

This property indicates whether an asynchronous job has completed.

Type: boolean

description

A description of this task.

Type: string

Constraints: Read Only, Restart Required

endTime

This property indicates the time when the asynchronous job ended.

Type: java.util.Date

errors

Lists all errors in the workflow.

Type: array of java.lang.Throwable

Constraints: Read Only, Restart Required

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

numCompletedCommands

Number of completed commands in the workflow. Together with {@code getNumTotalCommands()} defines kind of progress information.

Type: int

Constraints: Read Only, Restart Required

numTotalCommands

Number of all commands in the workflow. Together with {@code getNumCompletedCommands()} defines kind of progress information.

Type: int

Constraints: Read Only, Restart Required

parentTask

The task of which this task is a part.

A value of null indicates that this task is not a subtask.

Type: weblogic.management.runtime.TaskRuntimeMBean reference

Constraints: Read Only, Restart Required

progress

The progress of this task.

Type: string

Constraints: Read Only, Restart Required

progressString

Human-readable message containing information about the current workflow progress.

Type: string

Constraints: Read Only, Restart Required

running

Indicates whether the task is still running.

Type: boolean

Constraints: Read Only, Restart Required

startTime

This property indicates the time when an asynchronous job was started.

Type: java.util.Date

startTimeAsLong

The time at which this task was started.

Type: long

Constraints: Read Only, Restart Required

statusHistory

Provides step by step information (log) about the progress of the workflow.

Type: string

Constraints: Read Only, Restart Required

systemTask

Indicates whether this task was initiated by the server versus a user.

Type: boolean

Constraints: Read Only, Restart Required

taskError

Returns an exception describing the error, if any, that occurred while performing this task.

Type: java.lang.Throwable

Constraints: Read Only, Restart Required

taskStatus

The status of this task.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

workflowId

Each workflow has a unique id.

Type: string

Constraints: Read Only, Restart Required

workflowName

User defined name of this workflow.

Type: string

Constraints: Read Only, Restart Required

workflowTarget

Returns the target that was specified when the workflow was created. It will typically be either the name of the domain, of one or more clusters, or one or more servers.

Type: string

Constraints: Read Only, Restart Required

workflowType

Returns a string that can be used to identify the different types of workflows.

Type: string

Constraints: Read Only, Restart Required

weblogic.management.runtime.WseePolicySubjectManagerRuntimeMBean

The properties of the weblogic.management.runtime.WseePolicySubjectManagerRuntimeMBean entity are as follows:

name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Type: string

Constraints: Read Only, Restart Required

type

Returns the type of the MBean.

Type: string

Constraints: Read Only, Restart Required

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2015, Oracle and/or its affiliates. All rights reserved.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

License Restrictions Warranty/Consequential Damages Disclaimer

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

Hazardous Applications Notice

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Alpha and Beta Draft Documentation Notice

If this document is in preproduction status:

This documentation is in preproduction status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.