[1]oracle® fusion middleware restful domain …restful domain runtime reference for oracle weblogic...
TRANSCRIPT
![Page 1: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/1.jpg)
[1] Oracle® Fusion MiddlewareRESTful 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.
![Page 2: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/2.jpg)
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.
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.
The information contained in this document is for informational sharing purposes only and should be considered in your capacity as a customer advisory board member or pursuant to your beta trial agreement only. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described in this document remains at the sole discretion of Oracle.
This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to and use of this confidential material is subject to the terms and conditions of your Oracle Master Agreement, Oracle License and Services Agreement, Oracle PartnerNetwork Agreement, Oracle distribution agreement, or other license agreement which has been executed by you and Oracle and with which you agree to comply. This document and information contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent of Oracle. This document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.
![Page 3: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/3.jpg)
iii
Contents
Preface ............................................................................................................................................................... xxi
1 Resources
/management/weblogic............................................................................................................ 1-2
/management/weblogic/{version} ......................................................................................... 1-5
/management/weblogic/{version}/currentUser.................................................................. 1-9
/management/weblogic/{version}/domainRuntime....................................................... 1-12
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime ...... 1-16
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getCurrentState 1-19
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getIntendedState 1-22
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleIds 1-24
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleTargets 1-26
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleType 1-29
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeMillis 1-31
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeoutSeconds 1-33
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getSubmoduleIds 1-35
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isActiveVersion 1-37
![Page 4: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/4.jpg)
iv
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isAdminMode 1-39
/management/weblogic/{version}/domainRuntime/batchJobRepositoryRuntime... 1-41
/management/weblogic/{version}/domainRuntime/consoleRuntime........................ 1-43
/management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURL 1-45
/management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURLs 1-47
/management/weblogic/{version}/domainRuntime/consoleRuntime/getObjectNameContext 1-50
/management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURL 1-52
/management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURLs 1-54
/management/weblogic/{version}/domainRuntime/deploymentManager ............... 1-57
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes 1-60
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name} 1-62
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/getState 1-64
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/redeploy 1-66
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/start 1-69
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/stop 1-72
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/undeploy 1-75
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/update 1-78
/management/weblogic/{version}/domainRuntime/deploymentManager/confirmApplicationName 1-80
/management/weblogic/{version}/domainRuntime/deploymentManager/deploy. 1-83
![Page 5: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/5.jpg)
v
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects 1-87
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name} 1-90
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/cancel 1-92
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/getExceptions 1-94
/management/weblogic/{version}/domainRuntime/deploymentManager/distribute....... 1-96
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes 1-100
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name} 1-102
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/redeploy 1-104
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/undeploy 1-107
/management/weblogic/{version}/domainRuntime/deploymentManager/purgeCompletedDeploymentProgressObjects 1-110
/management/weblogic/{version}/domainRuntime/deploymentManager/redeploy ........ 1-112
/management/weblogic/{version}/domainRuntime/deploymentManager/undeploy....... 1-114
/management/weblogic/{version}/domainRuntime/deploymentManager/update ........... 1-117
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes .... 1-119
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}... 1-121
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime 1-123
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getCurrentState 1-126
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getIntendedState 1-129
![Page 6: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/6.jpg)
vi
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleIds 1-131
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleTargets 1-133
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleType 1-136
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeMillis 1-138
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeoutSeconds 1-140
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getSubmoduleIds 1-142
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isActiveVersion 1-144
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isAdminMode 1-146
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager 1-148
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes 1-151
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name} 1-153
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/getState 1-155
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/redeploy 1-157
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/start 1-160
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/stop 1-163
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/undeploy 1-166
![Page 7: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/7.jpg)
vii
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/update 1-169
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/confirmApplicationName 1-171
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploy 1-174
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects 1-178
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name} 1-180
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}/cancel 1-182
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}/getExceptions 1-184
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/distribute 1-186
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes 1-190
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name} 1-192
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}/redeploy 1-194
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}/undeploy 1-197
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/purgeCompletedDeploymentProgressObjects 1-200
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/redeploy 1-202
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/undeploy 1-204
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/update 1-207
![Page 8: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/8.jpg)
viii
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager 1-209
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations 1-211
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations/{name} 1-214
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges 1-217
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/forceDestroyEditSessionConfiguration 1-219
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime 1-221
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceShutdown 1-224
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceSuspend 1-227
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/getState 1-229
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/purgeTasks 1-231
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes 1-233
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name} 1-235
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/forceShutdown 1-238
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/forceSuspend 1-240
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/getState 1-242
![Page 9: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/9.jpg)
ix
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/purgeTasks 1-244
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/resume 1-246
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown 1-248
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/start 1-253
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin 1-255
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend 1-257
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks 1-261
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name} 1-263
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/cancel 1-265
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks 1-267
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} 1-269
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel 1-271
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks 1-273
![Page 10: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/10.jpg)
x
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name} 1-275
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel 1-277
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resume 1-279
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/shutdown 1-281
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/start 1-286
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/startInAdmin 1-289
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/suspend 1-291
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks 1-295
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name} 1-297
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/cancel 1-299
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks 1-301
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name} 1-303
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/cancel 1-305
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks 1-307
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks/{name} 1-309
![Page 11: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/11.jpg)
xi
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel 1-311
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager... 1-313
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations 1-315
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name} 1-318
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges 1-321
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/forceDestroyEditSessionConfiguration 1-323
/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime......... 1-325
/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/getScalingTasks 1-327
/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/purgeScalingTasks 1-329
/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleDown 1-331
/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleUp 1-333
/management/weblogic/{version}/domainRuntime/forceShutdownPartitionWait 1-335
/management/weblogic/{version}/domainRuntime/logRuntime.............................. 1-337
/management/weblogic/{version}/domainRuntime/logRuntime/ensureLogOpened ....... 1-339
/management/weblogic/{version}/domainRuntime/logRuntime/flushLog ........... 1-341
/management/weblogic/{version}/domainRuntime/logRuntime/forceLogRotation ......... 1-343
/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime . 1-345
/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/printMDBStatus 1-347
/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/resumeMDBs 1-349
![Page 12: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/12.jpg)
xii
/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/suspendMDBs 1-351
/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime 1-353
/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrate 1-355
/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateJTA 1-358
/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateSingleton 1-360
/management/weblogic/{version}/domainRuntime/migrationDataRuntimes........ 1-362
/management/weblogic/{version}/domainRuntime/migrationDataRuntimes/{name}...... 1-364
/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes......... 1-366
/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes/{name} ....... 1-368
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime......... 1-370
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/getPolicyRefStatus 1-372
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/isOWSMAttachable 1-374
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/removePolicyReference 1-376
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/setPolicyRefStatus 1-378
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes ... 1-380
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name} 1-382
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceShutdown 1-385
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceSuspend 1-387
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/getState 1-389
![Page 13: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/13.jpg)
xiii
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/purgeTasks 1-391
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/resume 1-393
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown 1-395
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/start 1-400
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin 1-402
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend 1-404
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks 1-408
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name} 1-410
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/cancel 1-412
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks 1-414
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} 1-416
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel 1-418
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks 1-420
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name} 1-422
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel 1-424
/management/weblogic/{version}/domainRuntime/restartSystemResource .......... 1-426
/management/weblogic/{version}/domainRuntime/rolloutService.......................... 1-428
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows 1-431
![Page 14: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/14.jpg)
xiv
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name} 1-433
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/cancel 1-435
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/canResume 1-437
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextExecuteStep 1-439
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextRevertStep 1-441
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks 1-443
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name} 1-445
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/cancel 1-447
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks 1-449
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name} 1-451
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel 1-453
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/waitFor 1-455
/management/weblogic/{version}/domainRuntime/rolloutService/deleteWorkflow........ 1-457
/management/weblogic/{version}/domainRuntime/rolloutService/execScript ..... 1-459
/management/weblogic/{version}/domainRuntime/rolloutService/executeWorkflow ..... 1-461
/management/weblogic/{version}/domainRuntime/rolloutService/getWorkflowTask..... 1-463
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows... 1-465
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name} 1-467
![Page 15: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/15.jpg)
xv
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/cancel 1-469
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/canResume 1-471
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextExecuteStep 1-473
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextRevertStep 1-475
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks 1-477
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name} 1-479
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/cancel 1-481
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks 1-483
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name} 1-485
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel 1-487
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/waitFor 1-489
/management/weblogic/{version}/domainRuntime/rolloutService/initializeRolloutOracleHome 1-491
/management/weblogic/{version}/domainRuntime/rolloutService/restartNodeManager 1-493
/management/weblogic/{version}/domainRuntime/rolloutService/revertWorkflow........ 1-495
/management/weblogic/{version}/domainRuntime/rolloutService/rollingRestart 1-497
/management/weblogic/{version}/domainRuntime/rolloutService/rolloutApplications.. 1-499
/management/weblogic/{version}/domainRuntime/rolloutService/rolloutJavaHome...... 1-501
/management/weblogic/{version}/domainRuntime/rolloutService/rolloutOracleHome.. 1-503
/management/weblogic/{version}/domainRuntime/rolloutService/rolloutUpdate ........... 1-505
![Page 16: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/16.jpg)
xvi
/management/weblogic/{version}/domainRuntime/rolloutService/shutdownServer ....... 1-507
/management/weblogic/{version}/domainRuntime/rolloutService/startServer .... 1-509
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows .. 1-511
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name} 1-513
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/cancel 1-515
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/canResume 1-517
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextExecuteStep 1-519
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextRevertStep 1-521
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks 1-523
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name} 1-525
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/cancel 1-527
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks 1-529
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name} 1-531
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel 1-533
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/waitFor 1-535
/management/weblogic/{version}/domainRuntime/search ....................................... 1-537
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes...... 1-539
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}.... 1-541
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceShutdown 1-544
![Page 17: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/17.jpg)
xvii
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceSuspend 1-547
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv4URL 1-550
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv6URL 1-552
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/resume 1-554
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown 1-557
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/start 1-564
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInAdmin 1-568
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInStandby 1-570
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/suspend 1-572
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks 1-577
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name} 1-580
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/cancel 1-582
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks 1-584
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} 1-586
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel 1-588
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks 1-590
![Page 18: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/18.jpg)
xviii
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name} 1-592
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel 1-594
/management/weblogic/{version}/domainRuntime/serverRuntimes....................... 1-596
/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes ........ 1-598
/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes/{name} 1-600
/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime............. 1-602
/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/invalidateLocalizedKeyCache 1-604
/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/outputCustomMBeansMIBModule 1-606
/management/weblogic/{version}/domainRuntime/startPartitionWait................... 1-608
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes 1-610
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name} 1-612
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/shutdown 1-614
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/softRestart 1-616
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/start 1-618
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks 1-620
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name} 1-622
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/cancel 1-624
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks 1-626
![Page 19: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/19.jpg)
xix
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} 1-628
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel 1-630
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks 1-632
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name} 1-634
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel 1-636
2 Entities
[3] java.lang.Throwable ................................................................................................................... 2-1[3] java.util.Date ................................................................................................................................ 2-1[3] java.util.Properties ...................................................................................................................... 2-1[3] weblogic.health.HealthState...................................................................................................... 2-1n weblogic.health.Symptom ......................................................................................................... 2-2n weblogic.management.rest.bean.model.CurrentUser ........................................................... 2-2n weblogic.management.rest.bean.model.Version ................................................................... 2-3n weblogic.management.runtime.AppDeploymentRuntimeMBean ..................................... 2-3n weblogic.management.runtime.AppRuntimeStateRuntimeMBean.................................... 2-4n weblogic.management.runtime.BatchJobRepositoryRuntimeMBean ................................ 2-4n weblogic.management.runtime.ConsoleRuntimeMBean ..................................................... 2-5n weblogic.management.runtime.DeploymentManagerMBean............................................. 2-5n weblogic.management.runtime.DeploymentProgressObjectMBean .................................. 2-6n weblogic.management.runtime.DomainPartitionRuntimeMBean...................................... 2-8n weblogic.management.runtime.DomainRuntimeMBean ..................................................... 2-9n weblogic.management.runtime.EditSessionConfigurationManagerMBean ..................... 2-9n weblogic.management.runtime.EditSessionConfigurationRuntimeMBean................... 2-10n weblogic.management.runtime.ElasticServiceManagerRuntimeMBean ........................ 2-11n weblogic.management.runtime.LibDeploymentRuntimeMBean .................................... 2-11n weblogic.management.runtime.LogRuntimeMBean.......................................................... 2-12n weblogic.management.runtime.MessageDrivenControlEJBRuntimeMBean ................. 2-12n weblogic.management.runtime.MigratableServiceCoordinatorRuntimeMBean........... 2-13n weblogic.management.runtime.MigrationDataRuntimeMBean ...................................... 2-13n weblogic.management.runtime.NodeManagerRuntimeMBean....................................... 2-15n weblogic.management.runtime.PartitionLifeCycleRuntimeMBean ................................ 2-15n weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean........................ 2-15n weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean.................... 2-17n weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean ........... 2-18n weblogic.management.runtime.RolloutServiceRuntimeMBean....................................... 2-19n weblogic.management.runtime.SNMPAgentRuntimeMBean.......................................... 2-20
![Page 20: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/20.jpg)
xx
n weblogic.management.runtime.ServerLifeCycleRuntimeMBean .................................... 2-22n weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean............................ 2-23n weblogic.management.runtime.ServerRuntimeMBean ..................................................... 2-25n weblogic.management.runtime.ServiceMigrationDataRuntimeMBean.......................... 2-28n weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean.............. 2-29n weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean ..... 2-30n weblogic.management.runtime.TaskRuntimeMBean ........................................................ 2-32n weblogic.management.runtime.WorkflowTaskRuntimeMBean ...................................... 2-34n weblogic.management.runtime.WseePolicySubjectManagerRuntimeMBean ............... 2-36
![Page 21: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/21.jpg)
xxi
Preface
This preface describes the document accessibility features and conventions used in this guide, RESTful Domain Runtime Reference for Oracle WebLogic Server.
Documentation AccessibilityFor 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 SupportOracle 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.
ConventionsThe 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.
![Page 22: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/22.jpg)
xxii
![Page 23: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/23.jpg)
1
Resources 1-1
1Resources
[2] 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.
![Page 24: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/24.jpg)
/management/weblogic
1-2 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 25: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/25.jpg)
/management/weblogic
Resources 1-3
GET
Get this collection of weblogic.management.rest.bean.model.Version instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
1Example
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": [
![Page 26: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/26.jpg)
GET
1-4 RESTful Domain Runtime Reference for Oracle WebLogic Server
{ "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" }]}
![Page 27: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/27.jpg)
/management/weblogic/{version}
Resources 1-5
/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
![Page 28: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/28.jpg)
GET
1-6 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.rest.bean.model.Version instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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
1Example
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" }, {
![Page 29: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/29.jpg)
/management/weblogic/{version}
Resources 1-7
"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": [
![Page 30: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/30.jpg)
GET
1-8 RESTful Domain Runtime Reference for Oracle WebLogic Server
{ "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"}
![Page 31: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/31.jpg)
/management/weblogic/{version}/currentUser
Resources 1-9
/management/weblogic/{version}/currentUser
This resource represents an authenticated user in the domain.
The resource supports the following methods:
■ GET
![Page 32: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/32.jpg)
GET
1-10 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.rest.bean.model.CurrentUser instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
1Example
Example 1 Viewing the weblogic.management.rest.bean.model.CurrentUser InstanceThis 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"
![Page 33: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/33.jpg)
/management/weblogic/{version}/currentUser
Resources 1-11
} ], "partitionId": "0", "partitionName": "DOMAIN", "user": "admin"}
![Page 34: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/34.jpg)
/management/weblogic/{version}/domainRuntime
1-12 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime
This resource is used to monitor the entire WebLogic Server domain.
The resource supports the following methods:
■ GET
![Page 35: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/35.jpg)
/management/weblogic/{version}/domainRuntime
Resources 1-13
GET
Get this weblogic.management.runtime.DomainRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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
![Page 36: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/36.jpg)
GET
1-14 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
![Page 37: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/37.jpg)
/management/weblogic/{version}/domainRuntime
Resources 1-15
■ 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.
1Example
Example 1 Viewing the weblogic.management.runtime.DomainRuntimeMBean InstanceThis 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"}
![Page 38: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/38.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime
1-16 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime
This resource manages a weblogic.management.runtime.AppRuntimeStateRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 39: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/39.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime
Resources 1-17
GET
Get this weblogic.management.runtime.AppRuntimeStateRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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
![Page 40: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/40.jpg)
GET
1-18 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
![Page 41: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/41.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getCurrentState
Resources 1-19
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getCurrentState
The resource supports the following methods:
■ POST
![Page 42: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/42.jpg)
POST
1-20 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
■ POST
POSTAggregate state for the application. This is defined as the most advanced state of the application's modules on the named target.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
targetlogical target where the app is deployed
Type: string
1Response BodyContains a JSON object with a string return field.
POSTAggregate state for the module. This is defined as the most advanced state of the module on all servers associated with the named target.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
moduleidmoduleid
Type: string
![Page 43: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/43.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getCurrentState
Resources 1-21
targetlogical target where module is deployed
Type: string
1Response BodyContains a JSON object with a string return field.
POSTAggregate state for a submodule. This is defined as the most advanced state of the submodule on all servers associated with the named target.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
moduleidmoduleid
Type: string
subModuleIdsubModuleId
Type: string
targetlogical target where module is deployed
Type: string
1Response BodyContains a JSON object with a string return field.
![Page 44: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/44.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getIntendedState
1-22 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getIntendedState
The resource supports the following methods:
■ POST
![Page 45: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/45.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getIntendedState
Resources 1-23
POST
The resource supports the following methods:
■ POST
■ POST
POSTThe state the application should be in.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
1Response BodyContains a JSON object with a string return field.
POSTThe state the application should be in on a specific target.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
targettarget
Type: string
1Response BodyContains a JSON object with a string return field.
![Page 46: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/46.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleIds
1-24 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleIds
The resource supports the following methods:
■ POST
![Page 47: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/47.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleIds
Resources 1-25
POST
Names of the modules contained in the application. This does not include submodules.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
1Response BodyContains a JSON object with a array of string return field.
![Page 48: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/48.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleTargets
1-26 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleTargets
The resource supports the following methods:
■ POST
![Page 49: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/49.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleTargets
Resources 1-27
POST
The resource supports the following methods:
■ POST
■ POST
POSTLogical targets where the submodule is deployed.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
moduleidmoduleid
Type: string
subModuleIdsubModuleId
Type: string
1Response BodyContains a JSON object with a array of string return field.
POSTLogical targets where the module is deployed.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
moduleidmoduleid
Type: string
![Page 50: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/50.jpg)
POST
1-28 RESTful Domain Runtime Reference for Oracle WebLogic Server
1Response BodyContains a JSON object with a array of string return field.
![Page 51: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/51.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleType
Resources 1-29
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleType
The resource supports the following methods:
■ POST
![Page 52: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/52.jpg)
POST
1-30 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Indicates the type of module: EAR, WAR, etc.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
moduleidmoduleid
Type: string
1Response BodyContains a JSON object with a string return field.
![Page 53: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/53.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeMillis
Resources 1-31
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeMillis
The resource supports the following methods:
■ POST
![Page 54: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/54.jpg)
POST
1-32 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The time when the application will be retired.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
1Response BodyContains a JSON object with a long return field.
![Page 55: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/55.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeoutSeconds
Resources 1-33
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeoutSeconds
The resource supports the following methods:
■ POST
![Page 56: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/56.jpg)
POST
1-34 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The amount of time the application is given to retire.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
1Response BodyContains a JSON object with a int return field.
![Page 57: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/57.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getSubmoduleIds
Resources 1-35
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getSubmoduleIds
The resource supports the following methods:
■ POST
![Page 58: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/58.jpg)
POST
1-36 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Submodules associated with this module.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
moduleidmoduleid
Type: string
1Response BodyContains a JSON object with a array of string return field.
![Page 59: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/59.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isActiveVersion
Resources 1-37
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isActiveVersion
The resource supports the following methods:
■ POST
![Page 60: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/60.jpg)
POST
1-38 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Indicates if the application is the active version, the one that new sessions will use.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidis the application id
Type: string
1Response BodyContains a JSON object with a boolean return field.
![Page 61: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/61.jpg)
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isAdminMode
Resources 1-39
/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isAdminMode
The resource supports the following methods:
■ POST
![Page 62: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/62.jpg)
POST
1-40 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Indicates if the application should only be available through the administration port. This is the desired state of the application.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidis the application id
Type: string
targettarget
Type: string
1Response BodyContains a JSON object with a boolean return field.
![Page 63: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/63.jpg)
/management/weblogic/{version}/domainRuntime/batchJobRepositoryRuntime
Resources 1-41
/management/weblogic/{version}/domainRuntime/batchJobRepositoryRuntime
This resource manages a weblogic.management.runtime.BatchJobRepositoryRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 64: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/64.jpg)
GET
1-42 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.BatchJobRepositoryRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 65: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/65.jpg)
/management/weblogic/{version}/domainRuntime/consoleRuntime
Resources 1-43
/management/weblogic/{version}/domainRuntime/consoleRuntime
This resource manages a weblogic.management.runtime.ConsoleRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 66: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/66.jpg)
GET
1-44 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.ConsoleRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 67: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/67.jpg)
/management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURL
Resources 1-45
/management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURL
The resource supports the following methods:
■ POST
![Page 68: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/68.jpg)
POST
1-46 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
contextIdentifies 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
perspectiveSpecifies 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
1Response BodyContains a JSON object with a string return field.
![Page 69: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/69.jpg)
/management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURLs
Resources 1-47
/management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURLs
The resource supports the following methods:
■ POST
![Page 70: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/70.jpg)
POST
1-48 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTGets 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).
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
contextsAn array of contexts identifying the object each page should display or manage.
Type: array of array of string
perspectivesAn array of perspectives identifying which kind of default page to return for each object.
Type: array of string
1Response BodyContains a JSON object with a array of string return field.
POSTGets 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).
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
contextsAn array of contexts identifying the object each page should display or manage.
Type: array of array of string
perspectiveSpecifies which kind of default page to return for all of the pages.
Type: string
![Page 71: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/71.jpg)
/management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURLs
Resources 1-49
1Response BodyContains a JSON object with a array of string return field.
![Page 72: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/72.jpg)
/management/weblogic/{version}/domainRuntime/consoleRuntime/getObjectNameContext
1-50 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/consoleRuntime/getObjectNameContext
The resource supports the following methods:
■ POST
![Page 73: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/73.jpg)
/management/weblogic/{version}/domainRuntime/consoleRuntime/getObjectNameContext
Resources 1-51
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
objectNamethe JMX object name of a WLS mbean
Type: string
1Response BodyContains a JSON object with a array of string return field.
![Page 74: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/74.jpg)
/management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURL
1-52 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURL
The resource supports the following methods:
■ POST
![Page 75: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/75.jpg)
/management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURL
Resources 1-53
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
pageThe portal page label of the desired console page.
Type: string
contextIdentifies 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
1Response BodyContains a JSON object with a string return field.
![Page 76: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/76.jpg)
/management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURLs
1-54 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURLs
The resource supports the following methods:
■ POST
![Page 77: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/77.jpg)
/management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURLs
Resources 1-55
POST
The resource supports the following methods:
■ POST
■ POST
POSTGets 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).
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
pageThe portal page label of the desired console pages.
Type: string
contextsAn array of contexts identifying the object each page should display or manage.
Type: array of array of string
1Response BodyContains a JSON object with a array of string return field.
POSTGets 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).
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
pagesAn array of portal page labels of the desired console pages.
Type: array of string
contextsAn array of contexts identifying the object each page should display or manage.
Type: array of array of string
![Page 78: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/78.jpg)
POST
1-56 RESTful Domain Runtime Reference for Oracle WebLogic Server
1Response BodyContains a JSON object with a array of string return field.
![Page 79: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/79.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager
Resources 1-57
/management/weblogic/{version}/domainRuntime/deploymentManager
This resource manages a weblogic.management.runtime.DeploymentManagerMBean instance.
The resource supports the following methods:
■ GET
![Page 80: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/80.jpg)
GET
1-58 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.DeploymentManagerMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 81: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/81.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager
Resources 1-59
■ 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.
![Page 82: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/82.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes
1-60 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes
This resource manages a collection of weblogic.management.runtime.AppDeploymentRuntimeMBean instances.
The resource supports the following methods:
■ GET
![Page 83: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/83.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes
Resources 1-61
GET
Get this collection of weblogic.management.runtime.AppDeploymentRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 84: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/84.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}
1-62 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}
This resource manages a weblogic.management.runtime.AppDeploymentRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 85: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/85.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}
Resources 1-63
GET
Get this weblogic.management.runtime.AppDeploymentRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 86: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/86.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/getState
1-64 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/getState
The resource supports the following methods:
■ POST
![Page 87: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/87.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/getState
Resources 1-65
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.
1RolesAdmin, Deployer, Operator
1Request BodyMust contain a JSON object with the following fields:
targetthe target for the application state
Type: string
1Response BodyContains a JSON object with a string return field.
![Page 88: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/88.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/redeploy
1-66 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/redeploy
The resource supports the following methods:
■ POST
![Page 89: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/89.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/redeploy
Resources 1-67
POST
The resource supports the following methods:
■ POST
■ POST
POSTRedeploy 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.
1RolesAdmin, Deployer, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsThe 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
planThe deployment plan for this application. May be null.
Type: string
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTRedeploy 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,
![Page 90: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/90.jpg)
POST
1-68 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin, Deployer, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 91: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/91.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/start
Resources 1-69
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/start
The resource supports the following methods:
■ POST
![Page 92: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/92.jpg)
POST
1-70 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTStart 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.
1RolesAdmin, Deployer, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsThe 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
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTStart 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
![Page 93: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/93.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/start
Resources 1-71
This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.
1RolesAdmin, Deployer, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 94: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/94.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/stop
1-72 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/stop
The resource supports the following methods:
■ POST
![Page 95: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/95.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/stop
Resources 1-73
POST
The resource supports the following methods:
■ POST
■ POST
POSTStop 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.
1RolesAdmin, Deployer, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsThe 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
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTStop 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
![Page 96: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/96.jpg)
POST
1-74 RESTful Domain Runtime Reference for Oracle WebLogic 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.
1RolesAdmin, Deployer, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 97: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/97.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/undeploy
Resources 1-75
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/undeploy
The resource supports the following methods:
■ POST
![Page 98: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/98.jpg)
POST
1-76 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTUndeploy 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.
1RolesAdmin, Deployer, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTUndeploy 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.
1RolesAdmin, Deployer, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsThe 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
![Page 99: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/99.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/undeploy
Resources 1-77
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 100: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/100.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/update
1-78 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/update
The resource supports the following methods:
■ POST
![Page 101: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/101.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/update
Resources 1-79
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.
1RolesAdmin, Deployer, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsrepresent the targets on which to update the application.
Type: array of string
planThe deployment plan containing the new deployment configuration information.
Type: string
deploymentOptionsAllows for overriding the deployment options. May be null.
Type: java.util.Properties
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 102: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/102.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/confirmApplicationName
1-80 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/confirmApplicationName
The resource supports the following methods:
■ POST
![Page 103: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/103.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/confirmApplicationName
Resources 1-81
POST
The resource supports the following methods:
■ POST
■ POST
POSTUsed by the deployment subsystem to confirm an application name.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
isRedeploymentshould be true in the case where this function is called for a redeployment.
Type: boolean
appSourceis a the path to the application.
Type: string
optionalalternate app descriptor.
Type: string
tentativeNameThe 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
tentativeApplicationIdThe 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
deploymentOptionsdeployment options
Type: java.util.Properties
1Response BodyContains a JSON object with a string return field.
POSTUsed by the deployment subsystem to confirm an application name.
![Page 104: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/104.jpg)
POST
1-82 RESTful Domain Runtime Reference for Oracle WebLogic Server
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
isRedeploymentshould be true in the case where this function is called for a redeployment.
Type: boolean
appSourceis a the path to the application.
Type: string
optionalalternate application descriptor path
Type: string
tentativeNameThe 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
tentativeApplicationIdThe 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
1Response BodyContains a JSON object with a string return field.
![Page 105: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/105.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/deploy
Resources 1-83
/management/weblogic/{version}/domainRuntime/deploymentManager/deploy
The resource supports the following methods:
■ POST
![Page 106: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/106.jpg)
POST
1-84 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTA 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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe name of the application
Type: string
applicationPathA supported Java EE application or module archive, or a root directory for the application or module.
Type: string
planThe deployment plan for this application. May be null.
![Page 107: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/107.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/deploy
Resources 1-85
Type: string
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTA 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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe name of the application
Type: string
applicationPathA supported Java EE application or module archive, or a root directory for the application or module.
Type: string
targetsThe 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
planThe deployment plan for this application. May be null.
Type: string
deploymentOptionsAllows 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
![Page 108: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/108.jpg)
POST
1-86 RESTful Domain Runtime Reference for Oracle WebLogic Server
false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)
Type: java.util.Properties
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 109: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/109.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects
Resources 1-87
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects
This resource manages a collection of weblogic.management.runtime.DeploymentProgressObjectMBean instances.
The resource supports the following methods:
■ GET
![Page 110: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/110.jpg)
GET
1-88 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.DeploymentProgressObjectMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
1Example
Example 1 View the weblogic.management.runtime.DeploymentProgressObjectMBean CollectionThis 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}]}
![Page 111: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/111.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects
Resources 1-89
![Page 112: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/112.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}
1-90 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}
This resource manages a weblogic.management.runtime.DeploymentProgressObjectMBean instance.
The resource supports the following methods:
■ GET
![Page 113: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/113.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}
Resources 1-91
GET
Get this weblogic.management.runtime.DeploymentProgressObjectMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 114: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/114.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/cancel
1-92 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/cancel
The resource supports the following methods:
■ POST
![Page 115: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/115.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/cancel
Resources 1-93
POST
Attempt to cancel the deployment operation. Any actions which have yet to start will be inhibited. Any completed actions will remain in place.
1RolesAdmin, Deployer
1Response BodyContains an empty JSON object.
![Page 116: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/116.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/getExceptions
1-94 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/getExceptions
The resource supports the following methods:
■ POST
![Page 117: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/117.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/getExceptions
Resources 1-95
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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
targetthe target where exceptions might have occurred.
Type: string
1Response BodyContains a JSON object with a array of java.lang.Throwable return field.
![Page 118: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/118.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/distribute
1-96 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/distribute
The resource supports the following methods:
■ POST
![Page 119: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/119.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/distribute
Resources 1-97
POST
The resource supports the following methods:
■ POST
■ POST
POSTDistribute 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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe name of the application
Type: string
applicationPathA supported Java EE application or module archive, or a root directory for the application or module.
Type: string
planThe deployment plan for this application. May be null.
Type: string
![Page 120: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/120.jpg)
POST
1-98 RESTful Domain Runtime Reference for Oracle WebLogic Server
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTDistribute 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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe name of the application
Type: string
applicationPathA supported Java EE application or module archive, or a root directory for the application or module.
Type: string
targetsThe 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
planThe deployment plan for this application. May be null.
Type: string
deploymentOptionsAllows 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
![Page 121: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/121.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/distribute
Resources 1-99
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 122: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/122.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes
1-100 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes
This resource manages a collection of weblogic.management.runtime.LibDeploymentRuntimeMBean instances.
The resource supports the following methods:
■ GET
![Page 123: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/123.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes
Resources 1-101
GET
Get this collection of weblogic.management.runtime.LibDeploymentRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 124: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/124.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}
1-102 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}
This resource manages a weblogic.management.runtime.LibDeploymentRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 125: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/125.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}
Resources 1-103
GET
Get this weblogic.management.runtime.LibDeploymentRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 126: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/126.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/redeploy
1-104 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/redeploy
The resource supports the following methods:
■ POST
![Page 127: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/127.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/redeploy
Resources 1-105
POST
The resource supports the following methods:
■ POST
■ POST
POSTRedeploy 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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
targetsThe 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
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTRedeploy 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.
1RolesAdmin, Deployer
![Page 128: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/128.jpg)
POST
1-106 RESTful Domain Runtime Reference for Oracle WebLogic Server
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 129: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/129.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/undeploy
Resources 1-107
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/undeploy
The resource supports the following methods:
■ POST
![Page 130: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/130.jpg)
POST
1-108 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTUndeploy 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.
1RolesAdmin, Deployer
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTUndeploy 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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
targetsThe 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
deploymentOptionsAllows 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
![Page 131: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/131.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/undeploy
Resources 1-109
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 132: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/132.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/purgeCompletedDeploymentProgressObjects
1-110 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/purgeCompletedDeploymentProgressObjects
The resource supports the following methods:
■ POST
![Page 133: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/133.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/purgeCompletedDeploymentProgressObjects
Resources 1-111
POST
Removes progress objects for completed operations.
1RolesAdmin, Deployer
1Response BodyContains an empty JSON object.
![Page 134: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/134.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/redeploy
1-112 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/redeploy
The resource supports the following methods:
■ POST
![Page 135: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/135.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/redeploy
Resources 1-113
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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe application name
Type: string
planThe deployment plan for this application. May be null.
Type: string
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 136: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/136.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/undeploy
1-114 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/deploymentManager/undeploy
The resource supports the following methods:
■ POST
![Page 137: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/137.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/undeploy
Resources 1-115
POST
The resource supports the following methods:
■ POST
■ POST
POSTUndeploy 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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe application name
Type: string
templateThe resource group template
Type: string
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTUndeploy 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.
![Page 138: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/138.jpg)
POST
1-116 RESTful Domain Runtime Reference for Oracle WebLogic Server
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe application name
Type: string
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 139: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/139.jpg)
/management/weblogic/{version}/domainRuntime/deploymentManager/update
Resources 1-117
/management/weblogic/{version}/domainRuntime/deploymentManager/update
The resource supports the following methods:
■ POST
![Page 140: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/140.jpg)
POST
1-118 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe application name
Type: string
planThe deployment plan for this application. May be null.
Type: string
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 141: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/141.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes
Resources 1-119
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes
This resource manages a collection of weblogic.management.runtime.DomainPartitionRuntimeMBean instances.
The resource supports the following methods:
■ GET
![Page 142: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/142.jpg)
GET
1-120 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.DomainPartitionRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 143: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/143.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}
Resources 1-121
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}
This resource manages a weblogic.management.runtime.DomainPartitionRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 144: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/144.jpg)
GET
1-122 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.DomainPartitionRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 145: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/145.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime
Resources 1-123
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime
This resource manages a weblogic.management.runtime.AppRuntimeStateRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 146: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/146.jpg)
GET
1-124 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.AppRuntimeStateRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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
![Page 147: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/147.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime
Resources 1-125
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.
![Page 148: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/148.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getCurrentState
1-126 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getCurrentState
The resource supports the following methods:
■ POST
![Page 149: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/149.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getCurrentState
Resources 1-127
POST
The resource supports the following methods:
■ POST
■ POST
■ POST
POSTAggregate state for the application. This is defined as the most advanced state of the application's modules on the named target.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
targetlogical target where the app is deployed
Type: string
1Response BodyContains a JSON object with a string return field.
POSTAggregate state for the module. This is defined as the most advanced state of the module on all servers associated with the named target.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
moduleidmoduleid
Type: string
![Page 150: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/150.jpg)
POST
1-128 RESTful Domain Runtime Reference for Oracle WebLogic Server
targetlogical target where module is deployed
Type: string
1Response BodyContains a JSON object with a string return field.
POSTAggregate state for a submodule. This is defined as the most advanced state of the submodule on all servers associated with the named target.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
moduleidmoduleid
Type: string
subModuleIdsubModuleId
Type: string
targetlogical target where module is deployed
Type: string
1Response BodyContains a JSON object with a string return field.
![Page 151: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/151.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getIntendedState
Resources 1-129
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getIntendedState
The resource supports the following methods:
■ POST
![Page 152: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/152.jpg)
POST
1-130 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTThe state the application should be in.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
1Response BodyContains a JSON object with a string return field.
POSTThe state the application should be in on a specific target.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
targettarget
Type: string
1Response BodyContains a JSON object with a string return field.
![Page 153: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/153.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleIds
Resources 1-131
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleIds
The resource supports the following methods:
■ POST
![Page 154: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/154.jpg)
POST
1-132 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Names of the modules contained in the application. This does not include submodules.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
1Response BodyContains a JSON object with a array of string return field.
![Page 155: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/155.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleTargets
Resources 1-133
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleTargets
The resource supports the following methods:
■ POST
![Page 156: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/156.jpg)
POST
1-134 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTLogical targets where the submodule is deployed.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
moduleidmoduleid
Type: string
subModuleIdsubModuleId
Type: string
1Response BodyContains a JSON object with a array of string return field.
POSTLogical targets where the module is deployed.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
moduleidmoduleid
Type: string
![Page 157: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/157.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleTargets
Resources 1-135
1Response BodyContains a JSON object with a array of string return field.
![Page 158: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/158.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleType
1-136 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleType
The resource supports the following methods:
■ POST
![Page 159: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/159.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleType
Resources 1-137
POST
Indicates the type of module: EAR, WAR, etc.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
moduleidmoduleid
Type: string
1Response BodyContains a JSON object with a string return field.
![Page 160: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/160.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeMi-
1-138 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeMillis
The resource supports the following methods:
■ POST
![Page 161: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/161.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeMi-
Resources 1-139
POST
The time when the application will be retired.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
1Response BodyContains a JSON object with a long return field.
![Page 162: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/162.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTime-
1-140 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeoutSeconds
The resource supports the following methods:
■ POST
![Page 163: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/163.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTime-
Resources 1-141
POST
The amount of time the application is given to retire.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
1Response BodyContains a JSON object with a int return field.
![Page 164: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/164.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getSubmoduleIds
1-142 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getSubmoduleIds
The resource supports the following methods:
■ POST
![Page 165: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/165.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getSubmoduleIds
Resources 1-143
POST
Submodules associated with this module.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidappid
Type: string
moduleidmoduleid
Type: string
1Response BodyContains a JSON object with a array of string return field.
![Page 166: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/166.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isActiveVersion
1-144 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isActiveVersion
The resource supports the following methods:
■ POST
![Page 167: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/167.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isActiveVersion
Resources 1-145
POST
Indicates if the application is the active version, the one that new sessions will use.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidis the application id
Type: string
1Response BodyContains a JSON object with a boolean return field.
![Page 168: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/168.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isAdminMode
1-146 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isAdminMode
The resource supports the following methods:
■ POST
![Page 169: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/169.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isAdminMode
Resources 1-147
POST
Indicates if the application should only be available through the administration port. This is the desired state of the application.
1RolesAdmin, Deployer, Monitor, Operator
1Request BodyMust contain a JSON object with the following fields:
appidis the application id
Type: string
targettarget
Type: string
1Response BodyContains a JSON object with a boolean return field.
![Page 170: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/170.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager
1-148 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager
This resource manages a weblogic.management.runtime.DeploymentManagerMBean instance.
The resource supports the following methods:
■ GET
![Page 171: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/171.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager
Resources 1-149
GET
Get this weblogic.management.runtime.DeploymentManagerMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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
![Page 172: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/172.jpg)
GET
1-150 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
![Page 173: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/173.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRun-
Resources 1-151
/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
![Page 174: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/174.jpg)
GET
1-152 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.AppDeploymentRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 175: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/175.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRun-
Resources 1-153
/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
![Page 176: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/176.jpg)
GET
1-154 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.AppDeploymentRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 177: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/177.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntim
Resources 1-155
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/getState
The resource supports the following methods:
■ POST
![Page 178: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/178.jpg)
POST
1-156 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin, Deployer, Operator
1Request BodyMust contain a JSON object with the following fields:
targetthe target for the application state
Type: string
1Response BodyContains a JSON object with a string return field.
![Page 179: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/179.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntim
Resources 1-157
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/redeploy
The resource supports the following methods:
■ POST
![Page 180: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/180.jpg)
POST
1-158 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTRedeploy 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.
1RolesAdmin, Deployer, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsThe 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
planThe deployment plan for this application. May be null.
Type: string
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTRedeploy 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,
![Page 181: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/181.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntim
Resources 1-159
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.
1RolesAdmin, Deployer, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 182: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/182.jpg)
1-160 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/start
The resource supports the following methods:
■ POST
![Page 183: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/183.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntim
Resources 1-161
POST
The resource supports the following methods:
■ POST
■ POST
POSTStart 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.
1RolesAdmin, Deployer, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsThe 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
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTStart 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
![Page 184: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/184.jpg)
POST
1-162 RESTful Domain Runtime Reference for Oracle WebLogic 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.
1RolesAdmin, Deployer, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 185: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/185.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRun-
Resources 1-163
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/stop
The resource supports the following methods:
■ POST
![Page 186: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/186.jpg)
POST
1-164 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTStop 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.
1RolesAdmin, Deployer, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsThe 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
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTStop 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
![Page 187: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/187.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRun-
Resources 1-165
This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.
1RolesAdmin, Deployer, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 188: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/188.jpg)
1-166 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/undeploy
The resource supports the following methods:
■ POST
![Page 189: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/189.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntim
Resources 1-167
POST
The resource supports the following methods:
■ POST
■ POST
POSTUndeploy 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.
1RolesAdmin, Deployer, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTUndeploy 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.
1RolesAdmin, Deployer, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsThe 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
![Page 190: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/190.jpg)
POST
1-168 RESTful Domain Runtime Reference for Oracle WebLogic Server
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 191: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/191.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntim
Resources 1-169
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/update
The resource supports the following methods:
■ POST
![Page 192: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/192.jpg)
POST
1-170 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin, Deployer, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsrepresent the targets on which to update the application.
Type: array of string
planThe deployment plan containing the new deployment configuration information.
Type: string
deploymentOptionsAllows for overriding the deployment options. May be null.
Type: java.util.Properties
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 193: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/193.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/confirmApplication-
Resources 1-171
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/confirmApplicationName
The resource supports the following methods:
■ POST
![Page 194: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/194.jpg)
POST
1-172 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTUsed by the deployment subsystem to confirm an application name.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
isRedeploymentshould be true in the case where this function is called for a redeployment.
Type: boolean
appSourceis a the path to the application.
Type: string
optionalalternate app descriptor.
Type: string
tentativeNameThe 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
tentativeApplicationIdThe 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
deploymentOptionsdeployment options
Type: java.util.Properties
1Response BodyContains a JSON object with a string return field.
POSTUsed by the deployment subsystem to confirm an application name.
![Page 195: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/195.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/confirmApplication-
Resources 1-173
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
isRedeploymentshould be true in the case where this function is called for a redeployment.
Type: boolean
appSourceis a the path to the application.
Type: string
optionalalternate application descriptor path
Type: string
tentativeNameThe 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
tentativeApplicationIdThe 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
1Response BodyContains a JSON object with a string return field.
![Page 196: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/196.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploy
1-174 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploy
The resource supports the following methods:
■ POST
![Page 197: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/197.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploy
Resources 1-175
POST
The resource supports the following methods:
■ POST
■ POST
POSTA 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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe name of the application
Type: string
applicationPathA supported Java EE application or module archive, or a root directory for the application or module.
Type: string
planThe deployment plan for this application. May be null.
![Page 198: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/198.jpg)
POST
1-176 RESTful Domain Runtime Reference for Oracle WebLogic Server
Type: string
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTA 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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe name of the application
Type: string
applicationPathA supported Java EE application or module archive, or a root directory for the application or module.
Type: string
targetsThe 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
planThe deployment plan for this application. May be null.
Type: string
deploymentOptionsAllows 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
![Page 199: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/199.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploy
Resources 1-177
false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)
Type: java.util.Properties
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 200: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/200.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgres-
1-178 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 201: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/201.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgres-
Resources 1-179
GET
Get this collection of weblogic.management.runtime.DeploymentProgressObjectMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 202: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/202.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgres-
1-180 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 203: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/203.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgres-
Resources 1-181
GET
Get this weblogic.management.runtime.DeploymentProgressObjectMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 204: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/204.jpg)
1-182 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}/cancel
The resource supports the following methods:
■ POST
![Page 205: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/205.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressO
Resources 1-183
POST
Attempt to cancel the deployment operation. Any actions which have yet to start will be inhibited. Any completed actions will remain in place.
1RolesAdmin, Deployer
1Response BodyContains an empty JSON object.
![Page 206: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/206.jpg)
1-184 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}/getExceptions
The resource supports the following methods:
■ POST
![Page 207: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/207.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressO
Resources 1-185
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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
targetthe target where exceptions might have occurred.
Type: string
1Response BodyContains a JSON object with a array of java.lang.Throwable return field.
![Page 208: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/208.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/distribute
1-186 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/distribute
The resource supports the following methods:
■ POST
![Page 209: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/209.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/distribute
Resources 1-187
POST
The resource supports the following methods:
■ POST
■ POST
POSTDistribute 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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe name of the application
Type: string
applicationPathA supported Java EE application or module archive, or a root directory for the application or module.
Type: string
planThe deployment plan for this application. May be null.
Type: string
![Page 210: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/210.jpg)
POST
1-188 RESTful Domain Runtime Reference for Oracle WebLogic Server
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTDistribute 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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe name of the application
Type: string
applicationPathA supported Java EE application or module archive, or a root directory for the application or module.
Type: string
targetsThe 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
planThe deployment plan for this application. May be null.
Type: string
deploymentOptionsAllows 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
![Page 211: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/211.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/distribute
Resources 1-189
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 212: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/212.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRun-
1-190 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 213: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/213.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRun-
Resources 1-191
GET
Get this collection of weblogic.management.runtime.LibDeploymentRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 214: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/214.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRun-
1-192 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 215: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/215.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRun-
Resources 1-193
GET
Get this weblogic.management.runtime.LibDeploymentRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 216: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/216.jpg)
1-194 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}/redeploy
The resource supports the following methods:
■ POST
![Page 217: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/217.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntime
Resources 1-195
POST
The resource supports the following methods:
■ POST
■ POST
POSTRedeploy 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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
targetsThe 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
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTRedeploy 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.
1RolesAdmin, Deployer
![Page 218: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/218.jpg)
POST
1-196 RESTful Domain Runtime Reference for Oracle WebLogic Server
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 219: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/219.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntime
Resources 1-197
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}/undeploy
The resource supports the following methods:
■ POST
![Page 220: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/220.jpg)
POST
1-198 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTUndeploy 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.
1RolesAdmin, Deployer
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTUndeploy 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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
targetsThe 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
deploymentOptionsAllows 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
![Page 221: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/221.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntime
Resources 1-199
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 222: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/222.jpg)
1-200 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/purgeCompletedDeploymentProgressObjects
The resource supports the following methods:
■ POST
![Page 223: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/223.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/purgeCompletedDeplo
Resources 1-201
POST
Removes progress objects for completed operations.
1RolesAdmin, Deployer
1Response BodyContains an empty JSON object.
![Page 224: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/224.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/redeploy
1-202 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/redeploy
The resource supports the following methods:
■ POST
![Page 225: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/225.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/redeploy
Resources 1-203
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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe application name
Type: string
planThe deployment plan for this application. May be null.
Type: string
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 226: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/226.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/undeploy
1-204 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/undeploy
The resource supports the following methods:
■ POST
![Page 227: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/227.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/undeploy
Resources 1-205
POST
The resource supports the following methods:
■ POST
■ POST
POSTUndeploy 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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe application name
Type: string
templateThe resource group template
Type: string
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
POSTUndeploy 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.
![Page 228: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/228.jpg)
POST
1-206 RESTful Domain Runtime Reference for Oracle WebLogic Server
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe application name
Type: string
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 229: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/229.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/update
Resources 1-207
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/update
The resource supports the following methods:
■ POST
![Page 230: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/230.jpg)
POST
1-208 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
nameThe application name
Type: string
planThe deployment plan for this application. May be null.
Type: string
deploymentOptionsAllows 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
1Response BodyContains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.
![Page 231: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/231.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager
Resources 1-209
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager
This resource manages a weblogic.management.runtime.EditSessionConfigurationManagerMBean instance.
The resource supports the following methods:
■ GET
![Page 232: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/232.jpg)
GET
1-210 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.EditSessionConfigurationManagerMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 233: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/233.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessi
Resources 1-211
/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
![Page 234: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/234.jpg)
GET
1-212 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 235: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/235.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessi
Resources 1-213
POST
Add a new weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance to this collection.
1RolesAdmin, Deployer
1Request BodyMust contain a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity.
![Page 236: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/236.jpg)
1-214 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 237: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/237.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessi
Resources 1-215
DELETE
Delete this weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.
1RolesAdmin, Deployer
![Page 238: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/238.jpg)
GET
1-216 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 239: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/239.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessi
Resources 1-217
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges
The resource supports the following methods:
■ POST
![Page 240: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/240.jpg)
POST
1-218 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin, Deployer
1Response BodyContains a JSON object with a boolean return field.
![Page 241: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/241.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/forceDest
Resources 1-219
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/forceDestroyEditSessionConfiguration
The resource supports the following methods:
■ POST
![Page 242: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/242.jpg)
POST
1-220 RESTful Domain Runtime Reference for Oracle WebLogic Server
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).
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
editSessionEdit session to destroy.
Type: weblogic.management.runtime.EditSessionConfigurationRuntimeMBean reference
1Response BodyContains an empty JSON object.
![Page 243: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/243.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime
Resources 1-221
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime
This resource manages a weblogic.management.runtime.PartitionLifeCycleRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 244: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/244.jpg)
GET
1-222 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.PartitionLifeCycleRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 245: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/245.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime
Resources 1-223
■ 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.
![Page 246: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/246.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceShutdown
1-224 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceShutdown
The resource supports the following methods:
■ POST
![Page 247: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/247.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceShutdown
Resources 1-225
POST
The resource supports the following methods:
■ POST
■ POST
■ POST
POSTThis method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeouttimeout
Type: int
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
POSTForces 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
POSTForces 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.
![Page 248: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/248.jpg)
POST
1-226 RESTful Domain Runtime Reference for Oracle WebLogic Server
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this partition
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
![Page 249: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/249.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceSuspend
Resources 1-227
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceSuspend
The resource supports the following methods:
■ POST
![Page 250: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/250.jpg)
POST
1-228 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTForcefully 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
POSTForcefully 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this partition
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
![Page 251: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/251.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/getState
Resources 1-229
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/getState
The resource supports the following methods:
■ POST
![Page 252: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/252.jpg)
POST
1-230 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Get the state of partition on a specific server.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
serverMBeanserverMBean
Type: weblogic.management.configuration.ServerMBean reference
1Response BodyContains a JSON object with a string return field.
![Page 253: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/253.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/purgeTasks
Resources 1-231
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/purgeTasks
The resource supports the following methods:
■ POST
![Page 254: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/254.jpg)
POST
1-232 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Clears the retained task collection.
1RolesAdmin, Operator
1Response BodyContains an empty JSON object.
![Page 255: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/255.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-233
/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
![Page 256: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/256.jpg)
GET
1-234 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 257: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/257.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-235
/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
![Page 258: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/258.jpg)
GET
1-236 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 259: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/259.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-237
■ 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.
![Page 260: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/260.jpg)
1-238 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/forceShutdown
The resource supports the following methods:
■ POST
![Page 261: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/261.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-239
POST
The resource supports the following methods:
■ POST
■ POST
POSTForces 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTForces 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 262: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/262.jpg)
1-240 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/forceSuspend
The resource supports the following methods:
■ POST
![Page 263: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/263.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-241
POST
The resource supports the following methods:
■ POST
■ POST
POSTForcefully 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTForcefully 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 264: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/264.jpg)
1-242 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/getState
The resource supports the following methods:
■ POST
![Page 265: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/265.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-243
POST
Get the state of resource group on a specific server.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
serverMBeanserverMBean
Type: weblogic.management.configuration.ServerMBean reference
1Response BodyContains a JSON object with a string return field.
![Page 266: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/266.jpg)
1-244 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/purgeTasks
The resource supports the following methods:
■ POST
![Page 267: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/267.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-245
POST
Clears the retained task collection.
1RolesAdmin, Operator
1Response BodyContains an empty JSON object.
![Page 268: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/268.jpg)
1-246 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/resume
The resource supports the following methods:
■ POST
![Page 269: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/269.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-247
POST
The resource supports the following methods:
■ POST
■ POST
POSTTransitions 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTTransitions 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 270: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/270.jpg)
1-248 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown
The resource supports the following methods:
■ POST
![Page 271: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/271.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-249
POST
The resource supports the following methods:
■ POST
■ POST
■ POST
■ POST
■ POST
■ POST
POSTShuts 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTShuts 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 272: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/272.jpg)
POST
1-250 RESTful Domain Runtime Reference for Oracle WebLogic Server
POSTGracefully 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeoutNumber of seconds to wait before aborting inflight work and force shutting down the server.
Type: int
ignoreSessionsSet to true to ignore pending HTTP sessions during inflight work handling.
Type: boolean
waitForAllSessionsSet to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.
Type: boolean
targetsthe specific targets on which to shut down this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTGracefully 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
![Page 273: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/273.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-251
timeoutNumber of seconds to wait before aborting inflight work and force shutting down the server.
Type: int
ignoreSessionsSet to true to ignore pending HTTP sessions during inflight work handling.
Type: boolean
waitForAllSessionsSet to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.
Type: boolean
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTShuts 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeoutNumber of seconds to wait before aborting inflight work and shutting down the server.
Type: int
ignoreSessionstrue indicates ignore pending HTTP sessions during inflight work handling.
Type: boolean
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTShuts down a resource group gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).
![Page 274: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/274.jpg)
POST
1-252 RESTful Domain Runtime Reference for Oracle WebLogic 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeoutNumber of seconds to wait before aborting inflight work and shutting down the server.
Type: int
ignoreSessionstrue indicates ignore pending HTTP sessions during inflight work handling.
Type: boolean
targetsthe specific targets on which to shut down this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 275: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/275.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-253
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/start
The resource supports the following methods:
■ POST
![Page 276: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/276.jpg)
POST
1-254 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTStarts 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTStarts 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 277: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/277.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-255
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin
The resource supports the following methods:
■ POST
![Page 278: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/278.jpg)
POST
1-256 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTStarts 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this resource group in "admin" state
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTStarts 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 279: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/279.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-257
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend
The resource supports the following methods:
■ POST
![Page 280: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/280.jpg)
POST
1-258 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
■ POST
■ POST
POSTTransitions 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeoutSeconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.
Type: int
ignoreSessionsdrop inflight HTTP sessions during graceful suspend
Type: boolean
targetsthe specific targets on which to start this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTGracefully suspends the resource group to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.
![Page 281: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/281.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-259
This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTGracefully 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTTransitions 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.
1RolesAdmin, Operator
![Page 282: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/282.jpg)
POST
1-260 RESTful Domain Runtime Reference for Oracle WebLogic Server
1Request BodyMust contain a JSON object with the following fields:
timeoutSeconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.
Type: int
ignoreSessionsdrop inflight HTTP sessions during graceful suspend
Type: boolean
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 283: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/283.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-261
/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
![Page 284: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/284.jpg)
GET
1-262 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 285: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/285.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-263
/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
![Page 286: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/286.jpg)
GET
1-264 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 287: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/287.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-265
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 288: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/288.jpg)
POST
1-266 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin, Operator
1Response BodyContains an empty JSON object.
![Page 289: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/289.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-267
/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
![Page 290: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/290.jpg)
GET
1-268 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 291: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/291.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-269
/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
![Page 292: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/292.jpg)
GET
1-270 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 293: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/293.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-271
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 294: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/294.jpg)
POST
1-272 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 295: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/295.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-273
/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
![Page 296: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/296.jpg)
GET
1-274 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 297: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/297.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-275
/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
![Page 298: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/298.jpg)
GET
1-276 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 299: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/299.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLif
Resources 1-277
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 300: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/300.jpg)
POST
1-278 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 301: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/301.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resume
Resources 1-279
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resume
The resource supports the following methods:
■ POST
![Page 302: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/302.jpg)
POST
1-280 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTTransitions 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
POSTTransitions 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this partition
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
![Page 303: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/303.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/shutdown
Resources 1-281
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/shutdown
The resource supports the following methods:
■ POST
![Page 304: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/304.jpg)
POST
1-282 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
■ POST
■ POST
■ POST
■ POST
POSTShuts 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this partition
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
POSTGracefully 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
![Page 305: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/305.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/shutdown
Resources 1-283
timeoutNumber of seconds to wait before aborting inflight work and force shutting down the server.
Type: int
ignoreSessionsSet to true to ignore pending HTTP sessions during inflight work handling.
Type: boolean
waitForAllSessionsSet to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.
Type: boolean
targetsthe specific targets on which to shut down this partition
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
POSTGracefully 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeoutNumber of seconds to wait before aborting inflight work and force shutting down the server.
Type: int
ignoreSessionsSet to true to ignore pending HTTP sessions during inflight work handling.
Type: boolean
waitForAllSessionsSet to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.
Type: boolean
![Page 306: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/306.jpg)
POST
1-284 RESTful Domain Runtime Reference for Oracle WebLogic Server
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
POSTShuts 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeoutNumber of seconds to wait before aborting inflight work and shutting down the server.
Type: int
ignoreSessionstrue indicates ignore pending HTTP sessions during inflight work handling.
Type: boolean
targetsthe specific targets on which to shut down this partition
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
POSTShuts 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.
1RolesAdmin, Operator
![Page 307: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/307.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/shutdown
Resources 1-285
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
POSTShuts 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeoutNumber of seconds to wait before aborting inflight work and shutting down the server.
Type: int
ignoreSessionstrue indicates ignore pending HTTP sessions during inflight work handling.
Type: boolean
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
![Page 308: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/308.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/start
1-286 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/start
The resource supports the following methods:
■ POST
![Page 309: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/309.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/start
Resources 1-287
POST
The resource supports the following methods:
■ POST
■ POST
■ POST
POSTStarts 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
POSTStarts 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
initialStatecan be can be ADMIN or RUNNING, Default is RUNNING
Type: string
timeOutSpecifies 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
![Page 310: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/310.jpg)
POST
1-288 RESTful Domain Runtime Reference for Oracle WebLogic Server
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
POSTStarts 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this partition
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
![Page 311: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/311.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/startInAdmin
Resources 1-289
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/startInAdmin
The resource supports the following methods:
■ POST
![Page 312: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/312.jpg)
POST
1-290 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTStarts 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
POSTStarts 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this partition in "admin" state
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
![Page 313: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/313.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/suspend
Resources 1-291
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/suspend
The resource supports the following methods:
■ POST
![Page 314: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/314.jpg)
POST
1-292 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
■ POST
■ POST
POSTTransitions 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeoutSeconds to wait for the partition to transition gracefully. The partition automatically calls forceSuspend() after timeout.
Type: int
ignoreSessionsdrop inflight HTTP sessions during graceful suspend
Type: boolean
targetsthe specific targets on which to start this partition
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
POSTGracefully 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.
![Page 315: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/315.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/suspend
Resources 1-293
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
POSTTransitions 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeoutSeconds to wait for the partition to transition gracefully. The partition automatically calls forceSuspend() after timeout.
Type: int
ignoreSessionsdrop inflight HTTP sessions during graceful suspend
Type: boolean
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
POSTGracefully 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.
1RolesAdmin, Operator
![Page 316: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/316.jpg)
POST
1-294 RESTful Domain Runtime Reference for Oracle WebLogic Server
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this partition
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
![Page 317: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/317.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks
Resources 1-295
/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
![Page 318: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/318.jpg)
GET
1-296 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 319: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/319.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}
Resources 1-297
/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
![Page 320: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/320.jpg)
GET
1-298 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 321: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/321.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRun-
Resources 1-299
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 322: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/322.jpg)
POST
1-300 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin, Operator
1Response BodyContains an empty JSON object.
![Page 323: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/323.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRun-
Resources 1-301
/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
![Page 324: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/324.jpg)
GET
1-302 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 325: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/325.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/sub
Resources 1-303
/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
![Page 326: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/326.jpg)
GET
1-304 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 327: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/327.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/sub
Resources 1-305
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 328: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/328.jpg)
POST
1-306 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 329: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/329.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/sub
Resources 1-307
/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
![Page 330: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/330.jpg)
GET
1-308 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 331: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/331.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/sub
Resources 1-309
/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
![Page 332: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/332.jpg)
GET
1-310 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 333: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/333.jpg)
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/sub
Resources 1-311
/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 334: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/334.jpg)
POST
1-312 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 335: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/335.jpg)
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager
Resources 1-313
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager
This resource manages a weblogic.management.runtime.EditSessionConfigurationManagerMBean instance.
The resource supports the following methods:
■ GET
![Page 336: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/336.jpg)
GET
1-314 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.EditSessionConfigurationManagerMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 337: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/337.jpg)
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations
Resources 1-315
/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
![Page 338: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/338.jpg)
GET
1-316 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 339: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/339.jpg)
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations
Resources 1-317
POST
Add a new weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance to this collection.
1RolesAdmin, Deployer
1Request BodyMust contain a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity.
![Page 340: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/340.jpg)
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}
1-318 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}
This resource manages a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.
The resource supports the following methods:
■ DELETE
■ GET
![Page 341: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/341.jpg)
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}
Resources 1-319
DELETE
Delete this weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.
1RolesAdmin, Deployer
![Page 342: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/342.jpg)
GET
1-320 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 343: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/343.jpg)
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}/contains
Resources 1-321
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges
The resource supports the following methods:
■ POST
![Page 344: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/344.jpg)
POST
1-322 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin, Deployer
1Response BodyContains a JSON object with a boolean return field.
![Page 345: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/345.jpg)
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/forceDestroyEditSessionConfiguration
Resources 1-323
/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/forceDestroyEditSessionConfiguration
The resource supports the following methods:
■ POST
![Page 346: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/346.jpg)
POST
1-324 RESTful Domain Runtime Reference for Oracle WebLogic Server
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).
1RolesAdmin, Deployer
1Request BodyMust contain a JSON object with the following fields:
editSessionEdit session to destroy.
Type: weblogic.management.runtime.EditSessionConfigurationRuntimeMBean reference
1Response BodyContains an empty JSON object.
![Page 347: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/347.jpg)
/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime
Resources 1-325
/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime
This resource manages a weblogic.management.runtime.ElasticServiceManagerRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 348: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/348.jpg)
GET
1-326 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.ElasticServiceManagerRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 349: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/349.jpg)
/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/getScalingTasks
Resources 1-327
/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/getScalingTasks
The resource supports the following methods:
■ POST
![Page 350: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/350.jpg)
POST
1-328 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
clusterNameCluster name
Type: string
sizeThe number of ScalingTaskRuntimeMBean to return starting with the most recent.
Type: int
1Response BodyContains a JSON object with a array of weblogic.management.runtime.ScalingTaskRuntimeMBean references return field.
![Page 351: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/351.jpg)
/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/purgeScalingTasks
Resources 1-329
/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/purgeScalingTasks
The resource supports the following methods:
■ POST
![Page 352: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/352.jpg)
POST
1-330 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Purge scaling tasks for a service which have completed at least "age" seconds ago. Tasks which are currently running will not be purged.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
clusterNameCluster name
Type: string
ageAge of tasks to be purged in seconds
Type: int
1Response BodyContains a JSON object with a int return field.
![Page 353: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/353.jpg)
/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleDown
Resources 1-331
/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleDown
The resource supports the following methods:
■ POST
![Page 354: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/354.jpg)
POST
1-332 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
clusterNameCluster name
Type: string
scaleFactorthe size by which the service must be scaled up
Type: int
1Response BodyContains a JSON object with a weblogic.management.runtime.ScalingTaskRuntimeMBean reference return field.
![Page 355: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/355.jpg)
/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleUp
Resources 1-333
/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleUp
The resource supports the following methods:
■ POST
![Page 356: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/356.jpg)
POST
1-334 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
clusterNameCluster name
Type: string
scaleFactorthe size by which the service must be scaled up
Type: int
1Response BodyContains a JSON object with a weblogic.management.runtime.ScalingTaskRuntimeMBean reference return field.
![Page 357: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/357.jpg)
/management/weblogic/{version}/domainRuntime/forceShutdownPartitionWait
Resources 1-335
/management/weblogic/{version}/domainRuntime/forceShutdownPartitionWait
The resource supports the following methods:
■ POST
![Page 358: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/358.jpg)
POST
1-336 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
partitionMBeanpartitionMBean
Type: weblogic.management.configuration.PartitionMBean reference
timeoutSpecifies 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
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
![Page 359: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/359.jpg)
/management/weblogic/{version}/domainRuntime/logRuntime
Resources 1-337
/management/weblogic/{version}/domainRuntime/logRuntime
This resource manages a weblogic.management.runtime.LogRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 360: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/360.jpg)
GET
1-338 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.LogRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 361: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/361.jpg)
/management/weblogic/{version}/domainRuntime/logRuntime/ensureLogOpened
Resources 1-339
/management/weblogic/{version}/domainRuntime/logRuntime/ensureLogOpened
The resource supports the following methods:
■ POST
![Page 362: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/362.jpg)
POST
1-340 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Ensures that that the output stream to the underlying is opened if it got closed previously due to errors.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 363: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/363.jpg)
/management/weblogic/{version}/domainRuntime/logRuntime/flushLog
Resources 1-341
/management/weblogic/{version}/domainRuntime/logRuntime/flushLog
The resource supports the following methods:
■ POST
![Page 364: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/364.jpg)
POST
1-342 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Flushes the buffer to the log file on disk.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 365: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/365.jpg)
/management/weblogic/{version}/domainRuntime/logRuntime/forceLogRotation
Resources 1-343
/management/weblogic/{version}/domainRuntime/logRuntime/forceLogRotation
The resource supports the following methods:
■ POST
![Page 366: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/366.jpg)
POST
1-344 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Forces the rotation of the underlying log immediately.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 367: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/367.jpg)
/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime
Resources 1-345
/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime
This resource manages a weblogic.management.runtime.MessageDrivenControlEJBRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 368: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/368.jpg)
GET
1-346 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.MessageDrivenControlEJBRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 369: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/369.jpg)
/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/printMDBStatus
Resources 1-347
/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/printMDBStatus
The resource supports the following methods:
■ POST
![Page 370: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/370.jpg)
POST
1-348 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Prints the MDBStatus for the specific type of MDB
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
ejbNameejbName
Type: string
applicationNameapplicationName
Type: string
1Response BodyContains a JSON object with a boolean return field.
![Page 371: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/371.jpg)
/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/resumeMDBs
Resources 1-349
/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/resumeMDBs
The resource supports the following methods:
■ POST
![Page 372: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/372.jpg)
POST
1-350 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Resumes the specific type of MDB by calling start on the JMS Connection.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
ejbNameejbName
Type: string
applicationNameapplicationName
Type: string
1Response BodyContains a JSON object with a boolean return field.
![Page 373: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/373.jpg)
/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/suspendMDBs
Resources 1-351
/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/suspendMDBs
The resource supports the following methods:
■ POST
![Page 374: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/374.jpg)
POST
1-352 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Suspends the specific type of MDB by calling stop on the JMS Connection.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
ejbNameejbName
Type: string
applicationNameapplicationName
Type: string
1Response BodyContains a JSON object with a boolean return field.
![Page 375: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/375.jpg)
/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime
Resources 1-353
/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime
This resource manages a weblogic.management.runtime.MigratableServiceCoordinatorRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 376: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/376.jpg)
GET
1-354 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.MigratableServiceCoordinatorRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 377: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/377.jpg)
/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrate
Resources 1-355
/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrate
The resource supports the following methods:
■ POST
![Page 378: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/378.jpg)
POST
1-356 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTMigrates 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.
1RolesAdmin
1Request BodyMust 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
1Response BodyContains an empty JSON object.
POSTMigrates 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.
1RolesAdmin
![Page 379: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/379.jpg)
/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrate
Resources 1-357
1Request BodyMust 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
1Response BodyContains an empty JSON object.
![Page 380: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/380.jpg)
/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateJTA
1-358 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateJTA
The resource supports the following methods:
■ POST
![Page 381: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/381.jpg)
/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateJTA
Resources 1-359
POST
Migrates the JTARecoveryManager deployed to a migratableTarget to the destination server.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
migratableTargetmigratableTarget
Type: weblogic.management.configuration.MigratableTargetMBean reference
destinationdestination
Type: weblogic.management.configuration.ServerMBean reference
sourceUpsourceUp
Type: boolean
destinationUpdestinationUp
Type: boolean
1Response BodyContains an empty JSON object.
![Page 382: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/382.jpg)
/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateSingleton
1-360 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateSingleton
The resource supports the following methods:
■ POST
![Page 383: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/383.jpg)
/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateSingleton
Resources 1-361
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.
1RolesAdmin
1Request BodyMust 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
1Response BodyContains an empty JSON object.
![Page 384: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/384.jpg)
/management/weblogic/{version}/domainRuntime/migrationDataRuntimes
1-362 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/migrationDataRuntimes
This resource manages a collection of weblogic.management.runtime.MigrationDataRuntimeMBean instances.
The resource supports the following methods:
■ GET
![Page 385: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/385.jpg)
/management/weblogic/{version}/domainRuntime/migrationDataRuntimes
Resources 1-363
GET
Get this collection of weblogic.management.runtime.MigrationDataRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 386: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/386.jpg)
/management/weblogic/{version}/domainRuntime/migrationDataRuntimes/{name}
1-364 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/migrationDataRuntimes/{name}
This resource manages a weblogic.management.runtime.MigrationDataRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 387: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/387.jpg)
/management/weblogic/{version}/domainRuntime/migrationDataRuntimes/{name}
Resources 1-365
GET
Get this weblogic.management.runtime.MigrationDataRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 388: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/388.jpg)
/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes
1-366 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes
This resource manages a collection of weblogic.management.runtime.NodeManagerRuntimeMBean instances.
The resource supports the following methods:
■ GET
![Page 389: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/389.jpg)
/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes
Resources 1-367
GET
Get this collection of weblogic.management.runtime.NodeManagerRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 390: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/390.jpg)
/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes/{name}
1-368 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes/{name}
This resource manages a weblogic.management.runtime.NodeManagerRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 391: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/391.jpg)
/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes/{name}
Resources 1-369
GET
Get this weblogic.management.runtime.NodeManagerRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 392: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/392.jpg)
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime
1-370 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime
This resource manages a weblogic.management.runtime.WseePolicySubjectManagerRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 393: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/393.jpg)
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime
Resources 1-371
GET
Get this weblogic.management.runtime.WseePolicySubjectManagerRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 394: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/394.jpg)
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/getPolicyRefStatus
1-372 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/getPolicyRefStatus
The resource supports the following methods:
■ POST
![Page 395: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/395.jpg)
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/getPolicyRefStatus
Resources 1-373
POST
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
policySubjectpolicySubject
Type: string
policyReferenceURIpolicyReferenceURI
Type: string
1Response BodyContains a JSON object with a string return field.
![Page 396: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/396.jpg)
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/isOWSMAttachable
1-374 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/isOWSMAttachable
The resource supports the following methods:
■ POST
![Page 397: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/397.jpg)
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/isOWSMAttachable
Resources 1-375
POST
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
policySubjectpolicySubject
Type: string
1Response BodyContains a JSON object with a boolean return field.
![Page 398: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/398.jpg)
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/removePolicyReference
1-376 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/removePolicyReference
The resource supports the following methods:
■ POST
![Page 399: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/399.jpg)
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/removePolicyReference
Resources 1-377
POST
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
policySubjectpolicySubject
Type: string
policyReferenceURIpolicyReferenceURI
Type: string
1Response BodyContains an empty JSON object.
![Page 400: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/400.jpg)
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/setPolicyRefStatus
1-378 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/setPolicyRefStatus
The resource supports the following methods:
■ POST
![Page 401: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/401.jpg)
/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/setPolicyRefStatus
Resources 1-379
POST
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
policySubjectpolicySubject
Type: string
policyReferenceURIpolicyReferenceURI
Type: string
enableenable
Type: boolean
1Response BodyContains an empty JSON object.
![Page 402: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/402.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes
1-380 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes
This resource manages a collection of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instances.
The resource supports the following methods:
■ GET
![Page 403: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/403.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes
Resources 1-381
GET
Get this collection of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 404: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/404.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}
1-382 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}
This resource manages a weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 405: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/405.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}
Resources 1-383
GET
Get this weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 406: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/406.jpg)
GET
1-384 RESTful Domain Runtime Reference for Oracle WebLogic Server
■ 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.
![Page 407: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/407.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceShutdown
Resources 1-385
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceShutdown
The resource supports the following methods:
■ POST
![Page 408: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/408.jpg)
POST
1-386 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTForces 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTForces 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 409: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/409.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceSuspend
Resources 1-387
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceSuspend
The resource supports the following methods:
■ POST
![Page 410: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/410.jpg)
POST
1-388 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTForcefully 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTForcefully 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 411: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/411.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/getState
Resources 1-389
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/getState
The resource supports the following methods:
■ POST
![Page 412: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/412.jpg)
POST
1-390 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Get the state of resource group on a specific server.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
serverMBeanserverMBean
Type: weblogic.management.configuration.ServerMBean reference
1Response BodyContains a JSON object with a string return field.
![Page 413: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/413.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/purgeTasks
Resources 1-391
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/purgeTasks
The resource supports the following methods:
■ POST
![Page 414: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/414.jpg)
POST
1-392 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Clears the retained task collection.
1RolesAdmin, Operator
1Response BodyContains an empty JSON object.
![Page 415: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/415.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/resume
Resources 1-393
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/resume
The resource supports the following methods:
■ POST
![Page 416: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/416.jpg)
POST
1-394 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
POSTTransitions 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTTransitions 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 417: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/417.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown
Resources 1-395
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown
The resource supports the following methods:
■ POST
![Page 418: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/418.jpg)
POST
1-396 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
■ POST
■ POST
■ POST
■ POST
POSTShuts 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTShuts 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 419: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/419.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown
Resources 1-397
POSTGracefully 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeoutNumber of seconds to wait before aborting inflight work and force shutting down the server.
Type: int
ignoreSessionsSet to true to ignore pending HTTP sessions during inflight work handling.
Type: boolean
waitForAllSessionsSet to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.
Type: boolean
targetsthe specific targets on which to shut down this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTGracefully 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
![Page 420: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/420.jpg)
POST
1-398 RESTful Domain Runtime Reference for Oracle WebLogic Server
timeoutNumber of seconds to wait before aborting inflight work and force shutting down the server.
Type: int
ignoreSessionsSet to true to ignore pending HTTP sessions during inflight work handling.
Type: boolean
waitForAllSessionsSet to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.
Type: boolean
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTShuts 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeoutNumber of seconds to wait before aborting inflight work and shutting down the server.
Type: int
ignoreSessionstrue indicates ignore pending HTTP sessions during inflight work handling.
Type: boolean
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTShuts down a resource group gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).
![Page 421: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/421.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown
Resources 1-399
This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeoutNumber of seconds to wait before aborting inflight work and shutting down the server.
Type: int
ignoreSessionstrue indicates ignore pending HTTP sessions during inflight work handling.
Type: boolean
targetsthe specific targets on which to shut down this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 422: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/422.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/start
1-400 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/start
The resource supports the following methods:
■ POST
![Page 423: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/423.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/start
Resources 1-401
POST
The resource supports the following methods:
■ POST
■ POST
POSTStarts 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTStarts 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 424: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/424.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin
1-402 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin
The resource supports the following methods:
■ POST
![Page 425: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/425.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin
Resources 1-403
POST
The resource supports the following methods:
■ POST
■ POST
POSTStarts 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this resource group in "admin" state
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTStarts 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 426: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/426.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend
1-404 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend
The resource supports the following methods:
■ POST
![Page 427: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/427.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend
Resources 1-405
POST
The resource supports the following methods:
■ POST
■ POST
■ POST
■ POST
POSTTransitions 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeoutSeconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.
Type: int
ignoreSessionsdrop inflight HTTP sessions during graceful suspend
Type: boolean
targetsthe specific targets on which to start this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTGracefully suspends the resource group to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.
![Page 428: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/428.jpg)
POST
1-406 RESTful Domain Runtime Reference for Oracle WebLogic 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTGracefully 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
targetsthe specific targets on which to start this resource group
Type: array of weblogic.management.configuration.TargetMBean references
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
POSTTransitions 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.
1RolesAdmin, Operator
![Page 429: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/429.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend
Resources 1-407
1Request BodyMust contain a JSON object with the following fields:
timeoutSeconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.
Type: int
ignoreSessionsdrop inflight HTTP sessions during graceful suspend
Type: boolean
1Response BodyContains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.
![Page 430: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/430.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks
1-408 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 431: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/431.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks
Resources 1-409
GET
Get this collection of weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 432: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/432.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}
1-410 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}
This resource manages a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 433: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/433.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}
Resources 1-411
GET
Get this weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 434: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/434.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/cancel
1-412 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 435: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/435.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/cancel
Resources 1-413
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin, Operator
1Response BodyContains an empty JSON object.
![Page 436: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/436.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks
1-414 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 437: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/437.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks
Resources 1-415
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 438: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/438.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}
1-416 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 439: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/439.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}
Resources 1-417
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 440: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/440.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/sub-
1-418 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 441: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/441.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/sub-
Resources 1-419
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 442: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/442.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/sub-
1-420 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 443: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/443.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/sub-
Resources 1-421
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 444: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/444.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/sub-
1-422 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 445: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/445.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/sub-
Resources 1-423
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 446: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/446.jpg)
1-424 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 447: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/447.jpg)
/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/sub
Resources 1-425
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 448: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/448.jpg)
/management/weblogic/{version}/domainRuntime/restartSystemResource
1-426 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/restartSystemResource
The resource supports the following methods:
■ POST
![Page 449: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/449.jpg)
/management/weblogic/{version}/domainRuntime/restartSystemResource
Resources 1-427
POST
Restarts a system resource on all nodes to which it is deployed.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
resourceresource
Type: weblogic.management.configuration.SystemResourceMBean reference
1Response BodyContains an empty JSON object.
![Page 450: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/450.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService
1-428 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/rolloutService
This resource manages a weblogic.management.runtime.RolloutServiceRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 451: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/451.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService
Resources 1-429
GET
Get this weblogic.management.runtime.RolloutServiceRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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
![Page 452: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/452.jpg)
GET
1-430 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
![Page 453: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/453.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows
Resources 1-431
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows
This resource manages a collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.
The resource supports the following methods:
■ GET
![Page 454: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/454.jpg)
GET
1-432 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 455: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/455.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}
Resources 1-433
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}
This resource manages a weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 456: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/456.jpg)
GET
1-434 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 457: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/457.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/cancel
Resources 1-435
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/cancel
The resource supports the following methods:
■ POST
![Page 458: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/458.jpg)
POST
1-436 RESTful Domain Runtime Reference for Oracle WebLogic Server
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}.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 459: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/459.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/canResume
Resources 1-437
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/canResume
The resource supports the following methods:
■ POST
![Page 460: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/460.jpg)
POST
1-438 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Response BodyContains a JSON object with a boolean return field.
![Page 461: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/461.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextExecuteStep
Resources 1-439
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextExecuteStep
The resource supports the following methods:
■ POST
![Page 462: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/462.jpg)
POST
1-440 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Response BodyContains a JSON object with a string return field.
![Page 463: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/463.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextRevertStep
Resources 1-441
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextRevertStep
The resource supports the following methods:
■ POST
![Page 464: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/464.jpg)
POST
1-442 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Response BodyContains a JSON object with a string return field.
![Page 465: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/465.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks
Resources 1-443
/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
![Page 466: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/466.jpg)
GET
1-444 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 467: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/467.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}
Resources 1-445
/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
![Page 468: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/468.jpg)
GET
1-446 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 469: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/469.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/cancel
Resources 1-447
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 470: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/470.jpg)
POST
1-448 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 471: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/471.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks
Resources 1-449
/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
![Page 472: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/472.jpg)
GET
1-450 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 473: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/473.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}
Resources 1-451
/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
![Page 474: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/474.jpg)
GET
1-452 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 475: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/475.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel
Resources 1-453
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 476: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/476.jpg)
POST
1-454 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 477: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/477.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/waitFor
Resources 1-455
/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/waitFor
The resource supports the following methods:
■ POST
![Page 478: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/478.jpg)
POST
1-456 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Waits for the process to finish.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 479: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/479.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/deleteWorkflow
Resources 1-457
/management/weblogic/{version}/domainRuntime/rolloutService/deleteWorkflow
The resource supports the following methods:
■ POST
![Page 480: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/480.jpg)
POST
1-458 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Delete workflow data of finished workflow
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
workflowIdis ID of workflow to be deleted - {@code WorkflowTaskRuntimeMBean.getWorkflowId()}
Type: string
1Response BodyContains an empty JSON object.
![Page 481: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/481.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/execScript
Resources 1-459
/management/weblogic/{version}/domainRuntime/rolloutService/execScript
The resource supports the following methods:
■ POST
![Page 482: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/482.jpg)
POST
1-460 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
machineNameName of MachineMBean where the NodeManager runs
Type: string
scriptNameName of script to run
Type: string
timeoutMillismillis 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
1Response BodyContains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.
![Page 483: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/483.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/executeWorkflow
Resources 1-461
/management/weblogic/{version}/domainRuntime/rolloutService/executeWorkflow
The resource supports the following methods:
■ POST
![Page 484: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/484.jpg)
POST
1-462 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
wfTaskwhich should be executed - continued. {@code delegate.isStopped()} must be {@code null}
Type: weblogic.management.runtime.WorkflowTaskRuntimeMBean reference
1Response BodyContains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.
![Page 485: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/485.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/getWorkflowTask
Resources 1-463
/management/weblogic/{version}/domainRuntime/rolloutService/getWorkflowTask
The resource supports the following methods:
■ POST
![Page 486: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/486.jpg)
POST
1-464 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
idof executed workflow
Type: string
1Response BodyContains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.
![Page 487: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/487.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows
Resources 1-465
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows
This resource manages a collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.
The resource supports the following methods:
■ GET
![Page 488: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/488.jpg)
GET
1-466 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 489: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/489.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}
Resources 1-467
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}
This resource manages a weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 490: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/490.jpg)
GET
1-468 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 491: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/491.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/cancel
Resources 1-469
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/cancel
The resource supports the following methods:
■ POST
![Page 492: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/492.jpg)
POST
1-470 RESTful Domain Runtime Reference for Oracle WebLogic Server
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}.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 493: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/493.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/canResume
Resources 1-471
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/canResume
The resource supports the following methods:
■ POST
![Page 494: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/494.jpg)
POST
1-472 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Response BodyContains a JSON object with a boolean return field.
![Page 495: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/495.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextExecuteStep
Resources 1-473
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextExecuteStep
The resource supports the following methods:
■ POST
![Page 496: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/496.jpg)
POST
1-474 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Response BodyContains a JSON object with a string return field.
![Page 497: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/497.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextRevertStep
Resources 1-475
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextRevertStep
The resource supports the following methods:
■ POST
![Page 498: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/498.jpg)
POST
1-476 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Response BodyContains a JSON object with a string return field.
![Page 499: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/499.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks
Resources 1-477
/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
![Page 500: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/500.jpg)
GET
1-478 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 501: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/501.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}
Resources 1-479
/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
![Page 502: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/502.jpg)
GET
1-480 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 503: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/503.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/cancel
Resources 1-481
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 504: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/504.jpg)
POST
1-482 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 505: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/505.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks
Resources 1-483
/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
![Page 506: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/506.jpg)
GET
1-484 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 507: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/507.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}
Resources 1-485
/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
![Page 508: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/508.jpg)
GET
1-486 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 509: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/509.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/sub-
Resources 1-487
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 510: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/510.jpg)
POST
1-488 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 511: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/511.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/waitFor
Resources 1-489
/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/waitFor
The resource supports the following methods:
■ POST
![Page 512: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/512.jpg)
POST
1-490 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Waits for the process to finish.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 513: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/513.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/initializeRolloutOracleHome
Resources 1-491
/management/weblogic/{version}/domainRuntime/rolloutService/initializeRolloutOracleHome
The resource supports the following methods:
■ POST
![Page 514: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/514.jpg)
POST
1-492 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
targetcan be the name of a domain, clusters or servers
Type: string
rolloutOracleHomethe location of the new OracleHome to use
Type: string
backupOracleHomethe location where the current OracleHome should be moved
Type: string
isRollbacktrue if the new OracleHome is a lower patch version than the current one
Type: string
optionscomma separated list of <name>=<value> options
Type: string
1Response BodyContains a JSON object with a weblogic.management.runtime.RolloutTaskRuntimeMBean reference return field.
![Page 515: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/515.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/restartNodeManager
Resources 1-493
/management/weblogic/{version}/domainRuntime/rolloutService/restartNodeManager
The resource supports the following methods:
■ POST
![Page 516: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/516.jpg)
POST
1-494 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
machineNameName of MachineMBean where NodeManager runs
Type: string
isAdminServertrue if the affected server is the AdminServer
Type: boolean
timeoutMillisHow 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
1Response BodyContains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.
![Page 517: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/517.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/revertWorkflow
Resources 1-495
/management/weblogic/{version}/domainRuntime/rolloutService/revertWorkflow
The resource supports the following methods:
■ POST
![Page 518: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/518.jpg)
POST
1-496 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
wfTaskwhich should be reverted. {@code delegate.isStopped()} must be {@code null}
Type: weblogic.management.runtime.WorkflowTaskRuntimeMBean reference
1Response BodyContains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.
![Page 519: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/519.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/rollingRestart
Resources 1-497
/management/weblogic/{version}/domainRuntime/rolloutService/rollingRestart
The resource supports the following methods:
■ POST
![Page 520: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/520.jpg)
POST
1-498 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
targetcan be the name of a domain, clusters or servers
Type: string
optionscomma separated list of <name>=<value> options
Type: string
1Response BodyContains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.
![Page 521: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/521.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/rolloutApplications
Resources 1-499
/management/weblogic/{version}/domainRuntime/rolloutService/rolloutApplications
The resource supports the following methods:
■ POST
![Page 522: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/522.jpg)
POST
1-500 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
targetcan be the name of a domain, clusters or servers
Type: string
applicationPropertiesthe path of a formatted text file containing the information needed to upgrade applications
Type: string
optionscomma separated list of <name>=<value> options
Type: string
1Response BodyContains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.
![Page 523: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/523.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/rolloutJavaHome
Resources 1-501
/management/weblogic/{version}/domainRuntime/rolloutService/rolloutJavaHome
The resource supports the following methods:
■ POST
![Page 524: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/524.jpg)
POST
1-502 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
targetcan be the name of a domain, clusters or servers
Type: string
javaHomethe path to the new JavaHome directory
Type: string
optionscomma separated list of <name>=<value> options
Type: string
1Response BodyContains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.
![Page 525: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/525.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/rolloutOracleHome
Resources 1-503
/management/weblogic/{version}/domainRuntime/rolloutService/rolloutOracleHome
The resource supports the following methods:
■ POST
![Page 526: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/526.jpg)
POST
1-504 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
targetcan be the name of a domain, clusters or servers
Type: string
rolloutOracleHomethe location of the new OracleHome to use
Type: string
backupOracleHomethe location where the current OracleHome should be moved
Type: string
isRollbacktrue if the new OracleHome is a lower patch version than the current one
Type: string
optionscomma separated list of <name>=<value> options
Type: string
1Response BodyContains a JSON object with a weblogic.management.runtime.RolloutTaskRuntimeMBean reference return field.
![Page 527: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/527.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/rolloutUpdate
Resources 1-505
/management/weblogic/{version}/domainRuntime/rolloutService/rolloutUpdate
The resource supports the following methods:
■ POST
![Page 528: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/528.jpg)
POST
1-506 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
targetcan be the name of a domain, clusters or servers
Type: string
rolloutOracleHomethe location of the new OracleHome to use
Type: string
backupOracleHomethe location where the current OracleHome should be moved
Type: string
isRollbacktrue if the new OracleHome is a lower patch version than the current one
Type: string
javaHomethe path to the new JavaHome directory
Type: string
applicationPropertiesthe path of a formatted text file containing the information needed to upgrade applications
Type: string
optionscomma separated list of <name>=<value> options
Type: string
1Response BodyContains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.
![Page 529: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/529.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/shutdownServer
Resources 1-507
/management/weblogic/{version}/domainRuntime/rolloutService/shutdownServer
The resource supports the following methods:
■ POST
![Page 530: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/530.jpg)
POST
1-508 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
serverNameName of the server that needs to be shutdown
Type: string
sessionTimeoutshutdownTimeout Time limit (in seconds) for server to complete a graceful shutdown. The default is 0 indicating no timeout.
Type: int
ignoreSessionsDrop sessions immediately rather than waiting for them to complete or timeout.
Type: boolean
waitForAllSessionsWait for all sessions (even sessions backed by a server) to complete.
Type: boolean
1Response BodyContains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.
![Page 531: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/531.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/startServer
Resources 1-509
/management/weblogic/{version}/domainRuntime/rolloutService/startServer
The resource supports the following methods:
■ POST
![Page 532: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/532.jpg)
POST
1-510 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
serverNameName 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
waitForAllSessionsWait for all sessions (even sessions backed by a server) to complete.
Type: boolean
1Response BodyContains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.
![Page 533: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/533.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows
Resources 1-511
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows
This resource manages a collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.
The resource supports the following methods:
■ GET
![Page 534: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/534.jpg)
GET
1-512 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 535: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/535.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}
Resources 1-513
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}
This resource manages a weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 536: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/536.jpg)
GET
1-514 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 537: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/537.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/cancel
Resources 1-515
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/cancel
The resource supports the following methods:
■ POST
![Page 538: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/538.jpg)
POST
1-516 RESTful Domain Runtime Reference for Oracle WebLogic Server
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}.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 539: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/539.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/canResume
Resources 1-517
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/canResume
The resource supports the following methods:
■ POST
![Page 540: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/540.jpg)
POST
1-518 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Response BodyContains a JSON object with a boolean return field.
![Page 541: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/541.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextExecuteStep
Resources 1-519
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextExecuteStep
The resource supports the following methods:
■ POST
![Page 542: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/542.jpg)
POST
1-520 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Response BodyContains a JSON object with a string return field.
![Page 543: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/543.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextRevertStep
Resources 1-521
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextRevertStep
The resource supports the following methods:
■ POST
![Page 544: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/544.jpg)
POST
1-522 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin
1Response BodyContains a JSON object with a string return field.
![Page 545: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/545.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks
Resources 1-523
/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
![Page 546: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/546.jpg)
GET
1-524 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 547: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/547.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}
Resources 1-525
/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
![Page 548: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/548.jpg)
GET
1-526 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 549: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/549.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/cancel
Resources 1-527
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 550: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/550.jpg)
POST
1-528 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 551: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/551.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks
Resources 1-529
/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
![Page 552: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/552.jpg)
GET
1-530 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 553: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/553.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}
Resources 1-531
/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
![Page 554: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/554.jpg)
GET
1-532 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 555: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/555.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/sub-
Resources 1-533
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 556: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/556.jpg)
POST
1-534 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 557: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/557.jpg)
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/waitFor
Resources 1-535
/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/waitFor
The resource supports the following methods:
■ POST
![Page 558: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/558.jpg)
POST
1-536 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Waits for the process to finish.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 559: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/559.jpg)
/management/weblogic/{version}/domainRuntime/search
Resources 1-537
/management/weblogic/{version}/domainRuntime/search
The resource supports the following methods:
■ POST
![Page 560: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/560.jpg)
POST
1-538 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
Search the domainRuntime tree.
1Request BodyThe search request body includes the search criteria.
1Response BodyThe search response includes the results of the search.
![Page 561: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/561.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes
Resources 1-539
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes
This resource manages a collection of weblogic.management.runtime.ServerLifeCycleRuntimeMBean instances.
The resource supports the following methods:
■ GET
![Page 562: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/562.jpg)
GET
1-540 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.ServerLifeCycleRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 563: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/563.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}
Resources 1-541
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}
This resource manages a weblogic.management.runtime.ServerLifeCycleRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 564: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/564.jpg)
GET
1-542 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this weblogic.management.runtime.ServerLifeCycleRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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
![Page 565: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/565.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}
Resources 1-543
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.
![Page 566: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/566.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceShutdown
1-544 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceShutdown
The resource supports the following methods:
■ POST
![Page 567: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/567.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceShutdown
Resources 1-545
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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.
1Example
Example 1 Synchronously Invoke the forceShutdown ActionThis 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}
![Page 568: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/568.jpg)
POST
1-546 RESTful Domain Runtime Reference for Oracle WebLogic Server
Example 2 Asynchronously Invoke the forceShutdown ActionThis 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}
![Page 569: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/569.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceSuspend
Resources 1-547
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceSuspend
The resource supports the following methods:
■ POST
![Page 570: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/570.jpg)
POST
1-548 RESTful Domain Runtime Reference for Oracle WebLogic Server
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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.
1Example
Example 1 Synchronously Invoke the forceSuspend ActionThis 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}
![Page 571: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/571.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceSuspend
Resources 1-549
Example 2 Asynchronously Invoke the forceSuspend ActionThis 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}
![Page 572: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/572.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv4URL
1-550 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv4URL
The resource supports the following methods:
■ POST
![Page 573: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/573.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv4URL
Resources 1-551
POST
The IPv4 URL that clients use when connecting to this server using the specified protocol.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
protocolthe desired protocol
Type: string
1Response BodyContains a JSON object with a string return field.
![Page 574: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/574.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv6URL
1-552 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv6URL
The resource supports the following methods:
■ POST
![Page 575: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/575.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv6URL
Resources 1-553
POST
The IPv6 URL that clients use when connecting to this server using the specified protocol.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
protocolthe desired protocol
Type: string
1Response BodyContains a JSON object with a string return field.
![Page 576: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/576.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/resume
1-554 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/resume
The resource supports the following methods:
■ POST
![Page 577: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/577.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/resume
Resources 1-555
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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.
1Example
Example 1 Synchronously Invoke the resume ActionThis 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 ActionThis example uses the POST method to asynchronously invoke the resume action.
![Page 578: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/578.jpg)
POST
1-556 RESTful Domain Runtime Reference for Oracle WebLogic Server
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}
![Page 579: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/579.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown
Resources 1-557
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown
The resource supports the following methods:
■ POST
![Page 580: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/580.jpg)
POST
1-558 RESTful Domain Runtime Reference for Oracle WebLogic Server
POST
The resource supports the following methods:
■ POST
■ POST
■ POST
POSTGracefully 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.
1Example
Example 1 Synchronously Invoke the shutdown ActionThis 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",
![Page 581: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/581.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown
Resources 1-559
"serverName": "Cluster-0-Server-1", "operation": "shutdown", "taskStatus": "TASK COMPLETED", "completed": true}
Example 2 Asynchronously Invoke the shutdown ActionThis 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}
POSTGracefully 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
![Page 582: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/582.jpg)
POST
1-560 RESTful Domain Runtime Reference for Oracle WebLogic 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeoutNumber of seconds to wait before aborting inflight work and force shutting down the server.
Type: int
ignoreSessionsSet to true to ignore pending HTTP sessions during inflight work handling.
Type: boolean
waitForAllSessionsSet to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.
Type: boolean
1Response BodyContains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.
1Example
Example 1 Synchronously Invoke the shutdown ActionThis 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": [{
![Page 583: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/583.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown
Resources 1-561
"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 ActionThis 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}
POSTGracefully 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);
![Page 584: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/584.jpg)
POST
1-562 RESTful Domain Runtime Reference for Oracle WebLogic 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
timeoutNumber of seconds to wait before aborting inflight work and force shutting down the server.
Type: int
ignoreSessionsSet to true to ignore pending HTTP sessions during inflight work handling.
Type: boolean
1Response BodyContains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.
1Example
Example 1 Synchronously Invoke the shutdown ActionThis 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",
![Page 585: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/585.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown
Resources 1-563
"serverName": "Cluster-0-Server-1", "operation": "shutdown", "taskStatus": "TASK COMPLETED", "completed": true}
Example 2 Asynchronously Invoke the shutdown ActionThis 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}
![Page 586: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/586.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/start
1-564 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/start
The resource supports the following methods:
■ POST
![Page 587: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/587.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/start
Resources 1-565
POST
The resource supports the following methods:
■ POST
■ POST
POSTUses 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.
1Example
Example 1 Synchronously Invoke the start ActionThis 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"
![Page 588: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/588.jpg)
POST
1-566 RESTful Domain Runtime Reference for Oracle WebLogic Server
], "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 ActionThis 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}
![Page 589: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/589.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/start
Resources 1-567
POSTUses 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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
disableMsiMode:if true, the server will not start in Managed Server Independence mode
Type: boolean
1Response BodyContains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.
![Page 590: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/590.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInAdmin
1-568 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInAdmin
The resource supports the following methods:
■ POST
![Page 591: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/591.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInAdmin
Resources 1-569
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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.
![Page 592: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/592.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInStandby
1-570 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInStandby
The resource supports the following methods:
■ POST
![Page 593: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/593.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInStandby
Resources 1-571
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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.
![Page 594: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/594.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/suspend
1-572 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/suspend
The resource supports the following methods:
■ POST
![Page 595: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/595.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/suspend
Resources 1-573
POST
The resource supports the following methods:
■ POST
■ POST
POSTGracefully 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.
1RolesAdmin, Operator
1Response BodyContains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.
1Example
Example 1 Synchronously Invoke the suspend ActionThis 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",
![Page 596: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/596.jpg)
POST
1-574 RESTful Domain Runtime Reference for Oracle WebLogic Server
"operation": "suspendWithTimeout", "taskStatus": "TASK COMPLETED", "completed": true}
Example 2 Asynchronously Invoke the suspend ActionThis 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}
POSTTransitions 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.
1RolesAdmin, Operator
![Page 597: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/597.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/suspend
Resources 1-575
1Request BodyMust contain a JSON object with the following fields:
timeoutSeconds to wait for server to transition gracefully. The server calls forceSuspend() after timeout.
Type: int
ignoreSessionsdrop inflight HTTP sessions during graceful suspend
Type: boolean
1Response BodyContains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.
1Example
Example 1 Synchronously Invoke the suspend ActionThis 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}
![Page 598: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/598.jpg)
POST
1-576 RESTful Domain Runtime Reference for Oracle WebLogic Server
Example 2 Asynchronously Invoke the suspend ActionThis 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}
![Page 599: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/599.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks
Resources 1-577
/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
![Page 600: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/600.jpg)
GET
1-578 RESTful Domain Runtime Reference for Oracle WebLogic Server
GET
Get this collection of weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
1Example
Example 1 View the weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean CollectionThis 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
![Page 601: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/601.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks
Resources 1-579
}, { "progress": "success", "serverName": "Cluster-0-Server-1", "operation": "shutdown", "completed": true }, { "progress": "success", "serverName": "Cluster-0-Server-1", "operation": "start", "completed": true }]}
![Page 602: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/602.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}
1-580 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}
This resource manages a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 603: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/603.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}
Resources 1-581
GET
Get this weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 604: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/604.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/cancel
1-582 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 605: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/605.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/cancel
Resources 1-583
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin, Operator
1Response BodyContains an empty JSON object.
![Page 606: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/606.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks
1-584 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 607: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/607.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks
Resources 1-585
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 608: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/608.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}
1-586 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 609: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/609.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}
Resources 1-587
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 610: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/610.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel
1-588 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 611: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/611.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel
Resources 1-589
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 612: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/612.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks
1-590 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 613: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/613.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks
Resources 1-591
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 614: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/614.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/sub-
1-592 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 615: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/615.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/sub-
Resources 1-593
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 616: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/616.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/sub-
1-594 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 617: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/617.jpg)
/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/sub-
Resources 1-595
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 618: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/618.jpg)
/management/weblogic/{version}/domainRuntime/serverRuntimes
1-596 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 619: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/619.jpg)
/management/weblogic/{version}/domainRuntime/serverRuntimes
Resources 1-597
GET
Get this weblogic.management.runtime.ServerRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 620: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/620.jpg)
/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes
1-598 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes
This resource manages a collection of weblogic.management.runtime.ServiceMigrationDataRuntimeMBean instances.
The resource supports the following methods:
■ GET
![Page 621: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/621.jpg)
/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes
Resources 1-599
GET
Get this collection of weblogic.management.runtime.ServiceMigrationDataRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 622: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/622.jpg)
/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes/{name}
1-600 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes/{name}
This resource manages a weblogic.management.runtime.ServiceMigrationDataRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 623: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/623.jpg)
/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes/{name}
Resources 1-601
GET
Get this weblogic.management.runtime.ServiceMigrationDataRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 624: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/624.jpg)
/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime
1-602 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime
This resource manages a weblogic.management.runtime.SNMPAgentRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 625: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/625.jpg)
/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime
Resources 1-603
GET
Get this weblogic.management.runtime.SNMPAgentRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 626: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/626.jpg)
/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/invalidateLocalizedKeyCache
1-604 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/invalidateLocalizedKeyCache
The resource supports the following methods:
■ POST
![Page 627: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/627.jpg)
/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/invalidateLocalizedKeyCache
Resources 1-605
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
usernameName of the user
Type: string
1Response BodyContains an empty JSON object.
![Page 628: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/628.jpg)
/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/outputCustomMBeansMIBModule
1-606 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/outputCustomMBeansMIBModule
The resource supports the following methods:
■ POST
![Page 629: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/629.jpg)
/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/outputCustomMBeansMIBModule
Resources 1-607
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.
1RolesAdmin
1Response BodyContains a JSON object with a string return field.
![Page 630: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/630.jpg)
/management/weblogic/{version}/domainRuntime/startPartitionWait
1-608 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/startPartitionWait
The resource supports the following methods:
■ POST
![Page 631: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/631.jpg)
/management/weblogic/{version}/domainRuntime/startPartitionWait
Resources 1-609
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.
1RolesAdmin
1Request BodyMust contain a JSON object with the following fields:
partitionMBeanpartitionMBean
Type: weblogic.management.configuration.PartitionMBean reference
initialStatecan be ADMIN or RUNNING, Default is RUNNING
Type: string
timeOutSpecifies 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
1Response BodyContains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.
![Page 632: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/632.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes
1-610 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes
This resource manages a collection of weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean instances.
The resource supports the following methods:
■ GET
![Page 633: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/633.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes
Resources 1-611
GET
Get this collection of weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 634: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/634.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}
1-612 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}
This resource manages a weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 635: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/635.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}
Resources 1-613
GET
Get this weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 636: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/636.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/shutdown
1-614 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/shutdown
The resource supports the following methods:
■ POST
![Page 637: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/637.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/shutdown
Resources 1-615
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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
propsproperties to use when shutting down this system component. These properties are used by the nodemanager plugin.
Type: java.util.Properties
1Response BodyContains a JSON object with a weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean reference return field.
![Page 638: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/638.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/softRestart
1-616 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/softRestart
The resource supports the following methods:
■ POST
![Page 639: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/639.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/softRestart
Resources 1-617
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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
propsproperties to use when soft-restarting this system component. These properties are used by the nodemanager plugin.
Type: java.util.Properties
1Response BodyContains a JSON object with a weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean reference return field.
![Page 640: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/640.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/start
1-618 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/start
The resource supports the following methods:
■ POST
![Page 641: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/641.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/start
Resources 1-619
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.
1RolesAdmin, Operator
1Request BodyMust contain a JSON object with the following fields:
propsproperties to use when starting this system component. These properties are used by the nodemanager plugin.
Type: java.util.Properties
1Response BodyContains a JSON object with a weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean reference return field.
![Page 642: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/642.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks
1-620 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 643: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/643.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks
Resources 1-621
GET
Get this collection of weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 644: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/644.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}
1-622 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}
This resource manages a weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean instance.
The resource supports the following methods:
■ GET
![Page 645: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/645.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}
Resources 1-623
GET
Get this weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 646: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/646.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/cancel
1-624 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 647: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/647.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/cancel
Resources 1-625
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin, Operator
1Response BodyContains an empty JSON object.
![Page 648: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/648.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks
1-626 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 649: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/649.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks
Resources 1-627
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 650: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/650.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}
1-628 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 651: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/651.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}
Resources 1-629
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 652: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/652.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/sub-
1-630 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 653: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/653.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/sub-
Resources 1-631
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 654: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/654.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/sub-
1-632 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 655: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/655.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/sub-
Resources 1-633
GET
Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 656: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/656.jpg)
1-634 RESTful Domain Runtime Reference for Oracle WebLogic Server
/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
![Page 657: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/657.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/
Resources 1-635
GET
Get this weblogic.management.runtime.TaskRuntimeMBean instance.
1RolesAdmin, Deployer, Monitor, Operator
1Response BodyContains 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.
![Page 658: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/658.jpg)
1-636 RESTful Domain Runtime Reference for Oracle WebLogic Server
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel
The resource supports the following methods:
■ POST
![Page 659: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/659.jpg)
/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/
Resources 1-637
POST
Attempts to cancel this task.
An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.
1RolesAdmin
1Response BodyContains an empty JSON object.
![Page 660: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/660.jpg)
POST
1-638 RESTful Domain Runtime Reference for Oracle WebLogic Server
![Page 661: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/661.jpg)
2
Entities 2-1
2Entities
[3] 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.ThrowableThis entity represents errors and exceptions.
The properties of the java.lang.Throwable entity are as follows:
causeThis property contains the stack trace of errors and exceptions.
Type: java.lang.Throwable
messageThis property contains the reason why the error or exception was thrown.
Type: string
java.util.DateThis entity represents a date as a string in ISO 8601 format, yyyy-MM-ddTHH:mm:ss.SSSX
java.util.PropertiesThis 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.HealthStateThis 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:
partitionNameThis property indicates the partition name for which the health state is reported.
Type: string
![Page 662: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/662.jpg)
weblogic.health.Symptom
2-2 RESTful Domain Runtime Reference for Oracle WebLogic Server
stateThis 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
subsystemNameThis property indicates the service for which the health state is reported.
Type: string
symptomsThis property idicates the cause ot the reported state.
Type: array of weblogic.health.Symptom
weblogic.health.SymptomThis 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:
infoThis property provides additional information about the symptom if available.
Type: string
instanceIdThis property represents an identifier for the symptom.
Type: string
severityThis property indicates a low, medium, or high severity level.
Type: string
typeThis property represents the cause of the symptom (low memory, network error, stuck threads, and so on).
Type: string
weblogic.management.rest.bean.model.CurrentUserThe authenticated user that is making the request.
The properties of the weblogic.management.rest.bean.model.CurrentUser entity are as follows:
![Page 663: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/663.jpg)
weblogic.management.runtime.AppDeploymentRuntimeMBean
Entities 2-3
partitionIdThe ID of the partition where the component that is being invoked resides.
Type: string
partitionNameThe human readable name of the partition ID.
Type: string
userThe 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.VersionA Version entity describes a version of the WebLogic Server resources.
The properties of the weblogic.management.rest.bean.model.Version entity are as follows:
isLatestTrue if this is the default version.
Type: boolean
lifecycleThe lifecycle of this version: active or deprecated
Type: string
versionThe name of this version.
Type: string
weblogic.management.runtime.AppDeploymentRuntimeMBeanThis 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:
applicationNameThe application's name.
Type: string
Constraints: Read Only, Restart Required
applicationVersionThe application's version identifier.
Type: string
Constraints: Read Only, Restart Required
![Page 664: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/664.jpg)
weblogic.management.runtime.AppRuntimeStateRuntimeMBean
2-4 RESTful Domain Runtime Reference for Oracle WebLogic Server
modulesThe list of modules for the application. These modules can be used in module level targeting.
Type: array of string
Constraints: Read Only, Restart Required
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
partitionNameThe name of the partition the application is in.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.AppRuntimeStateRuntimeMBeanProvides access to runtime state for deployed applications.
The properties of the weblogic.management.runtime.AppRuntimeStateRuntimeMBean entity are as follows:
applicationIdsType: array of string
Constraints: Read Only, Restart Required
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.BatchJobRepositoryRuntimeMBeanThe properties of the weblogic.management.runtime.BatchJobRepositoryRuntimeMBean entity are as follows:
![Page 665: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/665.jpg)
weblogic.management.runtime.DeploymentManagerMBean
Entities 2-5
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.ConsoleRuntimeMBeanRuntime services for the console.
The properties of the weblogic.management.runtime.ConsoleRuntimeMBean entity are as follows:
enabledIs the console enabled?
Type: boolean
Constraints: Read Only, Restart Required
homePageURLGets the URL for the console's home page
Type: string
Constraints: Read Only, Restart Required
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.DeploymentManagerMBeanThis 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.
![Page 666: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/666.jpg)
weblogic.management.runtime.DeploymentProgressObjectMBean
2-6 RESTful Domain Runtime Reference for Oracle WebLogic Server
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:
maximumDeploymentProgressObjectsCountThe maximum number of progress objects allowed.
Type: int
Constraints: Restart Required
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.DeploymentProgressObjectMBeanThis 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:
applicationNameThe name of the application for the current deployment operation.
Type: string
Constraints: Read Only, Restart Required
![Page 667: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/667.jpg)
weblogic.management.runtime.DeploymentProgressObjectMBean
Entities 2-7
completedThis property indicates whether an asynchronous job has completed.
Type: boolean
deploymentMessagesProvides an ordered array of status messages generated for the current deployment operation.
Type: array of string
Constraints: Read Only, Restart Required
endTimeThis property indicates the time when the asynchronous job ended.
Type: java.util.Date
failedTargetsThe targets on which the current deployment operation failed.
Type: array of string
Constraints: Read Only, Restart Required
idThe unique ID for the current deployment operation.
Type: string
Constraints: Read Only, Restart Required
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
operationTypeThe deployment operation type for the current deployment operation. Possible values are 1 (start) and 2 (stop).
Type: int
Constraints: Read Only, Restart Required
progressThis property indicates whether an asynchronous job has succeeded, failed, or is in progress.
Type: string
rootExceptionsIf 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
![Page 668: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/668.jpg)
weblogic.management.runtime.DomainPartitionRuntimeMBean
2-8 RESTful Domain Runtime Reference for Oracle WebLogic Server
startTimeThis property indicates the time when an asynchronous job was started.
Type: java.util.Date
startTimeAsLongThe time that the current deployment operation began. The value is in milliseconds consistent with the system time.
Type: long
Constraints: Read Only, Restart Required
stateThe 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
targetsThe targets specified for the current deployment operation.
Type: array of string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.DomainPartitionRuntimeMBeanThis class is used for domain level partition handling.
The properties of the weblogic.management.runtime.DomainPartitionRuntimeMBean entity are as follows:
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
partitionIDReturns partition ID value for corresponding partition.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
![Page 669: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/669.jpg)
weblogic.management.runtime.EditSessionConfigurationManagerMBean
Entities 2-9
weblogic.management.runtime.DomainRuntimeMBeanThis 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:
activationTimeThe time when the domain became active.
Type: java.util.Date
Constraints: Read Only, Restart Required
currentDomainPartitionRuntimeReturns the domain partition runtime MBean for the "current" partition
Type: weblogic.management.runtime.DomainPartitionRuntimeMBean reference
Constraints: Read Only, Restart Required
nameThe 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
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.EditSessionConfigurationManagerMBeanThe properties of the weblogic.management.runtime.EditSessionConfigurationManagerMBean entity are as follows:
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
![Page 670: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/670.jpg)
weblogic.management.runtime.EditSessionConfigurationRuntimeMBean
2-10 RESTful Domain Runtime Reference for Oracle WebLogic Server
weblogic.management.runtime.EditSessionConfigurationRuntimeMBeanThe properties of the weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity are as follows:
creatorThe original creator of the edit session.
Type: string
Constraints: Read Only, Restart Required
currentEditorThe current editor of the edit session. The editor owns the lock.
Type: string
Constraints: Read Only, Restart Required
descriptionThe description of the edit session configuration.
Type: string
Constraints: Read Only, Restart Required
editSessionNameThe name of the edit session configuration.
Type: string
Constraints: Read Only, Restart Required
editSessionServerJndiThe JNDI name of the related EditSessionServer
Type: string
Constraints: Read Only, Restart Required
mergeNeededReturns 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
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
![Page 671: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/671.jpg)
weblogic.management.runtime.LibDeploymentRuntimeMBean
Entities 2-11
partitionNameThe partition name to which this edit session belongs.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.ElasticServiceManagerRuntimeMBeanThe properties of the weblogic.management.runtime.ElasticServiceManagerRuntimeMBean entity are as follows:
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.LibDeploymentRuntimeMBeanThis MBean provides deployment operations for a library..
The properties of the weblogic.management.runtime.LibDeploymentRuntimeMBean entity are as follows:
implementationVersionThe library's implementation version, null if none is set
Type: string
Constraints: Read Only, Restart Required
libraryIdentifierThe library's identifier.
Type: string
Constraints: Read Only, Restart Required
libraryNameThe library's name.
Type: string
Constraints: Read Only, Restart Required
![Page 672: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/672.jpg)
weblogic.management.runtime.LogRuntimeMBean
2-12 RESTful Domain Runtime Reference for Oracle WebLogic Server
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
partitionNameThe name of the partition the library is in.
Type: string
Constraints: Read Only, Restart Required
specificationVersionThe library's specification version, null if none is set
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.LogRuntimeMBeanThis interface defines the control operations for a log in the WebLogic Server.
The properties of the weblogic.management.runtime.LogRuntimeMBean entity are as follows:
logFileStreamOpenedGets the opened state of the log file stream represented by this instance.
Type: boolean
Constraints: Read Only, Restart Required
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.MessageDrivenControlEJBRuntimeMBeanThis interface contains controls to suspend and resume the MDBs. This RuntimeMBean is deployed only on the AdminServer.
![Page 673: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/673.jpg)
weblogic.management.runtime.MigrationDataRuntimeMBean
Entities 2-13
The properties of the weblogic.management.runtime.MessageDrivenControlEJBRuntimeMBean entity are as follows:
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
typeReturns 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:
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.MigrationDataRuntimeMBeanRuntime information about one past or ongoing migration.
The properties of the weblogic.management.runtime.MigrationDataRuntimeMBean entity are as follows:
clusterMasterNameName of the server that acted as the cluster master for this migration.
Type: string
Constraints: Read Only, Restart Required
clusterNameName of the server that acted as the cluster master for this migration.
Type: string
![Page 674: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/674.jpg)
weblogic.management.runtime.MigrationDataRuntimeMBean
2-14 RESTful Domain Runtime Reference for Oracle WebLogic Server
Constraints: Read Only, Restart Required
machineMigratedFromMachine from which the server was migrated from
Type: string
Constraints: Read Only, Restart Required
machineMigratedToMachine to which the server was migrated to or is in the process of being migrated to.
Type: string
Constraints: Read Only, Restart Required
machinesAttemptedGet all the machines attempted for migration.
Type: array of string
Constraints: Read Only, Restart Required
migrationEndTimeEnd time of migration
Type: long
Constraints: Read Only, Restart Required
migrationStartTimeStart time of migration
Type: long
Constraints: Read Only, Restart Required
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
serverNameName of the server migrated
Type: string
Constraints: Read Only, Restart Required
statusName of the server migrated
Type: int
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
![Page 675: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/675.jpg)
weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean
Entities 2-15
weblogic.management.runtime.NodeManagerRuntimeMBeanProvides 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:
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
reachableType: boolean
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.PartitionLifeCycleRuntimeMBeanThe properties of the weblogic.management.runtime.PartitionLifeCycleRuntimeMBean entity are as follows:
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
stateThe current state of the partition.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBeanExposes information about a long-running task related to the partition life cycle.
![Page 676: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/676.jpg)
weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean
2-16 RESTful Domain Runtime Reference for Oracle WebLogic Server
The properties of the weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean entity are as follows:
completedThis property indicates whether an asynchronous job has completed.
Type: boolean
descriptionA description of this task.
Type: string
Constraints: Read Only, Restart Required
endTimeThis property indicates the time when the asynchronous job ended.
Type: java.util.Date
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
operationReturns the name of the current operation.
Type: string
Constraints: Read Only, Restart Required
parentTaskThe 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
partitionNameReturns the name of the partition being operated on.
Type: string
Constraints: Read Only, Restart Required
progressThe progress of this task.
Type: string
Constraints: Read Only, Restart Required
runningIndicates whether the task is still running.
Type: boolean
Constraints: Read Only, Restart Required
![Page 677: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/677.jpg)
weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean
Entities 2-17
startTimeThis property indicates the time when an asynchronous job was started.
Type: java.util.Date
startTimeAsLongThe time at which this task was started.
Type: long
Constraints: Read Only, Restart Required
systemTaskIndicates whether this task was initiated by the server versus a user.
Type: boolean
Constraints: Read Only, Restart Required
taskErrorReturns an exception describing the error, if any, that occurred while performing this task.
Type: java.lang.Throwable
Constraints: Read Only, Restart Required
taskStatusThe status of this task.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBeanThe properties of the weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean entity are as follows:
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
stateCurrent resource group state.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
![Page 678: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/678.jpg)
weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean
2-18 RESTful Domain Runtime Reference for Oracle WebLogic Server
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean
The properties of the weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean entity are as follows:
completedThis property indicates whether an asynchronous job has completed.
Type: boolean
descriptionA description of this task.
Type: string
Constraints: Read Only, Restart Required
endTimeThis property indicates the time when the asynchronous job ended.
Type: java.util.Date
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
operationReturns the name of the current operation.
Type: string
Constraints: Read Only, Restart Required
parentTaskThe 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
progressThe progress of this task.
Type: string
Constraints: Read Only, Restart Required
resourceGroupNameReturns the name of the resource group being operated on.
Type: string
![Page 679: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/679.jpg)
weblogic.management.runtime.RolloutServiceRuntimeMBean
Entities 2-19
Constraints: Read Only, Restart Required
runningIndicates whether the task is still running.
Type: boolean
Constraints: Read Only, Restart Required
startTimeThis property indicates the time when an asynchronous job was started.
Type: java.util.Date
startTimeAsLongThe time at which this task was started.
Type: long
Constraints: Read Only, Restart Required
systemTaskIndicates whether this task was initiated by the server versus a user.
Type: boolean
Constraints: Read Only, Restart Required
taskErrorReturns an exception describing the error, if any, that occurred while performing this task.
Type: java.lang.Throwable
Constraints: Read Only, Restart Required
taskStatusThe status of this task.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.RolloutServiceRuntimeMBeanThe properties of the weblogic.management.runtime.RolloutServiceRuntimeMBean entity are as follows:
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
![Page 680: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/680.jpg)
weblogic.management.runtime.SNMPAgentRuntimeMBean
2-20 RESTful Domain Runtime Reference for Oracle WebLogic Server
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.SNMPAgentRuntimeMBeanRuntime 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:
SNMPAgentNameGets 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
UDPListenPortThe 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
attributeChangeTrapCountThe 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
counterMonitorTrapCountThe 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
failedAuthenticationCountThe number of requests that this agent has rejected because of incorrect user credentials.
Type: int
Constraints: Read Only, Restart Required
failedAuthorizationCountThe 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.
![Page 681: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/681.jpg)
weblogic.management.runtime.SNMPAgentRuntimeMBean
Entities 2-21
Type: int
Constraints: Read Only, Restart Required
failedEncryptionCountThe number of requests that this agent has rejected because of incorrect privacy (encryption) credentials
Type: int
Constraints: Read Only, Restart Required
gaugeMonitorTrapCountThe 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
logMessageTrapCountThe 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
masterAgentXPortThe 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
monitorTrapCountThe 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
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
runningIndicates whether this SNMP agent is running.
Type: boolean
Constraints: Read Only, Restart Required
serverStartTrapCountThe number of serverStart notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.
![Page 682: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/682.jpg)
weblogic.management.runtime.ServerLifeCycleRuntimeMBean
2-22 RESTful Domain Runtime Reference for Oracle WebLogic Server
Type: long
Constraints: Read Only, Restart Required
serverStopTrapCountThe 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
stringMonitorTrapCountThe 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
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.ServerLifeCycleRuntimeMBeanProvides 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:
middlewareHomeThe Oracle Middleware installation directory.
Type: string
Constraints: Read Only, Restart Required
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
nodeManagerRestartCountNumber 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.
![Page 683: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/683.jpg)
weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean
Entities 2-23
Type: int
Constraints: Read Only, Restart Required
stateThe current state of the server.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogicHomeThe directory where the WebLogic Server instance (server) is installed, without the trailing "/server".
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBeanExposes 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:
completedThis property indicates whether an asynchronous job has completed.
Type: boolean
descriptionA description of this task.
Type: string
Constraints: Read Only, Restart Required
endTimeThis property indicates the time when the asynchronous job ended.
Type: java.util.Date
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
![Page 684: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/684.jpg)
weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean
2-24 RESTful Domain Runtime Reference for Oracle WebLogic Server
operationGets the name of the method that was invoked on the ServerLifeCycleRuntime to initiate this task.
Type: string
Constraints: Read Only, Restart Required
parentTaskThe 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
progressThe progress of this task.
Type: string
Constraints: Read Only, Restart Required
runningIndicates whether the task is still running.
Type: boolean
Constraints: Read Only, Restart Required
serverNameThe name of the server.
Type: string
Constraints: Read Only, Restart Required
startTimeThis property indicates the time when an asynchronous job was started.
Type: java.util.Date
startTimeAsLongThe time at which this task was started.
Type: long
Constraints: Read Only, Restart Required
systemTaskIndicates whether this task was initiated by the server versus a user.
Type: boolean
Constraints: Read Only, Restart Required
taskErrorReturns an exception describing the error, if any, that occurred while performing this task.
Type: java.lang.Throwable
Constraints: Read Only, Restart Required
![Page 685: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/685.jpg)
weblogic.management.runtime.ServerRuntimeMBean
Entities 2-25
taskStatusThe status of this task.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.ServerRuntimeMBeanProvides 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:
SSLListenPortEnabledIndicates whether the default SSL listen port is enabled on the server
Type: boolean
Constraints: Read Only, Restart Required
activationTimeThe time when the server was started.
Type: long
Constraints: Read Only, Restart Required
adminServerIndicates whether the server is an Administration Server.
Type: boolean
Constraints: Read Only, Restart Required
adminServerHostThe 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
adminServerListenPortThe port on which the Administration Server is listening for connections.
Type: int
Constraints: Read Only, Restart Required
adminServerListenPortSecureIndicates whether the port that the server uses for administrative traffic is configured to use a secure protocol.
Type: boolean
Constraints: Read Only, Restart Required
![Page 686: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/686.jpg)
weblogic.management.runtime.ServerRuntimeMBean
2-26 RESTful Domain Runtime Reference for Oracle WebLogic Server
administrationPortEnabledIndicates whether the administration port is enabled on the server
Type: boolean
Constraints: Read Only, Restart Required
administrationURLThe 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
currentDirectoryThe 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
currentMachineReturn 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
defaultURLThe 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
healthStateThe 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
![Page 687: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/687.jpg)
weblogic.management.runtime.ServerRuntimeMBean
Entities 2-27
Constraints: Read Only, Restart Required
listenPortEnabledIndicates whether the default listen port is enabled on the server.
Type: boolean
Constraints: Read Only, Restart Required
middlewareHomeThe Oracle Middleware installation directory.
Type: string
Constraints: Read Only, Restart Required
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
openSocketsCurrentCountThe current number of sockets registered for socket muxing on this server.
Type: int
Constraints: Read Only, Restart Required
overallHealthStateDetermine 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
restartRequiredIndicates whether the server must be restarted in order to activate configuration changes.
Type: boolean
Constraints: Read Only, Restart Required
serverClasspathGet 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
stateThe 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
![Page 688: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/688.jpg)
weblogic.management.runtime.ServiceMigrationDataRuntimeMBean
2-28 RESTful Domain Runtime Reference for Oracle WebLogic Server
stateValReturns 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
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogicHomeThe directory where the WebLogic Server instance (server) is installed, without the trailing "/server".
Type: string
Constraints: Read Only, Restart Required
weblogicVersionThe version of this WebLogic Server instance (server).
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.ServiceMigrationDataRuntimeMBeanRuntime information about one past or ongoing migration.
The properties of the weblogic.management.runtime.ServiceMigrationDataRuntimeMBean entity are as follows:
clusterNameName of the cluster
Type: string
Constraints: Read Only, Restart Required
coordinatorNameName of the server that acted as the coordinator for this migration.
Type: string
Constraints: Read Only, Restart Required
destinationsAttemptedGet all the destinations attempted for migration.
Type: array of string
Constraints: Read Only, Restart Required
migratedFromWhere this object was migrated from
Type: string
![Page 689: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/689.jpg)
weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean
Entities 2-29
Constraints: Read Only, Restart Required
migratedToWhere this object was migrated to
Type: string
Constraints: Read Only, Restart Required
migrationEndTimeEnd time of migration
Type: long
Constraints: Read Only, Restart Required
migrationStartTimeStart time of migration
Type: long
Constraints: Read Only, Restart Required
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
serverNameName of the object migrated
Type: string
Constraints: Read Only, Restart Required
statusStatus of the migration (SUCCESSFUL, IN_PROGRESS, or FAILED)
Type: int
Constraints: Read Only, Restart Required
typeReturns 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.
![Page 690: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/690.jpg)
weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean
2-30 RESTful Domain Runtime Reference for Oracle WebLogic Server
The properties of the weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean entity are as follows:
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
nodeManagerRestartCountThe 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
stateThe 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
typeReturns 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:
completedThis property indicates whether an asynchronous job has completed.
Type: boolean
descriptionA description of this task.
Type: string
Constraints: Read Only, Restart Required
![Page 691: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/691.jpg)
weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean
Entities 2-31
endTimeThis property indicates the time when the asynchronous job ended.
Type: java.util.Date
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
operationGets the name of the method that was invoked on the ServerLifeCycleRuntime to initiate this task.
Type: string
Constraints: Read Only, Restart Required
parentTaskThe 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
progressThe progress of this task.
Type: string
Constraints: Read Only, Restart Required
runningIndicates whether the task is still running.
Type: boolean
Constraints: Read Only, Restart Required
serverNameThe name of the server.
Type: string
Constraints: Read Only, Restart Required
startTimeThis property indicates the time when an asynchronous job was started.
Type: java.util.Date
startTimeAsLongThe time at which this task was started.
Type: long
Constraints: Read Only, Restart Required
systemTaskIndicates whether this task was initiated by the server versus a user.
![Page 692: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/692.jpg)
weblogic.management.runtime.TaskRuntimeMBean
2-32 RESTful Domain Runtime Reference for Oracle WebLogic Server
Type: boolean
Constraints: Read Only, Restart Required
taskErrorReturns an exception describing the error, if any, that occurred while performing this task.
Type: java.lang.Throwable
Constraints: Read Only, Restart Required
taskStatusThe status of this task.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.TaskRuntimeMBeanExposes 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:
completedThis property indicates whether an asynchronous job has completed.
Type: boolean
descriptionA description of this task.
Type: string
Constraints: Read Only, Restart Required
endTimeThis property indicates the time when the asynchronous job ended.
Type: java.util.Date
![Page 693: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/693.jpg)
weblogic.management.runtime.TaskRuntimeMBean
Entities 2-33
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
parentTaskThe 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
progressThe progress of this task.
Type: string
Constraints: Read Only, Restart Required
runningIndicates whether the task is still running.
Type: boolean
Constraints: Read Only, Restart Required
startTimeThis property indicates the time when an asynchronous job was started.
Type: java.util.Date
startTimeAsLongThe time at which this task was started.
Type: long
Constraints: Read Only, Restart Required
systemTaskIndicates whether this task was initiated by the server versus a user.
Type: boolean
Constraints: Read Only, Restart Required
taskErrorReturns an exception describing the error, if any, that occurred while performing this task.
Type: java.lang.Throwable
Constraints: Read Only, Restart Required
taskStatusThe status of this task.
Type: string
Constraints: Read Only, Restart Required
![Page 694: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/694.jpg)
weblogic.management.runtime.WorkflowTaskRuntimeMBean
2-34 RESTful Domain Runtime Reference for Oracle WebLogic Server
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
weblogic.management.runtime.WorkflowTaskRuntimeMBeanTaskRuntimeMBean for any workflow (WorkflowProgress) executed using management orchestration framework.
The properties of the weblogic.management.runtime.WorkflowTaskRuntimeMBean entity are as follows:
completedThis property indicates whether an asynchronous job has completed.
Type: boolean
descriptionA description of this task.
Type: string
Constraints: Read Only, Restart Required
endTimeThis property indicates the time when the asynchronous job ended.
Type: java.util.Date
errorsLists all errors in the workflow.
Type: array of java.lang.Throwable
Constraints: Read Only, Restart Required
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
numCompletedCommandsNumber of completed commands in the workflow. Together with {@code getNumTotalCommands()} defines kind of progress information.
Type: int
Constraints: Read Only, Restart Required
numTotalCommandsNumber of all commands in the workflow. Together with {@code getNumCompletedCommands()} defines kind of progress information.
Type: int
Constraints: Read Only, Restart Required
![Page 695: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/695.jpg)
weblogic.management.runtime.WorkflowTaskRuntimeMBean
Entities 2-35
parentTaskThe 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
progressThe progress of this task.
Type: string
Constraints: Read Only, Restart Required
progressStringHuman-readable message containing information about the current workflow progress.
Type: string
Constraints: Read Only, Restart Required
runningIndicates whether the task is still running.
Type: boolean
Constraints: Read Only, Restart Required
startTimeThis property indicates the time when an asynchronous job was started.
Type: java.util.Date
startTimeAsLongThe time at which this task was started.
Type: long
Constraints: Read Only, Restart Required
statusHistoryProvides step by step information (log) about the progress of the workflow.
Type: string
Constraints: Read Only, Restart Required
systemTaskIndicates whether this task was initiated by the server versus a user.
Type: boolean
Constraints: Read Only, Restart Required
taskErrorReturns an exception describing the error, if any, that occurred while performing this task.
Type: java.lang.Throwable
Constraints: Read Only, Restart Required
![Page 696: [1]Oracle® Fusion Middleware RESTful Domain …RESTful Domain Runtime Reference for Oracle WebLogic Server 12c (12.2.1) E64956-02 November 2015 This reference describes the RESTful](https://reader034.vdocuments.net/reader034/viewer/2022042417/5f32d841eee2383e766a57c8/html5/thumbnails/696.jpg)
weblogic.management.runtime.WseePolicySubjectManagerRuntimeMBean
2-36 RESTful Domain Runtime Reference for Oracle WebLogic Server
taskStatusThe status of this task.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
workflowIdEach workflow has a unique id.
Type: string
Constraints: Read Only, Restart Required
workflowNameUser defined name of this workflow.
Type: string
Constraints: Read Only, Restart Required
workflowTargetReturns 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
workflowTypeReturns 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:
nameThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
typeReturns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required