{ "swagger":"2.0", "info":{ "title":"RESTful Domain Runtime Management Interface for Oracle WebLogic Server", "description":"Use this RESTful Management Interface to monitor the entire WLS domain.", "version":"2026.11.07", "x-summary":"Use this RESTful Management Interface to monitor the entire WLS domain." }, "schemes":[ "http", "https" ], "tags":[ { "name":"App Deployment Runtime", "description":"App Deployment Runtime Operations" }, { "name":"App Deployment Runtime/Actions", "description":"App Deployment Runtime Actions" }, { "name":"App Runtime State Runtime", "description":"App Runtime State Runtime Operations" }, { "name":"App Runtime State Runtime/Actions", "description":"App Runtime State Runtime Actions" }, { "name":"Application State", "description":"Application State Operations" }, { "name":"Batch Job Repository Runtime", "description":"Batch Job Repository Runtime Operations" }, { "name":"Certificate Management Domain Runtime", "description":"Certificate Management Domain Runtime Operations" }, { "name":"Certificate Management Domain Runtime/Actions", "description":"Certificate Management Domain Runtime Actions" }, { "name":"Current User", "description":"Current User Operations" }, { "name":"DB Client Data Deployment Runtime", "description":"DB Client Data Deployment Runtime Operations" }, { "name":"DB Client Data Deployment Runtime/Actions", "description":"DB Client Data Deployment Runtime Actions" }, { "name":"Deployment Manager", "description":"Deployment Manager Operations" }, { "name":"Deployment Manager/Actions", "description":"Deployment Manager Actions" }, { "name":"Deployment Progress Object", "description":"Deployment Progress Object Operations" }, { "name":"Deployment Progress Object/Actions", "description":"Deployment Progress Object Actions" }, { "name":"Domain Keystores Domain Runtime", "description":"Domain Keystores Domain Runtime Operations" }, { "name":"Domain Keystores Domain Runtime/Actions", "description":"Domain Keystores Domain Runtime Actions" }, { "name":"Domain Runtime", "description":"Domain Runtime Operations" }, { "name":"Domain Runtime/Actions", "description":"Domain Runtime Actions" }, { "name":"Domain Security Runtime", "description":"Domain Security Runtime Operations" }, { "name":"Domain Security Runtime/Actions", "description":"Domain Security Runtime Actions" }, { "name":"Edit Session Configuration Manager", "description":"Edit Session Configuration Manager Operations" }, { "name":"Edit Session Configuration Manager/Actions", "description":"Edit Session Configuration Manager Actions" }, { "name":"Edit Session Configuration Runtime", "description":"Edit Session Configuration Runtime Operations" }, { "name":"Edit Session Configuration Runtime/Actions", "description":"Edit Session Configuration Runtime Actions" }, { "name":"Elastic Service Manager Runtime", "description":"Elastic Service Manager Runtime Operations" }, { "name":"Elastic Service Manager Runtime/Actions", "description":"Elastic Service Manager Runtime Actions" }, { "name":"Lib Deployment Runtime", "description":"Lib Deployment Runtime Operations" }, { "name":"Lib Deployment Runtime/Actions", "description":"Lib Deployment Runtime Actions" }, { "name":"Log Runtime", "description":"Log Runtime Operations" }, { "name":"Log Runtime/Actions", "description":"Log Runtime Actions" }, { "name":"Message Driven Control EJB Runtime", "description":"Message Driven Control EJB Runtime Operations" }, { "name":"Message Driven Control EJB Runtime/Actions", "description":"Message Driven Control EJB Runtime Actions" }, { "name":"Migratable Service Coordinator Runtime", "description":"Migratable Service Coordinator Runtime Operations" }, { "name":"Migratable Service Coordinator Runtime/Actions", "description":"Migratable Service Coordinator Runtime Actions" }, { "name":"Migration Data Runtime", "description":"Migration Data Runtime Operations" }, { "name":"Migration Task Runtime", "description":"Migration Task Runtime Operations" }, { "name":"Migration Task Runtime/Actions", "description":"Migration Task Runtime Actions" }, { "name":"Node Manager Runtime", "description":"Node Manager Runtime Operations" }, { "name":"Plugin Deployment Runtime", "description":"Plugin Deployment Runtime Operations" }, { "name":"Plugin Deployment Runtime/Actions", "description":"Plugin Deployment Runtime Actions" }, { "name":"Rollout Service Runtime", "description":"Rollout Service Runtime Operations" }, { "name":"Rollout Service Runtime/Actions", "description":"Rollout Service Runtime Actions" }, { "name":"SNMP Agent Runtime", "description":"SNMP Agent Runtime Operations" }, { "name":"SNMP Agent Runtime/Actions", "description":"SNMP Agent Runtime Actions" }, { "name":"Scaling Task Runtime", "description":"Scaling Task Runtime Operations" }, { "name":"Scaling Task Runtime/Actions", "description":"Scaling Task Runtime Actions" }, { "name":"Search", "description":"Search Operations" }, { "name":"Server Life Cycle Runtime", "description":"Server Life Cycle Runtime Operations" }, { "name":"Server Life Cycle Runtime/Actions", "description":"Server Life Cycle Runtime Actions" }, { "name":"Server Life Cycle Task Runtime", "description":"Server Life Cycle Task Runtime Operations" }, { "name":"Server Life Cycle Task Runtime/Actions", "description":"Server Life Cycle Task Runtime Actions" }, { "name":"Server Runtime", "description":"Server Runtime Operations" }, { "name":"Service Migration Data Runtime", "description":"Service Migration Data Runtime Operations" }, { "name":"System Component Life Cycle Runtime", "description":"System Component Life Cycle Runtime Operations" }, { "name":"System Component Life Cycle Runtime/Actions", "description":"System Component Life Cycle Runtime Actions" }, { "name":"System Component Life Cycle Task Runtime", "description":"System Component Life Cycle Task Runtime Operations" }, { "name":"System Component Life Cycle Task Runtime/Actions", "description":"System Component Life Cycle Task Runtime Actions" }, { "name":"Task Runtime/Elastic Service Manager Runtime/Scaling Tasks/Sub Tasks", "description":"[ Elastic Service Manager Runtime / Scaling Tasks / Sub Tasks ] scoped Task Runtime Operations" }, { "name":"Task Runtime/Elastic Service Manager Runtime/Scaling Tasks/Sub Tasks/Actions", "description":"[ Elastic Service Manager Runtime / Scaling Tasks / Sub Tasks ] scoped Task Runtime Actions" }, { "name":"Task Runtime/Elastic Service Manager Runtime/Scaling Tasks/Sub Tasks/Sub Tasks", "description":"[ Elastic Service Manager Runtime / Scaling Tasks / Sub Tasks / Sub Tasks ] scoped Task Runtime Operations" }, { "name":"Task Runtime/Elastic Service Manager Runtime/Scaling Tasks/Sub Tasks/Sub Tasks/Actions", "description":"[ Elastic Service Manager Runtime / Scaling Tasks / Sub Tasks / Sub Tasks ] scoped Task Runtime Actions" }, { "name":"Task Runtime/Migratable Service Coordinator Runtime/Migration Task Runtimes/Sub Tasks", "description":"[ Migratable Service Coordinator Runtime / Migration Task Runtimes / Sub Tasks ] scoped Task Runtime Operations" }, { "name":"Task Runtime/Migratable Service Coordinator Runtime/Migration Task Runtimes/Sub Tasks/Actions", "description":"[ Migratable Service Coordinator Runtime / Migration Task Runtimes / Sub Tasks ] scoped Task Runtime Actions" }, { "name":"Task Runtime/Migratable Service Coordinator Runtime/Migration Task Runtimes/Sub Tasks/Sub Tasks", "description":"[ Migratable Service Coordinator Runtime / Migration Task Runtimes / Sub Tasks / Sub Tasks ] scoped Task Runtime Operations" }, { "name":"Task Runtime/Migratable Service Coordinator Runtime/Migration Task Runtimes/Sub Tasks/Sub Tasks/Actions", "description":"[ Migratable Service Coordinator Runtime / Migration Task Runtimes / Sub Tasks / Sub Tasks ] scoped Task Runtime Actions" }, { "name":"Task Runtime/Rollout Service/All Workflows/Sub Tasks", "description":"[ Rollout Service / All Workflows / Sub Tasks ] scoped Task Runtime Operations" }, { "name":"Task Runtime/Rollout Service/All Workflows/Sub Tasks/Actions", "description":"[ Rollout Service / All Workflows / Sub Tasks ] scoped Task Runtime Actions" }, { "name":"Task Runtime/Rollout Service/All Workflows/Sub Tasks/Sub Tasks", "description":"[ Rollout Service / All Workflows / Sub Tasks / Sub Tasks ] scoped Task Runtime Operations" }, { "name":"Task Runtime/Rollout Service/All Workflows/Sub Tasks/Sub Tasks/Actions", "description":"[ Rollout Service / All Workflows / Sub Tasks / Sub Tasks ] scoped Task Runtime Actions" }, { "name":"Task Runtime/Rollout Service/Inactive Workflows/Sub Tasks", "description":"[ Rollout Service / Inactive Workflows / Sub Tasks ] scoped Task Runtime Operations" }, { "name":"Task Runtime/Rollout Service/Inactive Workflows/Sub Tasks/Actions", "description":"[ Rollout Service / Inactive Workflows / Sub Tasks ] scoped Task Runtime Actions" }, { "name":"Task Runtime/Rollout Service/Inactive Workflows/Sub Tasks/Sub Tasks", "description":"[ Rollout Service / Inactive Workflows / Sub Tasks / Sub Tasks ] scoped Task Runtime Operations" }, { "name":"Task Runtime/Rollout Service/Inactive Workflows/Sub Tasks/Sub Tasks/Actions", "description":"[ Rollout Service / Inactive Workflows / Sub Tasks / Sub Tasks ] scoped Task Runtime Actions" }, { "name":"Task Runtime/Rollout Service/Stopped Workflows/Sub Tasks", "description":"[ Rollout Service / Stopped Workflows / Sub Tasks ] scoped Task Runtime Operations" }, { "name":"Task Runtime/Rollout Service/Stopped Workflows/Sub Tasks/Actions", "description":"[ Rollout Service / Stopped Workflows / Sub Tasks ] scoped Task Runtime Actions" }, { "name":"Task Runtime/Rollout Service/Stopped Workflows/Sub Tasks/Sub Tasks", "description":"[ Rollout Service / Stopped Workflows / Sub Tasks / Sub Tasks ] scoped Task Runtime Operations" }, { "name":"Task Runtime/Rollout Service/Stopped Workflows/Sub Tasks/Sub Tasks/Actions", "description":"[ Rollout Service / Stopped Workflows / Sub Tasks / Sub Tasks ] scoped Task Runtime Actions" }, { "name":"Task Runtime/Server Life Cycle Runtimes/Tasks/Sub Tasks", "description":"[ Server Life Cycle Runtimes / Tasks / Sub Tasks ] scoped Task Runtime Operations" }, { "name":"Task Runtime/Server Life Cycle Runtimes/Tasks/Sub Tasks/Actions", "description":"[ Server Life Cycle Runtimes / Tasks / Sub Tasks ] scoped Task Runtime Actions" }, { "name":"Task Runtime/Server Life Cycle Runtimes/Tasks/Sub Tasks/Sub Tasks", "description":"[ Server Life Cycle Runtimes / Tasks / Sub Tasks / Sub Tasks ] scoped Task Runtime Operations" }, { "name":"Task Runtime/Server Life Cycle Runtimes/Tasks/Sub Tasks/Sub Tasks/Actions", "description":"[ Server Life Cycle Runtimes / Tasks / Sub Tasks / Sub Tasks ] scoped Task Runtime Actions" }, { "name":"Task Runtime/System Component Life Cycle Runtimes/Tasks/Sub Tasks", "description":"[ System Component Life Cycle Runtimes / Tasks / Sub Tasks ] scoped Task Runtime Operations" }, { "name":"Task Runtime/System Component Life Cycle Runtimes/Tasks/Sub Tasks/Actions", "description":"[ System Component Life Cycle Runtimes / Tasks / Sub Tasks ] scoped Task Runtime Actions" }, { "name":"Task Runtime/System Component Life Cycle Runtimes/Tasks/Sub Tasks/Sub Tasks", "description":"[ System Component Life Cycle Runtimes / Tasks / Sub Tasks / Sub Tasks ] scoped Task Runtime Operations" }, { "name":"Task Runtime/System Component Life Cycle Runtimes/Tasks/Sub Tasks/Sub Tasks/Actions", "description":"[ System Component Life Cycle Runtimes / Tasks / Sub Tasks / Sub Tasks ] scoped Task Runtime Actions" }, { "name":"Version", "description":"Version Operations" }, { "name":"Workflow Task Runtime/Rollout Service/All Workflows", "description":"[ Rollout Service / All Workflows ] scoped Workflow Task Runtime Operations" }, { "name":"Workflow Task Runtime/Rollout Service/All Workflows/Actions", "description":"[ Rollout Service / All Workflows ] scoped Workflow Task Runtime Actions" }, { "name":"Workflow Task Runtime/Rollout Service/Inactive Workflows", "description":"[ Rollout Service / Inactive Workflows ] scoped Workflow Task Runtime Operations" }, { "name":"Workflow Task Runtime/Rollout Service/Inactive Workflows/Actions", "description":"[ Rollout Service / Inactive Workflows ] scoped Workflow Task Runtime Actions" }, { "name":"Workflow Task Runtime/Rollout Service/Stopped Workflows", "description":"[ Rollout Service / Stopped Workflows ] scoped Workflow Task Runtime Operations" }, { "name":"Workflow Task Runtime/Rollout Service/Stopped Workflows/Actions", "description":"[ Rollout Service / Stopped Workflows ] scoped Workflow Task Runtime Actions" }, { "name":"Wsee Policy Subject Manager Runtime", "description":"Wsee Policy Subject Manager Runtime Operations" }, { "name":"Wsee Policy Subject Manager Runtime/Actions", "description":"Wsee Policy Subject Manager Runtime Actions" } ], "parameters":{ "Path Parameter name":{ "name":"name", "type":"string", "description":"The name property of the instance in the collection.", "required":true, "in":"path" }, "Path Parameter version":{ "name":"version", "type":"string", "description":"The version of the WebLogic REST interface.", "required":true, "in":"path" }, "Query Parameter excludeFields":{ "name":"excludeFields", "type":"string", "description":"The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.", "required":false, "in":"query" }, "Query Parameter excludeLinks":{ "name":"excludeLinks", "type":"string", "description":"The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.", "required":false, "in":"query" }, "Query Parameter fields":{ "name":"fields", "type":"string", "description":"The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.", "required":false, "in":"query" }, "Query Parameter links":{ "name":"links", "type":"string", "description":"The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.", "required":false, "in":"query" }, "Request Header Prefer":{ "name":"Prefer", "type":"string", "description":"The 'Prefer' header parameter can be used to specify the preference on how this method runs. A value of 'respond-async' specifies a preference to submit the request and return immediately without waiting for completion. Alternatively a value of 'wait=#seconds' specifies a preference to wait for #seconds for method completion before returning. If the Prefer header is not specified or invalid, then a 300 second wait will be used. ", "required":false, "in":"header" }, "Request Header X-Requested-By":{ "name":"X-Requested-By", "type":"string", "description":"The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.", "required":true, "in":"header" } }, "paths":{ "/management/weblogic":{ "get":{ "tags":[ "Version" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Version Collection", "operationId":"/management/weblogic GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Version" }, "description":"" }, "x-weblogic-links":[ { "relationship":"current", "uri":"/management/weblogic/26.1.0.0.0", "description":"

Access the latest version of the WLS resources in the this domain.

" } ], "description":"

Returns a list of version entities.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

Views the different versions of the resources in this domain.

The latest version is 26.1.0.0.0. The other versions, which are deprecated, are 12.2.1.0.0, 12.2.1.1.0, 12.2.1.2.0, 12.2.1.3.0, 12.2.1.4.0, 12.2.1.5.0, 12.2.1.6.0, 14.1.1.0.0, 14.1.2.0.0, 15.1.1.0.0.

For future releases, latest always refers to the most recent release.

All new and non-deprecated MBean features are available in all versions. Any MBean features that were deprecated in a version will not be available in that version or later versions, but will still be available using earlier versions.

To always use the latest resources, 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 a specific version, e.g. 26.1.0.0.0, in the URLs.

View the versions collection.

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

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-X GET http://localhost:7001/management/weblogic
Example Response
HTTP/1.1 200 OK\n\nResponse Body:\n{\n    \"links\": [\n        {\n            \"rel\": \"self\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic\"\n        },\n        {\n            \"rel\": \"canonical\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic\"\n        },\n        {\n            \"rel\": \"current\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/15.1.1.0.0\"\n        }\n    ],\n    \"items\": [\n        {\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.0.0\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.0.0\"\n                }\n            ],\n            \"version\": \"12.2.1.0.0\",\n            \"isLatest\": false,\n            \"lifecycle\": \"deprecated\"\n        },\n        {\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.1.0\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.1.0\"\n                }\n            ],\n            \"version\": \"12.2.1.1.0\",\n            \"isLatest\": false,\n            \"lifecycle\": \"deprecated\"\n        },\n        {\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.2.0\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.2.0\"\n                }\n            ],\n            \"version\": \"12.2.1.2.0\",\n            \"isLatest\": false,\n            \"lifecycle\": \"deprecated\"\n        },\n        {\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.3.0\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.3.0\"\n                }\n            ],\n            \"version\": \"12.2.1.3.0\",\n            \"isLatest\": false,\n            \"lifecycle\": \"deprecated\"\n        },\n        {\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.4.0\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.4.0\"\n                }\n            ],\n            \"version\": \"12.2.1.4.0\",\n            \"isLatest\": false,\n            \"lifecycle\": \"deprecated\"\n        },\n        {\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.5.0\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.5.0\"\n                }\n            ],\n            \"version\": \"12.2.1.5.0\",\n            \"isLatest\": false,\n            \"lifecycle\": \"deprecated\"\n        },\n        {\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.6.0\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.6.0\"\n                }\n            ],\n            \"version\": \"12.2.1.6.0\",\n            \"isLatest\": false,\n            \"lifecycle\": \"deprecated\"\n        },\n        {\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/14.1.1.0.0\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/14.1.1.0.0\"\n                }\n            ],\n            \"version\": \"14.1.1.0.0\",\n            \"isLatest\": false,\n            \"lifecycle\": \"deprecated\"\n        },\n        {\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/14.1.2.0.0\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/14.1.2.0.0\"\n                }\n            ],\n            \"version\": \"14.1.2.0.0\",\n            \"isLatest\": false,\n            \"lifecycle\": \"deprecated\"\n        },\n        {\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/15.1.1.0.0\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http:\\//localhost:7001/management/weblogic/15.1.1.0.0\"\n                }\n            ],\n            \"version\": \"15.1.1.0.0\",\n            \"isLatest\": true,\n            \"lifecycle\": \"active\"\n        }\n    ]\n}
", "x-internal-id":"management-weblogic-get", "x-filename-id":"management-weblogic-get" } }, "/management/weblogic/{version}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Version" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Version", "operationId":"/management/weblogic/{version} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Version" }, "x-weblogic-links":[ { "relationship":"currentUser", "uri":"/management/weblogic/{version}/currentUser", "description":"" }, { "relationship":"domainConfig", "uri":"/management/weblogic/{version}/domainConfig", "description":"" }, { "relationship":"domainRuntime", "uri":"/management/weblogic/{version}/domainRuntime", "description":"" }, { "relationship":"edit", "uri":"/management/weblogic/{version}/edit", "description":"" }, { "relationship":"serverConfig", "uri":"/management/weblogic/{version}/serverConfig", "description":"" }, { "relationship":"serverRuntime", "uri":"/management/weblogic/{version}/serverRuntime", "description":"" } ], "description":"

Returns this version.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this version.

Note: It also returns links to the resource trees that are used to manage this WebLogic Server domain and its managed servers. The resource trees mimic the bean trees in WLST and allow you to view and edit the configuration and monitor the runtime behavior.

View the latest version.

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

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-X GET http://localhost:7001/management/weblogic/latest
Example Response
HTTP/1.1 200 OK\n\nResponse Body:\n{\n    \"links\": [\n        {\n            \"rel\": \"parent\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic\"\n        },\n        {\n            \"rel\": \"self\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/latest\"\n        },\n        {\n            \"rel\": \"canonical\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/latest\"\n        },\n        {\n            \"rel\": \"edit\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/latest/edit\"\n        },\n        {\n            \"rel\": \"domainConfig\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainConfig\"\n        },\n        {\n            \"rel\": \"domainRuntime\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime\"\n        },\n        {\n            \"rel\": \"serverRuntime\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/latest/serverRuntime\"\n        },\n        {\n            \"rel\": \"serverConfig\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/latest/serverConfig\"\n        },\n        {\n            \"rel\": \"currentUser\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/latest/currentUser\"\n        }\n    ],\n    \"version\": \"15.1.1.0.0\",\n    \"isLatest\": true,\n    \"lifecycle\": \"active\"\n}

View a specific version.

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

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-X GET http://localhost:7001/management/weblogic/12.2.1.3.0
Example Response
HTTP/1.1 200 OK\n\nResponse Body:\n{\n    \"links\": [\n        {\n            \"rel\": \"parent\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic\"\n        },\n        {\n            \"rel\": \"self\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.3.0\"\n        },\n        {\n            \"rel\": \"canonical\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.3.0\"\n        },\n        {\n            \"rel\": \"edit\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.3.0/edit\"\n        },\n        {\n            \"rel\": \"domainConfig\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.3.0/domainConfig\"\n        },\n        {\n            \"rel\": \"domainRuntime\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.3.0/domainRuntime\"\n        },\n        {\n            \"rel\": \"serverRuntime\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.3.0/serverRuntime\"\n        },\n        {\n            \"rel\": \"serverConfig\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.3.0/serverConfig\"\n        },\n        {\n            \"rel\": \"currentUser\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/12.2.1.3.0/currentUser\"\n        }\n    ],\n    \"version\": \"12.2.1.3.0\",\n    \"isLatest\": false,\n    \"lifecycle\": \"deprecated\"\n}
", "x-internal-id":"management-weblogic-{version}-get", "x-filename-id":"management-weblogic-version-get" } }, "/management/weblogic/{version}/currentUser":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Current User" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Current User", "operationId":"/management/weblogic/{version}/currentUser GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Current User" }, "description":"

Returns this current user.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this current user.

View this current user.

This example uses the GET method to view this current user.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-X GET http://localhost:7001/management/weblogic/latest/currentUser
Example Response
HTTP/1.1 200 OK\n\nResponse Body:\n{\n    \"links\": [\n        {\n            \"rel\": \"parent\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/latest\"\n        },\n        {\n            \"rel\": \"self\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/latest/currentUser\"\n        },\n        {\n            \"rel\": \"canonical\",\n            \"href\": \"http:\\//localhost:7001/management/weblogic/latest/currentUser\"\n        }\n    ],\n    \"user\": \"admin\"\n}
", "x-internal-id":"management-weblogic-{version}-currentUser-get", "x-filename-id":"management-weblogic-version-currentuser-get" } }, "/management/weblogic/{version}/domainRuntime":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Domain Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Domain Runtime", "operationId":"/management/weblogic/{version}/domainRuntime GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Domain Runtime" }, "x-weblogic-links":[ { "relationship":"SNMPAgentRuntime", "uri":"/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime", "description":"

This resource's SNMPAgentRuntime singleton resource.

" }, { "relationship":"action", "title":"restartSystemResource", "uri":"/management/weblogic/{version}/domainRuntime/restartSystemResource", "description":"

This resource's restartSystemResource action resource.

" }, { "relationship":"appRuntimeStateRuntime", "uri":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime", "description":"

This resource's appRuntimeStateRuntime singleton resource.

" }, { "relationship":"batchJobRepositoryRuntime", "uri":"/management/weblogic/{version}/domainRuntime/batchJobRepositoryRuntime", "description":"

This resource's batchJobRepositoryRuntime singleton resource.

" }, { "relationship":"certificateManagementRuntime", "uri":"/management/weblogic/{version}/domainRuntime/certificateManagementRuntime", "description":"

This resource's certificateManagementRuntime singleton resource.

" }, { "relationship":"deploymentManager", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager", "description":"

This resource's deploymentManager singleton resource.

" }, { "relationship":"domainKeystoresRuntime", "uri":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime", "description":"

This resource's domainKeystoresRuntime singleton resource.

" }, { "relationship":"domainSecurityRuntime", "uri":"/management/weblogic/{version}/domainRuntime/domainSecurityRuntime", "description":"

This resource's domainSecurityRuntime singleton resource.

" }, { "relationship":"editSessionConfigurationManager", "uri":"/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager", "description":"

This resource's editSessionConfigurationManager singleton resource.

" }, { "relationship":"elasticServiceManagerRuntime", "uri":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime", "description":"

This resource's elasticServiceManagerRuntime singleton resource.

" }, { "relationship":"logRuntime", "uri":"/management/weblogic/{version}/domainRuntime/logRuntime", "description":"

This resource's logRuntime singleton resource.

" }, { "relationship":"messageDrivenControlEJBRuntime", "uri":"/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime", "description":"

This resource's messageDrivenControlEJBRuntime singleton resource.

" }, { "relationship":"migratableServiceCoordinatorRuntime", "uri":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime", "description":"

This resource's migratableServiceCoordinatorRuntime singleton resource.

" }, { "relationship":"migrationDataRuntimes", "uri":"/management/weblogic/{version}/domainRuntime/migrationDataRuntimes", "description":"

This resource's migrationDataRuntimes collection resource.

" }, { "relationship":"nodeManagerRuntimes", "uri":"/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes", "description":"

This resource's nodeManagerRuntimes collection resource.

" }, { "relationship":"policySubjectManagerRuntime", "uri":"/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime", "description":"

This resource's policySubjectManagerRuntime singleton resource.

" }, { "relationship":"rolloutService", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService", "description":"

This resource's rolloutService singleton resource.

" }, { "relationship":"search", "uri":"/management/weblogic/{version}/domainRuntime/search", "description":"

This resource's search resource.

" }, { "relationship":"serverLifeCycleRuntimes", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes", "description":"

This resource's serverLifeCycleRuntimes collection resource.

" }, { "relationship":"serverRuntimes", "uri":"/management/weblogic/{version}/domainRuntime/serverRuntimes", "description":"

This resource's serverRuntimes resource.

" }, { "relationship":"serviceMigrationDataRuntimes", "uri":"/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes", "description":"

This resource's serviceMigrationDataRuntimes collection resource.

" }, { "relationship":"systemComponentLifeCycleRuntimes", "uri":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes", "description":"

This resource's systemComponentLifeCycleRuntimes collection resource.

" } ], "description":"

Returns this domain runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this domain runtime.

Note: This tree of resources is used to monitor the entire WebLogic Server domain.

View this domain runtime.

This example uses the GET method to view this domain runtime.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-X GET http://localhost:7001/management/weblogic/latest/domainRuntime?fields=activationTime&links=self
Example Response
HTTP/1.1 200 OK\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"self\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime\"\n    }],\n    \"activationTime\": \"2025-09-12T15:37:42.417-04:00\"\n}
", "x-internal-id":"management-weblogic-{version}-domainRuntime-get", "x-filename-id":"management-weblogic-version-domainruntime-get" } }, "/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "SNMP Agent Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This SNMP Agent Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/SNMP Agent Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"invalidateLocalizedKeyCache", "uri":"/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/invalidateLocalizedKeyCache", "description":"

This resource's invalidateLocalizedKeyCache action resource.

" }, { "relationship":"action", "title":"outputCustomMBeansMIBModule", "uri":"/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/outputCustomMBeansMIBModule", "description":"

This resource's outputCustomMBeansMIBModule action resource.

" } ], "description":"

Returns this SNMP agent runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this SNMP agent runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-SNMPAgentRuntime-get", "x-filename-id":"management-weblogic-version-domainruntime-snmpagentruntime-get" } }, "/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/invalidateLocalizedKeyCache":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "SNMP Agent Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Invalidate Localized Key Cache", "operationId":"/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/invalidateLocalizedKeyCache POST-username", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "username":{ "type":"string", "description":"

Name of the user

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-SNMPAgentRuntime-invalidateLocalizedKeyCache-post", "x-filename-id":"management-weblogic-version-domainruntime-snmpagentruntime-invalidatelocalizedkeycache-post" } }, "/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/outputCustomMBeansMIBModule":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "SNMP Agent Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Output Custom MBeans MIB Module", "operationId":"/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/outputCustomMBeansMIBModule POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-SNMPAgentRuntime-outputCustomMBeansMIBModule-post", "x-filename-id":"management-weblogic-version-domainruntime-snmpagentruntime-outputcustommbeansmibmodule-post" } }, "/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "App Runtime State Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This App Runtime State Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/App Runtime State Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"getCurrentState", "uri":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getCurrentState", "description":"

This resource's getCurrentState action resource.

" }, { "relationship":"action", "title":"getIntendedState", "uri":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getIntendedState", "description":"

This resource's getIntendedState action resource.

" }, { "relationship":"action", "title":"getModuleIds", "uri":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleIds", "description":"

This resource's getModuleIds action resource.

" }, { "relationship":"action", "title":"getModuleTargets", "uri":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleTargets", "description":"

This resource's getModuleTargets action resource.

" }, { "relationship":"action", "title":"getModuleType", "uri":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleType", "description":"

This resource's getModuleType action resource.

" }, { "relationship":"action", "title":"getMultiVersionStateOnDemand", "uri":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getMultiVersionStateOnDemand", "description":"

This resource's getMultiVersionStateOnDemand action resource.

" }, { "relationship":"action", "title":"getRetireTimeMillis", "uri":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeMillis", "description":"

This resource's getRetireTimeMillis action resource.

" }, { "relationship":"action", "title":"getRetireTimeoutSeconds", "uri":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeoutSeconds", "description":"

This resource's getRetireTimeoutSeconds action resource.

" }, { "relationship":"action", "title":"getSubmoduleIds", "uri":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getSubmoduleIds", "description":"

This resource's getSubmoduleIds action resource.

" }, { "relationship":"action", "title":"isActiveVersion", "uri":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isActiveVersion", "description":"

This resource's isActiveVersion action resource.

" }, { "relationship":"action", "title":"isAdminMode", "uri":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isAdminMode", "description":"

This resource's isAdminMode action resource.

" }, { "relationship":"applications", "uri":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/applications", "description":"

This resource's applications resource.

" } ], "description":"

Returns this app runtime state runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this app runtime state runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-get", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-get" } }, "/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/applications":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Application State" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Application State Collection", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/applications GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Application State" }, "description":"" }, "description":"

Returns a list of application state entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this application state collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-applications-get", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-applications-get" } }, "/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/applications/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Application State" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Application State", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/applications/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Application State" }, "description":"

Returns this application state.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this application state.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-applications-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-applications-name-get" } }, "/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getCurrentState":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "App Runtime State Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"Get Current State ( Appid, Target )", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getCurrentState POST-appid-target", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "appid":{ "type":"string", "description":"" }, "target":{ "type":"string", "description":"

logical target where the app is deployed

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getCurrentState-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getcurrentstate-x-operations-0" }, { "tags":[ "App Runtime State Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"Get Current State ( Appid, Moduleid, Target )", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getCurrentState POST-appid-moduleid-target", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "appid":{ "type":"string", "description":"" }, "moduleid":{ "type":"string", "description":"" }, "target":{ "type":"string", "description":"

logical target where module is deployed

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getCurrentState-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getcurrentstate-x-operations-1" }, { "tags":[ "App Runtime State Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"Get Current State ( Appid, Moduleid, Sub Module Id, Target )", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getCurrentState POST-appid-moduleid-subModuleId-target", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "appid":{ "type":"string", "description":"" }, "moduleid":{ "type":"string", "description":"" }, "subModuleId":{ "type":"string", "description":"" }, "target":{ "type":"string", "description":"

logical target where module is deployed

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getCurrentState-post-x-operations-2", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getcurrentstate-x-operations-2" } ], "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getCurrentState post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getCurrentState-post", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getcurrentstate-post" } }, "/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getIntendedState":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "App Runtime State Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"Get Intended State ( Appid )", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getIntendedState POST-appid", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "appid":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

The state the application should be in.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getIntendedState-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getintendedstate-x-operations-0" }, { "tags":[ "App Runtime State Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"Get Intended State ( Appid, Target )", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getIntendedState POST-appid-target", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "appid":{ "type":"string", "description":"" }, "target":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getIntendedState-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getintendedstate-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getIntendedState post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getIntendedState-post", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getintendedstate-post" } }, "/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleIds":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "App Runtime State Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Get Module Ids", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleIds POST-appid", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "appid":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getModuleIds-post", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getmoduleids-post" } }, "/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleTargets":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "App Runtime State Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"Get Module Targets ( Appid, Moduleid, Sub Module Id )", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleTargets POST-appid-moduleid-subModuleId", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "appid":{ "type":"string", "description":"" }, "moduleid":{ "type":"string", "description":"" }, "subModuleId":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Logical targets where the submodule is deployed.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getModuleTargets-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getmoduletargets-x-operations-0" }, { "tags":[ "App Runtime State Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"Get Module Targets ( Appid, Moduleid )", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleTargets POST-appid-moduleid", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "appid":{ "type":"string", "description":"" }, "moduleid":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Logical targets where the module is deployed.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getModuleTargets-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getmoduletargets-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleTargets post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getModuleTargets-post", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getmoduletargets-post" } }, "/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleType":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "App Runtime State Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"Get Module Type", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleType POST-appid-moduleid", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "appid":{ "type":"string", "description":"" }, "moduleid":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getModuleType-post", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getmoduletype-post" } }, "/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getMultiVersionStateOnDemand":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "App Runtime State Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"Get Multi Version State On Demand", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getMultiVersionStateOnDemand POST-configuredIds-timeout", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "configuredIds":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

A list of application ids or library's deployment ids as configured in config.xml. This is the list for which state is being requested

" }, "timeout":{ "type":"integer", "format":"int64", "description":"

amount of time in milliseconds before the command times out. Though not recommended, a value of 0 may be used to wait indefinitely

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

For each configured ids provided, identify all inferred ids on each of managed server to which the configured ids are targeted.

Admin Server contacts all relevant servers identified by target on demand. Some of the managed servers might be slow in responding or may not respond at all. The use of timeout ensures an upper limit on the time Admin Server will wait for response from managed servers. Though not recommended, a value of 0 timeout may be used to indefinitely wait for response from all managed servers. Admin Server only contacts the managed server that are known to be running at this time.

This result also includes servers that did not respond. But it does not include servers that were known to be shutdown at the time of request and were never contacted.

Here is an example result:

({\"landscapedesign#V2.0\", \"soilmanagement\"}, 100L) ms5 ms10 ms1 ms2 ms3 ms4 ms1 ms2 ms3 ms4 ms6 ms7 ms8 ms9

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getMultiVersionStateOnDemand-post", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getmultiversionstateondemand-post" } }, "/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeMillis":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "App Runtime State Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"Get Retire Time Millis", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeMillis POST-appid", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"integer", "format":"int64", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "appid":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

The time when the application will be retired.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getRetireTimeMillis-post", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getretiretimemillis-post" } }, "/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeoutSeconds":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "App Runtime State Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"Get Retire Timeout Seconds", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeoutSeconds POST-appid", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"integer", "format":"int32", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "appid":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

The amount of time the application is given to retire.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getRetireTimeoutSeconds-post", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getretiretimeoutseconds-post" } }, "/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getSubmoduleIds":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "App Runtime State Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"Get Submodule Ids", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getSubmoduleIds POST-appid-moduleid", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "appid":{ "type":"string", "description":"" }, "moduleid":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Submodules associated with this module.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-getSubmoduleIds-post", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-getsubmoduleids-post" } }, "/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isActiveVersion":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "App Runtime State Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"Is Active Version", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isActiveVersion POST-appid", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"boolean", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "appid":{ "type":"string", "description":"

is the application id

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-isActiveVersion-post", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-isactiveversion-post" } }, "/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isAdminMode":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "App Runtime State Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"Is Admin Mode", "operationId":"/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isAdminMode POST-appid-target", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"boolean", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "appid":{ "type":"string", "description":"

is the application id

" }, "target":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-appRuntimeStateRuntime-isAdminMode-post", "x-filename-id":"management-weblogic-version-domainruntime-appruntimestateruntime-isadminmode-post" } }, "/management/weblogic/{version}/domainRuntime/batchJobRepositoryRuntime":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Batch Job Repository Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Batch Job Repository Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/batchJobRepositoryRuntime GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Batch Job Repository Runtime" }, "description":"

Returns this batch job repository runtime.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this batch job repository runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-batchJobRepositoryRuntime-get", "x-filename-id":"management-weblogic-version-domainruntime-batchjobrepositoryruntime-get" } }, "/management/weblogic/{version}/domainRuntime/certificateManagementRuntime":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Certificate Management Domain Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Certificate Management Domain Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/certificateManagementRuntime GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Certificate Management Domain Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"purgeExpiredCertificateAuthorities", "uri":"/management/weblogic/{version}/domainRuntime/certificateManagementRuntime/purgeExpiredCertificateAuthorities", "description":"

This resource's purgeExpiredCertificateAuthorities action resource.

" }, { "relationship":"action", "title":"refreshServerCertificateAllServers", "uri":"/management/weblogic/{version}/domainRuntime/certificateManagementRuntime/refreshServerCertificateAllServers", "description":"

This resource's refreshServerCertificateAllServers action resource.

" }, { "relationship":"action", "title":"refreshServerTrustAllServers", "uri":"/management/weblogic/{version}/domainRuntime/certificateManagementRuntime/refreshServerTrustAllServers", "description":"

This resource's refreshServerTrustAllServers action resource.

" }, { "relationship":"action", "title":"removeCertificateAuthority", "uri":"/management/weblogic/{version}/domainRuntime/certificateManagementRuntime/removeCertificateAuthority", "description":"

This resource's removeCertificateAuthority action resource.

" }, { "relationship":"action", "title":"rollDomainCertificateAuthority", "uri":"/management/weblogic/{version}/domainRuntime/certificateManagementRuntime/rollDomainCertificateAuthority", "description":"

This resource's rollDomainCertificateAuthority action resource.

" } ], "description":"

Returns this certificate management domain runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this certificate management domain runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-certificateManagementRuntime-get", "x-filename-id":"management-weblogic-version-domainruntime-certificatemanagementruntime-get" } }, "/management/weblogic/{version}/domainRuntime/certificateManagementRuntime/purgeExpiredCertificateAuthorities":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Certificate Management Domain Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Purge Expired Certificate Authorities", "operationId":"/management/weblogic/{version}/domainRuntime/certificateManagementRuntime/purgeExpiredCertificateAuthorities POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Removes expired Certificate Authorities from the Admin Server's domain-trust and provisioned-trust source stores. This operation ignores the configured automatic cleanup retention period.

After a durable source deletion, this operation refreshes server and machine trust replicas. A refresh failure is reported after both refresh paths have been attempted; the source deletion is not rolled back.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-certificateManagementRuntime-purgeExpiredCertificateAuthorities-post", "x-filename-id":"management-weblogic-version-domainruntime-certificatemanagementruntime-purgeexpiredcertificateauthorities-post" } }, "/management/weblogic/{version}/domainRuntime/certificateManagementRuntime/refreshServerCertificateAllServers":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Certificate Management Domain Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Refresh Server Certificate All Servers", "operationId":"/management/weblogic/{version}/domainRuntime/certificateManagementRuntime/refreshServerCertificateAllServers POST-alias-isActiveOnly-isForceUpdate", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "alias":{ "type":"string", "description":"

The alias of the certificate to refresh. Aliases are case-insensitive.

" }, "isActiveOnly":{ "type":"boolean", "description":"

If true, the certificate will only be refreshed if the alias is in use by an enabled channel or service, or is a built-in Domain PKI alias. If false, any valid alias may be refreshed, including an alias not yet configured for a server. This permits certificate pre-provisioning before a channel or service is enabled.

" }, "isForceUpdate":{ "type":"boolean", "description":"

If true, force the certificate to be updated even if it is already present and valid. Normally, certificates are only updated if they are missing or invalid (expired).

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Refresh the certificate for alias alias on all servers. The authenticated WebLogic caller's identity is delegated to each Managed Server and, when required, to the Admin Server certificate service.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-certificateManagementRuntime-refreshServerCertificateAllServers-post", "x-filename-id":"management-weblogic-version-domainruntime-certificatemanagementruntime-refreshservercertificateallservers-post" } }, "/management/weblogic/{version}/domainRuntime/certificateManagementRuntime/refreshServerTrustAllServers":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Certificate Management Domain Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Refresh Server Trust All Servers", "operationId":"/management/weblogic/{version}/domainRuntime/certificateManagementRuntime/refreshServerTrustAllServers POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Refresh domain trust on all the managed servers.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-certificateManagementRuntime-refreshServerTrustAllServers-post", "x-filename-id":"management-weblogic-version-domainruntime-certificatemanagementruntime-refreshservertrustallservers-post" } }, "/management/weblogic/{version}/domainRuntime/certificateManagementRuntime/removeCertificateAuthority":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Certificate Management Domain Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Remove Certificate Authority", "operationId":"/management/weblogic/{version}/domainRuntime/certificateManagementRuntime/removeCertificateAuthority POST-sourceStore-alias", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "alias":{ "type":"string", "description":"

the Certificate Authority alias; aliases are case-insensitive

" }, "sourceStore":{ "type":"string", "description":"

the source trust store: domain-trust or provisioned-trust

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Removes a selected Certificate Authority from an Admin Server source trust store.

The sourceStore value must be domain-trust or provisioned-trust. After a durable source deletion, this operation refreshes server and machine trust replicas. A refresh failure is reported after both refresh paths have been attempted; the source deletion is not rolled back.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-certificateManagementRuntime-removeCertificateAuthority-post", "x-filename-id":"management-weblogic-version-domainruntime-certificatemanagementruntime-removecertificateauthority-post" } }, "/management/weblogic/{version}/domainRuntime/certificateManagementRuntime/rollDomainCertificateAuthority":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Certificate Management Domain Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Roll Domain Certificate Authority", "operationId":"/management/weblogic/{version}/domainRuntime/certificateManagementRuntime/rollDomainCertificateAuthority POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Generate a new self-signed CA certificate for the domain and refresh the trust stores for servers and machines.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-certificateManagementRuntime-rollDomainCertificateAuthority-post", "x-filename-id":"management-weblogic-version-domainruntime-certificatemanagementruntime-rolldomaincertificateauthority-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Deployment Manager" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Deployment Manager", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Deployment Manager" }, "x-weblogic-links":[ { "relationship":"DBClientDataDeploymentRuntimes", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes", "description":"

This resource's DBClientDataDeploymentRuntimes collection resource.

" }, { "relationship":"action", "title":"appendToExtensionLoader", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/appendToExtensionLoader", "description":"

This resource's appendToExtensionLoader action resource.

" }, { "relationship":"action", "title":"confirmApplicationName", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/confirmApplicationName", "description":"

This resource's confirmApplicationName action resource.

" }, { "relationship":"action", "title":"deploy", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/deploy", "description":"

This resource's deploy action resource.

" }, { "relationship":"action", "title":"distribute", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/distribute", "description":"

This resource's distribute action resource.

" }, { "relationship":"action", "title":"purgeCompletedDeploymentProgressObjects", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/purgeCompletedDeploymentProgressObjects", "description":"

This resource's purgeCompletedDeploymentProgressObjects action resource.

" }, { "relationship":"action", "title":"redeploy", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/redeploy", "description":"

This resource's redeploy action resource.

" }, { "relationship":"action", "title":"undeploy", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/undeploy", "description":"

This resource's undeploy action resource.

" }, { "relationship":"action", "title":"update", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/update", "description":"

This resource's update action resource.

" }, { "relationship":"appDeploymentRuntimes", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes", "description":"

This resource's appDeploymentRuntimes collection resource.

" }, { "relationship":"deploymentProgressObjects", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects", "description":"

This resource's deploymentProgressObjects collection resource.

" }, { "relationship":"libDeploymentRuntimes", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes", "description":"

This resource's libDeploymentRuntimes collection resource.

" }, { "relationship":"pluginDeploymentRuntimes", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/pluginDeploymentRuntimes", "description":"

This resource's pluginDeploymentRuntimes collection resource.

" } ], "description":"

Returns this deployment manager.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this deployment manager.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-get", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-get" }, "post":{ "tags":[ "Deployment Manager" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Modify This Deployment Manager", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager POST", "responses":{ "200":{ "description":"" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "$ref":"#/definitions/Deployment Manager" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the modified deployment manager model.

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Modify this deployment manager.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "DB Client Data Deployment Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This DB Client Data Deployment Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/DB Client Data Deployment Runtime" }, "description":"" }, "description":"

Returns a list of DB client data deployment runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this DB client data deployment runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-DBClientDataDeploymentRuntimes-get", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-dbclientdatadeploymentruntimes-get" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "DB Client Data Deployment Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This DB Client Data Deployment Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/DB Client Data Deployment Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"redeploy", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes/{name}/redeploy", "description":"

This resource's redeploy action resource.

" }, { "relationship":"action", "title":"undeploy", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes/{name}/undeploy", "description":"

This resource's undeploy action resource.

" } ], "description":"

Returns this DB client data deployment runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this DB client data deployment runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-DBClientDataDeploymentRuntimes-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-dbclientdatadeploymentruntimes-name-get" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes/{name}/redeploy":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "DB Client Data Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Redeploy ( Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes/{name}/redeploy POST-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Redeploy the DBClientData in the background for all servers in the domain 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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-DBClientDataDeploymentRuntimes-{name}-redeploy-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-dbclientdatadeploymentruntimes-name-redeploy-x-operations-0" }, { "tags":[ "DB Client Data Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Redeploy ( Application Path, Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes/{name}/redeploy POST-applicationPath-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "applicationPath":{ "type":"string", "description":"

A DBClientData module archive, or a root diectory for the module. May be null.

" }, "deploymentOptions":{ "type":"object", "description":"

Allows for overriding the deployment options. If null, default options will be used.

", "additionalProperties":{ "type":"string" }, "title":"Properties" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Redeploy the DBClientData in the background for all servers in the domain 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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-DBClientDataDeploymentRuntimes-{name}-redeploy-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-dbclientdatadeploymentruntimes-name-redeploy-x-operations-1" }, { "tags":[ "DB Client Data Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Redeploy ()", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes/{name}/redeploy POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Redeploy the DBClientData 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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-DBClientDataDeploymentRuntimes-{name}-redeploy-post-x-operations-2", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-dbclientdatadeploymentruntimes-name-redeploy-x-operations-2" } ], "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes/{name}/redeploy post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-DBClientDataDeploymentRuntimes-{name}-redeploy-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-dbclientdatadeploymentruntimes-name-redeploy-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes/{name}/undeploy":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "DB Client Data Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Undeploy ()", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes/{name}/undeploy POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Undeploy the DBClientData 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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-DBClientDataDeploymentRuntimes-{name}-undeploy-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-dbclientdatadeploymentruntimes-name-undeploy-x-operations-0" }, { "tags":[ "DB Client Data Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Undeploy ( Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes/{name}/undeploy POST-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Undeploy the DBClientData in the background for all servers in the domain 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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-DBClientDataDeploymentRuntimes-{name}-undeploy-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-dbclientdatadeploymentruntimes-name-undeploy-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/DBClientDataDeploymentRuntimes/{name}/undeploy post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-DBClientDataDeploymentRuntimes-{name}-undeploy-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-dbclientdatadeploymentruntimes-name-undeploy-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "App Deployment Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This App Deployment Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/App Deployment Runtime" }, "description":"" }, "description":"

Returns a list of app deployment runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this app deployment runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-get", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-get" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "App Deployment Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This App Deployment Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/App Deployment Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"getState", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/getState", "description":"

This resource's getState action resource.

" }, { "relationship":"action", "title":"redeploy", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/redeploy", "description":"

This resource's redeploy action resource.

" }, { "relationship":"action", "title":"start", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/start", "description":"

This resource's start action resource.

" }, { "relationship":"action", "title":"stop", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/stop", "description":"

This resource's stop action resource.

" }, { "relationship":"action", "title":"undeploy", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/undeploy", "description":"

This resource's undeploy action resource.

" }, { "relationship":"action", "title":"update", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/update", "description":"

This resource's update action resource.

" } ], "description":"

Returns this app deployment runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this app deployment runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-get" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/getState":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "App Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Operator":[ ] } ], "summary":"Get State", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/getState POST-target", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "target":{ "type":"string", "description":"

the target for the application state

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-getState-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-getstate-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/redeploy":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "App Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Operator":[ ] } ], "summary":"Redeploy ( Targets, Application Path, Plan, Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/redeploy POST-targets-applicationPath-plan-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "applicationPath":{ "type":"string", "description":"

A supported Java EE application or module archive, or a root diectory for the application or module. May be null.

" }, "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "plan":{ "type":"string", "description":"

The deployment plan for this application. May be null.

" }, "targets":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

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

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-redeploy-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-redeploy-x-operations-0" }, { "tags":[ "App Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Operator":[ ] } ], "summary":"Redeploy ( Targets, Plan, Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/redeploy POST-targets-plan-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "plan":{ "type":"string", "description":"

The deployment plan for this application. May be null.

" }, "targets":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

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

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-redeploy-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-redeploy-x-operations-1" }, { "tags":[ "App Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Operator":[ ] } ], "summary":"Redeploy ()", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/redeploy POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Redeploy the application using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-redeploy-post-x-operations-2", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-redeploy-x-operations-2" } ], "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/redeploy post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-redeploy-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-redeploy-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/start":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "App Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Operator":[ ] } ], "summary":"Start ( Targets, Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/start POST-targets-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "targets":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

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

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-start-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-start-x-operations-0" }, { "tags":[ "App Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Operator":[ ] } ], "summary":"Start ()", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/start POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Start the application using the default options and configured targets. This is a synchronous operation that returns when the start operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-start-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-start-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/start post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-start-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-start-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/stop":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "App Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Operator":[ ] } ], "summary":"Stop ( Targets, Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/stop POST-targets-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "targets":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

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

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-stop-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-stop-x-operations-0" }, { "tags":[ "App Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Operator":[ ] } ], "summary":"Stop ()", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/stop POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Stop the application using the default options and configured targets. This is a synchronous operation that returns when the stop operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-stop-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-stop-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/stop post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-stop-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-stop-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/undeploy":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "App Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Operator":[ ] } ], "summary":"Undeploy ()", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/undeploy POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Undeploy the application using the default options and configured targets. This is a synchronous operation that returns when the undeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-undeploy-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-undeploy-x-operations-0" }, { "tags":[ "App Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Operator":[ ] } ], "summary":"Undeploy ( Targets, Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/undeploy POST-targets-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "targets":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

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

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-undeploy-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-undeploy-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/undeploy post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-undeploy-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-undeploy-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/update":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "App Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Operator":[ ] } ], "summary":"Update", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/update POST-targets-plan-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "deploymentOptions":{ "type":"object", "description":"

Allows for overriding the deployment options. May be null.

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "plan":{ "type":"string", "description":"

The deployment plan containing the new deployment configuration information.

" }, "targets":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

represent the targets on which to update the application.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appDeploymentRuntimes-{name}-update-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appdeploymentruntimes-name-update-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/appendToExtensionLoader":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "Deployment Manager/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Append To Extension Loader ( Code Source Path, Targets, Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appendToExtensionLoader POST-codeSourcePath-targets-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "codeSourcePath":{ "type":"string", "description":"

A jar file to add to the extension loader

" }, "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "targets":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

The targets on which to distribute the code source. This would be server names or cluster names. If null, the code source will be distributed on all configured targets.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Appends a code source to the search path of the WebLogic Extension Loader, which is also referred to as the WebLogic Domain Loader. The code source file is distributed to the targets using the options specified. When the operation is complete, classes and resources in the jar file will be visible for class loading at the extension loader. Since the jar is now in place on targeted servers, the classes and resources will continue to be available even after a targeted server restarts. This is an asynchronous operation that returns immediately.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appendToExtensionLoader-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appendtoextensionloader-x-operations-0" }, { "tags":[ "Deployment Manager/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Append To Extension Loader ( Code Source Path )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appendToExtensionLoader POST-codeSourcePath", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "codeSourcePath":{ "type":"string", "description":"

A jar file to add to the extension loader

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Appends a code source to the search path of the WebLogic Extension Loader, which is also referred to as the WebLogic Domain Loader. The code source file is distributed to all targets using default options. When the operation is complete, classes and resources in the jar file will be visible for class loading at the extension loader. Since the jar is now in place on targeted servers, the classes and resources will continue to be available even after a targeted server restarts. This is an asynchronous operation that returns immediately.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appendToExtensionLoader-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appendtoextensionloader-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/appendToExtensionLoader post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-appendToExtensionLoader-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-appendtoextensionloader-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/confirmApplicationName":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "Deployment Manager/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Confirm Application Name ( Is Redeployment, App Source, Alt App Descriptor, Tentative Name, Tentative Application Id, Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/confirmApplicationName POST-isRedeployment-appSource-altAppDescriptor-tentativeName-tentativeApplicationId-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "altAppDescriptor":{ "type":"string", "description":"

optional alternate app descriptor.

" }, "appSource":{ "type":"string", "description":"

is a the path to the application.

" }, "deploymentOptions":{ "type":"object", "description":"

deployment options

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "isRedeployment":{ "type":"boolean", "description":"

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

" }, "tentativeApplicationId":{ "type":"string", "description":"

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

" }, "tentativeName":{ "type":"string", "description":"

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

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Used by the deployment subsystem to confirm an application name.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-confirmApplicationName-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-confirmapplicationname-x-operations-0" }, { "tags":[ "Deployment Manager/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Confirm Application Name ( Is Redeployment, App Source, Alt App Descriptor, Tentative Name, Tentative Application Id )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/confirmApplicationName POST-isRedeployment-appSource-altAppDescriptor-tentativeName-tentativeApplicationId", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "altAppDescriptor":{ "type":"string", "description":"

optional alternate application descriptor path

" }, "appSource":{ "type":"string", "description":"

is a the path to the application.

" }, "isRedeployment":{ "type":"boolean", "description":"

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

" }, "tentativeApplicationId":{ "type":"string", "description":"

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

" }, "tentativeName":{ "type":"string", "description":"

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

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Used by the deployment subsystem to confirm an application name.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-confirmApplicationName-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-confirmapplicationname-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/confirmApplicationName post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-confirmApplicationName-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-confirmapplicationname-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/deploy":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "Deployment Manager/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Deploy ( Name, Application Path, Plan )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/deploy POST-name-applicationPath-plan", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "applicationPath":{ "type":"string", "description":"

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

" }, "name":{ "type":"string", "description":"

The name of the application

" }, "plan":{ "type":"string", "description":"

The deployment plan for this application. May be null.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

A convenience method for distributing and starting an application.

The application source files and deployment plan are distributed to the deployment targets using the default options. This is a synchronous operation that returns when the deploy operation has completed. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.

The default options are

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-deploy-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-deploy-x-operations-0" }, { "tags":[ "Deployment Manager/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Deploy ( Name, Application Path, Targets, Plan, Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/deploy POST-name-applicationPath-targets-plan-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "applicationPath":{ "type":"string", "description":"

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

" }, "deploymentOptions":{ "type":"object", "description":"

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout). The optional planDir value is an absolute, existing server-side directory used to resolve external descriptors and application-file overrides for the supplied plan. A plan is required when planDir is specified. The plan document is not modified; omitting planDir retains config-root resolution.

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "name":{ "type":"string", "description":"

The name of the application

" }, "plan":{ "type":"string", "description":"

The deployment plan for this application. May be null.

" }, "targets":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

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

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

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

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-deploy-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-deploy-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/deploy post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-deploy-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-deploy-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Deployment Progress Object" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Deployment Progress Object Collection", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Deployment Progress Object" }, "description":"" }, "description":"

Returns a list of deployment progress object entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this deployment progress object collection.

View this deployment progress object collection.

This example uses the GET method to view this deployment progress object collection.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-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\n\nResponse Body:\n{\n    \"items\": [{\n        \"operationType\": 3,\n        \"applicationName\": \"fairShare\",\n        \"progress\": \"success\",\n        \"completed\": true\n    }]\n}
", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-deploymentProgressObjects-get", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-deploymentprogressobjects-get" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Deployment Progress Object" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Deployment Progress Object", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Deployment Progress Object" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"action", "title":"getExceptions", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/getExceptions", "description":"

This resource's getExceptions action resource.

" } ], "description":"

Returns this deployment progress object.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this deployment progress object.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-deploymentProgressObjects-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-deploymentprogressobjects-name-get" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Deployment Progress Object/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-deploymentProgressObjects-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-deploymentprogressobjects-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/getExceptions":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Deployment Progress Object/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Get Exceptions", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/getExceptions POST-target", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Throwable" }, "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "target":{ "type":"string", "description":"

the target where exceptions might have occurred.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-deploymentProgressObjects-{name}-getExceptions-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-deploymentprogressobjects-name-getexceptions-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/distribute":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "Deployment Manager/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Distribute ( Name, Application Path, Plan )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/distribute POST-name-applicationPath-plan", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "applicationPath":{ "type":"string", "description":"

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

" }, "name":{ "type":"string", "description":"

The name of the application

" }, "plan":{ "type":"string", "description":"

The deployment plan for this application. May be null.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Distribute an application.

The application source files and deployment plan are distributed to the deployment targets using the default options. This is a synchronous operation that returns when the distribute operation has completed.

The default options are:

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-distribute-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-distribute-x-operations-0" }, { "tags":[ "Deployment Manager/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Distribute ( Name, Application Path, Targets, Plan, Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/distribute POST-name-applicationPath-targets-plan-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "applicationPath":{ "type":"string", "description":"

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

" }, "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "name":{ "type":"string", "description":"

The name of the application

" }, "plan":{ "type":"string", "description":"

The deployment plan for this application. May be null.

" }, "targets":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

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

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-distribute-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-distribute-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/distribute post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-distribute-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-distribute-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Lib Deployment Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Lib Deployment Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Lib Deployment Runtime" }, "description":"" }, "description":"

Returns a list of lib deployment runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this lib deployment runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-libDeploymentRuntimes-get", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-libdeploymentruntimes-get" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Lib Deployment Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Lib Deployment Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Lib Deployment Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"redeploy", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/redeploy", "description":"

This resource's redeploy action resource.

" }, { "relationship":"action", "title":"undeploy", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/undeploy", "description":"

This resource's undeploy action resource.

" } ], "description":"

Returns this lib deployment runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this lib deployment runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-libDeploymentRuntimes-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-libdeploymentruntimes-name-get" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/redeploy":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "Lib Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Redeploy ( Targets, Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/redeploy POST-targets-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "targets":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

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

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-libDeploymentRuntimes-{name}-redeploy-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-libdeploymentruntimes-name-redeploy-x-operations-0" }, { "tags":[ "Lib Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Redeploy ()", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/redeploy POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-libDeploymentRuntimes-{name}-redeploy-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-libdeploymentruntimes-name-redeploy-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/redeploy post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-libDeploymentRuntimes-{name}-redeploy-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-libdeploymentruntimes-name-redeploy-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/undeploy":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "Lib Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Undeploy ()", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/undeploy POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-libDeploymentRuntimes-{name}-undeploy-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-libdeploymentruntimes-name-undeploy-x-operations-0" }, { "tags":[ "Lib Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Undeploy ( Targets, Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/undeploy POST-targets-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "targets":{ "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

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

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-libDeploymentRuntimes-{name}-undeploy-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-libdeploymentruntimes-name-undeploy-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/undeploy post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-libDeploymentRuntimes-{name}-undeploy-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-libdeploymentruntimes-name-undeploy-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/pluginDeploymentRuntimes":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Plugin Deployment Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Plugin Deployment Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/pluginDeploymentRuntimes GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Plugin Deployment Runtime" }, "description":"" }, "description":"

Returns a list of plugin deployment runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this plugin deployment runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-pluginDeploymentRuntimes-get", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-plugindeploymentruntimes-get" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/pluginDeploymentRuntimes/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Plugin Deployment Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Plugin Deployment Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/pluginDeploymentRuntimes/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Plugin Deployment Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"undeploy", "uri":"/management/weblogic/{version}/domainRuntime/deploymentManager/pluginDeploymentRuntimes/{name}/undeploy", "description":"

This resource's undeploy action resource.

" } ], "description":"

Returns this plugin deployment runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this plugin deployment runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-pluginDeploymentRuntimes-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-plugindeploymentruntimes-name-get" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/pluginDeploymentRuntimes/{name}/undeploy":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "Plugin Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Undeploy ()", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/pluginDeploymentRuntimes/{name}/undeploy POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Undeploy the plugin using the default options and configured targets. This is a synchronous operation that returns when the undeploy 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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-pluginDeploymentRuntimes-{name}-undeploy-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-plugindeploymentruntimes-name-undeploy-x-operations-0" }, { "tags":[ "Plugin Deployment Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Undeploy ( Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/pluginDeploymentRuntimes/{name}/undeploy POST-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Undeploy the plugin in the background for all servers in the domain 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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-pluginDeploymentRuntimes-{name}-undeploy-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-plugindeploymentruntimes-name-undeploy-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/pluginDeploymentRuntimes/{name}/undeploy post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-pluginDeploymentRuntimes-{name}-undeploy-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-plugindeploymentruntimes-name-undeploy-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/purgeCompletedDeploymentProgressObjects":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Deployment Manager/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Purge Completed Deployment Progress Objects", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/purgeCompletedDeploymentProgressObjects POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Removes progress objects for completed operations.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-purgeCompletedDeploymentProgressObjects-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-purgecompleteddeploymentprogressobjects-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/redeploy":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "Deployment Manager/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Redeploy ( Name, Application Path, Plan, Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/redeploy POST-name-applicationPath-plan-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "applicationPath":{ "type":"string", "description":"

A supported Java EE application or module archive, or a root diectory for the application or module. May be null.

" }, "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "name":{ "type":"string", "description":"

The application name

" }, "plan":{ "type":"string", "description":"

The deployment plan for this application. May be null.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-redeploy-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-redeploy-x-operations-0" }, { "tags":[ "Deployment Manager/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Redeploy ( Name, Plan, Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/redeploy POST-name-plan-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "name":{ "type":"string", "description":"

The application name

" }, "plan":{ "type":"string", "description":"

The deployment plan for this application. May be null.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-redeploy-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-redeploy-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/redeploy post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-redeploy-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-redeploy-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/undeploy":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "Deployment Manager/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Undeploy ( Name, Template )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/undeploy POST-name-template", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "name":{ "type":"string", "description":"

The application name

" }, "template":{ "type":"string", "description":"

The resource group template

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Undeploy the application that is deployed to a resource group template using the default options. This is a synchronous operation that returns when the undeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-undeploy-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-undeploy-x-operations-0" }, { "tags":[ "Deployment Manager/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Undeploy ( Name, Deployment Options )", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/undeploy POST-name-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "name":{ "type":"string", "description":"

The application name

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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

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

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-undeploy-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-undeploy-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/undeploy post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-undeploy-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-undeploy-post" } }, "/management/weblogic/{version}/domainRuntime/deploymentManager/update":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Deployment Manager/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Update", "operationId":"/management/weblogic/{version}/domainRuntime/deploymentManager/update POST-name-plan-deploymentOptions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Deployment Progress Object Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the deployment progress object reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "deploymentOptions":{ "type":"object", "description":"

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

", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "name":{ "type":"string", "description":"

The application name

" }, "plan":{ "type":"string", "description":"

The deployment plan for this application. May be null.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-deploymentManager-update-post", "x-filename-id":"management-weblogic-version-domainruntime-deploymentmanager-update-post" } }, "/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Domain Keystores Domain Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Domain Keystores Domain Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Domain Keystores Domain Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"addProvisionedIdentityCertificate", "uri":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/addProvisionedIdentityCertificate", "description":"

This resource's addProvisionedIdentityCertificate action resource.

" }, { "relationship":"action", "title":"addProvisionedIdentityCertificateAndKey", "uri":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/addProvisionedIdentityCertificateAndKey", "description":"

This resource's addProvisionedIdentityCertificateAndKey action resource.

" }, { "relationship":"action", "title":"addProvisionedTrustCertificate", "uri":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/addProvisionedTrustCertificate", "description":"

This resource's addProvisionedTrustCertificate action resource.

" }, { "relationship":"action", "title":"addProvisionedTrustCertificates", "uri":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/addProvisionedTrustCertificates", "description":"

This resource's addProvisionedTrustCertificates action resource.

" }, { "relationship":"action", "title":"exportDomainTrustCertificates", "uri":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/exportDomainTrustCertificates", "description":"

This resource's exportDomainTrustCertificates action resource.

" }, { "relationship":"action", "title":"exportProvisionedTrustCertificates", "uri":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/exportProvisionedTrustCertificates", "description":"

This resource's exportProvisionedTrustCertificates action resource.

" }, { "relationship":"action", "title":"exportTrustedCertificates", "uri":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/exportTrustedCertificates", "description":"

This resource's exportTrustedCertificates action resource.

" }, { "relationship":"action", "title":"listDomainCaKeystore", "uri":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/listDomainCaKeystore", "description":"

This resource's listDomainCaKeystore action resource.

" }, { "relationship":"action", "title":"listDomainTrustKeystore", "uri":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/listDomainTrustKeystore", "description":"

This resource's listDomainTrustKeystore action resource.

" }, { "relationship":"action", "title":"listProvisionedIdentityKeystore", "uri":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/listProvisionedIdentityKeystore", "description":"

This resource's listProvisionedIdentityKeystore action resource.

" }, { "relationship":"action", "title":"listProvisionedTrustKeystore", "uri":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/listProvisionedTrustKeystore", "description":"

This resource's listProvisionedTrustKeystore action resource.

" }, { "relationship":"action", "title":"removeProvisionedIdentityCertificate", "uri":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/removeProvisionedIdentityCertificate", "description":"

This resource's removeProvisionedIdentityCertificate action resource.

" }, { "relationship":"action", "title":"removeProvisionedTrustCertificate", "uri":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/removeProvisionedTrustCertificate", "description":"

This resource's removeProvisionedTrustCertificate action resource.

" } ], "description":"

Returns this domain keystores domain runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this domain keystores domain runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainKeystoresRuntime-get", "x-filename-id":"management-weblogic-version-domainruntime-domainkeystoresruntime-get" } }, "/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/addProvisionedIdentityCertificate":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Keystores Domain Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Add Provisioned Identity Certificate", "operationId":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/addProvisionedIdentityCertificate POST-toAlias-fromFileName-fromFileType-fromFilePassphrase-fromAlias-fromAliasPassphrase", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "fromAlias":{ "type":"string", "description":"

The alias of the entry in the input file (if needed)

" }, "fromAliasPassphrase":{ "type":"string", "description":"

The passphrase for the entry in the input file (if needed)

" }, "fromFileName":{ "type":"string", "description":"

The name of the input file

" }, "fromFilePassphrase":{ "type":"string", "description":"

The passphrase for the input file (if needed)

" }, "fromFileType":{ "type":"string", "description":"

The type of the input file

" }, "toAlias":{ "type":"string", "description":"

The alias to use for the new provisioned identity certificate

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Add a provisioned identity certificate to the domain. JKS and PKCS12 inputs use fromAlias and fromAliasPassphrase. A PEM input contains one PKCS#8 private key, the matching leaf certificate, and an optional certificate chain; fromAlias and fromAliasPassphrase are ignored for PEM input and fromFilePassphrase decrypts an encrypted PKCS#8 key.

Remote callers must use an encrypted management transport such as T3S or HTTPS.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainKeystoresRuntime-addProvisionedIdentityCertificate-post", "x-filename-id":"management-weblogic-version-domainruntime-domainkeystoresruntime-addprovisionedidentitycertificate-post" } }, "/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/addProvisionedIdentityCertificateAndKey":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Keystores Domain Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Add Provisioned Identity Certificate And Key", "operationId":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/addProvisionedIdentityCertificateAndKey POST-toAlias-certificateFileName-certificateFileType-privateKeyFileName-privateKeyFileType-privateKeyPassphrase", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "certificateFileName":{ "type":"string", "description":"

The name of the certificate or certificate-chain file

" }, "certificateFileType":{ "type":"string", "description":"

The certificate file type, PEM or DER

" }, "privateKeyFileName":{ "type":"string", "description":"

The name of the PKCS#8 private-key file

" }, "privateKeyFileType":{ "type":"string", "description":"

The private-key file type, PEM or DER

" }, "privateKeyPassphrase":{ "type":"string", "description":"

The private-key passphrase, or null/empty for an unencrypted key

" }, "toAlias":{ "type":"string", "description":"

The alias to use for the new provisioned identity certificate

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Add a provisioned identity certificate and PKCS#8 private key from separate files. Supported combinations are PEM certificate chain with a PEM private key, DER leaf certificate with a DER private key, and PEM certificate chain with a DER private key. The private key may be unencrypted or encrypted.

Remote callers must use an encrypted management transport such as T3S or HTTPS.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainKeystoresRuntime-addProvisionedIdentityCertificateAndKey-post", "x-filename-id":"management-weblogic-version-domainruntime-domainkeystoresruntime-addprovisionedidentitycertificateandkey-post" } }, "/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/addProvisionedTrustCertificate":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Keystores Domain Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Add Provisioned Trust Certificate", "operationId":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/addProvisionedTrustCertificate POST-toAlias-fromFileName-fromFileType-fromFilePassphrase-fromAlias", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "fromAlias":{ "type":"string", "description":"

The alias of the entry in the input file (if needed)

" }, "fromFileName":{ "type":"string", "description":"

The name of the input file

" }, "fromFilePassphrase":{ "type":"string", "description":"

The passphrase for the input file (if needed)

" }, "fromFileType":{ "type":"string", "description":"

The type of the input file

" }, "toAlias":{ "type":"string", "description":"

The alias to use for the new provisioned trust anchor

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Add one provisioned trust anchor to the domain. For PEM input, only the first certificate is imported when the file contains additional certificates. Use addProvisionedTrustCertificates(String, String, String) to import every certificate in a PEM bundle. DER input contains one X.509 certificate.

Remote callers must use an encrypted management transport such as T3S or HTTPS.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainKeystoresRuntime-addProvisionedTrustCertificate-post", "x-filename-id":"management-weblogic-version-domainruntime-domainkeystoresruntime-addprovisionedtrustcertificate-post" } }, "/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/addProvisionedTrustCertificates":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Keystores Domain Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Add Provisioned Trust Certificates", "operationId":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/addProvisionedTrustCertificates POST-aliasBase-fromFileName-fromFileType", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "aliasBase":{ "type":"string", "description":"

The base used to generate one-based provisioned aliases

" }, "fromFileName":{ "type":"string", "description":"

The name of the PEM bundle

" }, "fromFileType":{ "type":"string", "description":"

The input file type; only PEM is supported

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Add every X.509 certificate in a PEM bundle to the Provisioned Trust keystore. The complete bundle is validated before it is persisted. Generated aliases are provisioned--1, provisioned--2, and so on in file order. Duplicate aliases or certificates cause the entire operation to fail.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainKeystoresRuntime-addProvisionedTrustCertificates-post", "x-filename-id":"management-weblogic-version-domainruntime-domainkeystoresruntime-addprovisionedtrustcertificates-post" } }, "/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/exportDomainTrustCertificates":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Keystores Domain Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Export Domain Trust Certificates", "operationId":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/exportDomainTrustCertificates POST-toFileName-toFileType-toFilePassphrase", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "toFileName":{ "type":"string", "description":"

The name of the output file

" }, "toFilePassphrase":{ "type":"string", "description":"

The passphrase for the output file (if needed)

" }, "toFileType":{ "type":"string", "description":"

The type of the output file

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Export only the Domain Trust keystore. Supported output types are PEM, JKS, and PKCS12. DER export is not supported.

Remote callers must use an encrypted management transport such as T3S or HTTPS.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainKeystoresRuntime-exportDomainTrustCertificates-post", "x-filename-id":"management-weblogic-version-domainruntime-domainkeystoresruntime-exportdomaintrustcertificates-post" } }, "/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/exportProvisionedTrustCertificates":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Keystores Domain Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Export Provisioned Trust Certificates", "operationId":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/exportProvisionedTrustCertificates POST-toFileName-toFileType-toFilePassphrase", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "toFileName":{ "type":"string", "description":"

The name of the output file

" }, "toFilePassphrase":{ "type":"string", "description":"

The passphrase for the output file (if needed)

" }, "toFileType":{ "type":"string", "description":"

The type of the output file

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Export only the Provisioned Trust keystore. Supported output types are PEM, JKS, and PKCS12. DER export is not supported.

Remote callers must use an encrypted management transport such as T3S or HTTPS.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainKeystoresRuntime-exportProvisionedTrustCertificates-post", "x-filename-id":"management-weblogic-version-domainruntime-domainkeystoresruntime-exportprovisionedtrustcertificates-post" } }, "/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/exportTrustedCertificates":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Keystores Domain Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Export Trusted Certificates", "operationId":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/exportTrustedCertificates POST-toFileName-toFileType-toFilePassphrase", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "toFileName":{ "type":"string", "description":"

The name of the output file

" }, "toFilePassphrase":{ "type":"string", "description":"

The passphrase for the output file (if needed)

" }, "toFileType":{ "type":"string", "description":"

The type of the output file

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Export the certificates trusted by the domain; that is, the contents of the \"Domain Trust\" keystore combined with the contents of the \"Provisioned Trust\" keystore.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainKeystoresRuntime-exportTrustedCertificates-post", "x-filename-id":"management-weblogic-version-domainruntime-domainkeystoresruntime-exporttrustedcertificates-post" } }, "/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/listDomainCaKeystore":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Keystores Domain Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"List Domain Ca Keystore", "operationId":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/listDomainCaKeystore POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/X509 Certificate Info V" }, "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

List the domain certificate authority's keystore.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainKeystoresRuntime-listDomainCaKeystore-post", "x-filename-id":"management-weblogic-version-domainruntime-domainkeystoresruntime-listdomaincakeystore-post" } }, "/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/listDomainTrustKeystore":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Keystores Domain Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"List Domain Trust Keystore", "operationId":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/listDomainTrustKeystore POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/X509 Certificate Info V" }, "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

List the domain certificate authority certificates trusted by the domain.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainKeystoresRuntime-listDomainTrustKeystore-post", "x-filename-id":"management-weblogic-version-domainruntime-domainkeystoresruntime-listdomaintrustkeystore-post" } }, "/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/listProvisionedIdentityKeystore":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Keystores Domain Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"List Provisioned Identity Keystore", "operationId":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/listProvisionedIdentityKeystore POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/X509 Certificate Info V" }, "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

List the provisioned identity certificates for the domain.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainKeystoresRuntime-listProvisionedIdentityKeystore-post", "x-filename-id":"management-weblogic-version-domainruntime-domainkeystoresruntime-listprovisionedidentitykeystore-post" } }, "/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/listProvisionedTrustKeystore":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Keystores Domain Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"List Provisioned Trust Keystore", "operationId":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/listProvisionedTrustKeystore POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/X509 Certificate Info V" }, "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

List the provisioned trust anchors for the domain.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainKeystoresRuntime-listProvisionedTrustKeystore-post", "x-filename-id":"management-weblogic-version-domainruntime-domainkeystoresruntime-listprovisionedtrustkeystore-post" } }, "/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/removeProvisionedIdentityCertificate":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Keystores Domain Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Remove Provisioned Identity Certificate", "operationId":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/removeProvisionedIdentityCertificate POST-alias", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "alias":{ "type":"string", "description":"

The alias of the provisioned identity certificate to remove

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Remove a provisioned identity certificate from the domain.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainKeystoresRuntime-removeProvisionedIdentityCertificate-post", "x-filename-id":"management-weblogic-version-domainruntime-domainkeystoresruntime-removeprovisionedidentitycertificate-post" } }, "/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/removeProvisionedTrustCertificate":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Keystores Domain Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Remove Provisioned Trust Certificate", "operationId":"/management/weblogic/{version}/domainRuntime/domainKeystoresRuntime/removeProvisionedTrustCertificate POST-alias", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "alias":{ "type":"string", "description":"

The alias of the provisioned trust anchor to remove

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Remove a provisioned trust anchor from the domain.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainKeystoresRuntime-removeProvisionedTrustCertificate-post", "x-filename-id":"management-weblogic-version-domainruntime-domainkeystoresruntime-removeprovisionedtrustcertificate-post" } }, "/management/weblogic/{version}/domainRuntime/domainSecurityRuntime":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Domain Security Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Domain Security Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/domainSecurityRuntime GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Domain Security Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"hasSecurityValidationWarnings", "uri":"/management/weblogic/{version}/domainRuntime/domainSecurityRuntime/hasSecurityValidationWarnings", "description":"

This resource's hasSecurityValidationWarnings action resource.

" }, { "relationship":"action", "title":"refreshCache", "uri":"/management/weblogic/{version}/domainRuntime/domainSecurityRuntime/refreshCache", "description":"

This resource's refreshCache action resource.

" } ], "description":"

Returns this domain security runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this domain security runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainSecurityRuntime-get", "x-filename-id":"management-weblogic-version-domainruntime-domainsecurityruntime-get" } }, "/management/weblogic/{version}/domainRuntime/domainSecurityRuntime/hasSecurityValidationWarnings":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Security Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Has Security Validation Warnings", "operationId":"/management/weblogic/{version}/domainRuntime/domainSecurityRuntime/hasSecurityValidationWarnings POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"boolean", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Returns true if there are any SecurityValidationWarnings for the domain.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainSecurityRuntime-hasSecurityValidationWarnings-post", "x-filename-id":"management-weblogic-version-domainruntime-domainsecurityruntime-hassecurityvalidationwarnings-post" } }, "/management/weblogic/{version}/domainRuntime/domainSecurityRuntime/refreshCache":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Security Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Refresh Cache", "operationId":"/management/weblogic/{version}/domainRuntime/domainSecurityRuntime/refreshCache POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Refreshes the cache of security validation warnings for the domain. This method may take several seconds to complete as this requires communication with all servers in the domain.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-domainSecurityRuntime-refreshCache-post", "x-filename-id":"management-weblogic-version-domainruntime-domainsecurityruntime-refreshcache-post" } }, "/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Edit Session Configuration Manager" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Edit Session Configuration Manager", "operationId":"/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Edit Session Configuration Manager" }, "x-weblogic-links":[ { "relationship":"action", "title":"forceDestroyEditSessionConfiguration", "uri":"/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/forceDestroyEditSessionConfiguration", "description":"

This resource's forceDestroyEditSessionConfiguration action resource.

" }, { "relationship":"editSessionConfigurationCreateForm", "uri":"/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurationCreateForm", "description":"

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

" }, { "relationship":"editSessionConfigurations", "uri":"/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations", "description":"

This resource's editSessionConfigurations collection resource.

" } ], "description":"

Returns this edit session configuration manager.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this edit session configuration manager.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-editSessionConfigurationManager-get", "x-filename-id":"management-weblogic-version-domainruntime-editsessionconfigurationmanager-get" } }, "/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurationCreateForm":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Edit Session Configuration Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"GET A Create Form For This Edit Session Configuration Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurationCreateForm GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Edit Session Configuration Runtime" }, "x-weblogic-links":[ { "relationship":"create", "uri":"/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations", "description":"

The collection resource for this create form resource.

" } ], "description":"

Returns this edit session configuration runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

This resource returns a pre-populated edit session configuration runtime model that can be customized then posted (using the POST method) to the editSessionConfigurations collection resource to create a new edit session configuration runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-editSessionConfigurationManager-editSessionConfigurationCreateForm-get", "x-filename-id":"management-weblogic-version-domainruntime-editsessionconfigurationmanager-editsessionconfigurationcreateform-get" } }, "/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Edit Session Configuration Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Edit Session Configuration Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Edit Session Configuration Runtime" }, "description":"" }, "x-weblogic-links":[ { "relationship":"create-form", "uri":"/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurationCreateForm", "description":"

The create form resource for this collection resource.

" } ], "description":"

Returns a list of edit session configuration runtime entities.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this edit session configuration runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-editSessionConfigurationManager-editSessionConfigurations-get", "x-filename-id":"management-weblogic-version-domainruntime-editsessionconfigurationmanager-editsessionconfigurations-get" }, "post":{ "tags":[ "Edit Session Configuration Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Create A New Edit Session Configuration Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations POST", "responses":{ "201":{ "description":"" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "$ref":"#/definitions/Edit Session Configuration Runtime" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain a populated edit session configuration runtime model.

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Add a new edit session configuration runtime to this collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-editSessionConfigurationManager-editSessionConfigurations-post", "x-filename-id":"management-weblogic-version-domainruntime-editsessionconfigurationmanager-editsessionconfigurations-post" } }, "/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "delete":{ "tags":[ "Edit Session Configuration Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Delete This Edit Session Configuration Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name} DELETE", "responses":{ "200":{ "description":"" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Delete this edit session configuration runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-editSessionConfigurationManager-editSessionConfigurations-{name}-delete", "x-filename-id":"management-weblogic-version-domainruntime-editsessionconfigurationmanager-editsessionconfigurations-name-delete" }, "get":{ "tags":[ "Edit Session Configuration Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Edit Session Configuration Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Edit Session Configuration Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"containsUnactivatedChanges", "uri":"/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges", "description":"

This resource's containsUnactivatedChanges action resource.

" } ], "description":"

Returns this edit session configuration runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this edit session configuration runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-editSessionConfigurationManager-editSessionConfigurations-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-editsessionconfigurationmanager-editsessionconfigurations-name-get" } }, "/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Edit Session Configuration Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Contains Unactivated Changes", "operationId":"/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"boolean", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Returns true if there are changes saved in the pending directory or there are changes in memory. To apply these changes, activate the session.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-editSessionConfigurationManager-editSessionConfigurations-{name}-containsUnactivatedChanges-post", "x-filename-id":"management-weblogic-version-domainruntime-editsessionconfigurationmanager-editsessionconfigurations-name-containsunactivatedchanges-post" } }, "/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/forceDestroyEditSessionConfiguration":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Edit Session Configuration Manager/Actions" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] } ], "summary":"Force Destroy Edit Session Configuration", "operationId":"/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/forceDestroyEditSessionConfiguration POST-editSession", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "editSession":{ "title":"Edit Session Configuration Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the edit session configuration runtime reference.

Edit session to destroy.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Destroys an existing named edit session configuration. This will destroy the associated edit session specific MBeanServer and remove the /edit/ or /partitions//edit/ 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).

", "x-internal-id":"management-weblogic-{version}-domainRuntime-editSessionConfigurationManager-forceDestroyEditSessionConfiguration-post", "x-filename-id":"management-weblogic-version-domainruntime-editsessionconfigurationmanager-forcedestroyeditsessionconfiguration-post" } }, "/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Elastic Service Manager Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Elastic Service Manager Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Elastic Service Manager Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"getScalingTasks", "uri":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/getScalingTasks", "description":"

This resource's getScalingTasks action resource.

" }, { "relationship":"action", "title":"purgeScalingTasks", "uri":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/purgeScalingTasks", "description":"

This resource's purgeScalingTasks action resource.

" }, { "relationship":"action", "title":"scaleDown", "uri":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleDown", "description":"

This resource's scaleDown action resource.

" }, { "relationship":"action", "title":"scaleUp", "uri":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleUp", "description":"

This resource's scaleUp action resource.

" }, { "relationship":"scalingTasks", "uri":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks", "description":"

This resource's scalingTasks collection resource.

" } ], "description":"

Returns this elastic service manager runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this elastic service manager runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-elasticServiceManagerRuntime-get", "x-filename-id":"management-weblogic-version-domainruntime-elasticservicemanagerruntime-get" } }, "/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/getScalingTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Elastic Service Manager Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Get Scaling Tasks", "operationId":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/getScalingTasks POST-clusterName-size", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Scaling Task Runtime References", "type":"array", "items":{ "title":"Scaling Task Runtime Reference", "type":"object", "properties":{ "identity":{ "title":"Identity", "type":"array", "items":{ "type":"string", "description":"" }, "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource." } }, "description":"Contains the scaling task runtime reference." }, "description":"Contains the array of scaling task runtime references.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "clusterName":{ "type":"string", "description":"

Cluster name

" }, "size":{ "type":"integer", "format":"int32", "description":"

The number of ScalingTaskRuntimeMBean to return starting with the most recent.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "x-internal-id":"management-weblogic-{version}-domainRuntime-elasticServiceManagerRuntime-getScalingTasks-post", "x-filename-id":"management-weblogic-version-domainruntime-elasticservicemanagerruntime-getscalingtasks-post" } }, "/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/purgeScalingTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Elastic Service Manager Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Purge Scaling Tasks", "operationId":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/purgeScalingTasks POST-clusterName-age", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"integer", "format":"int32", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "age":{ "type":"integer", "format":"int32", "description":"

Age of tasks to be purged in seconds

" }, "clusterName":{ "type":"string", "description":"

Cluster name

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Purge scaling tasks for a service which have completed at least \"age\" seconds ago. Tasks which are currently running will not be purged.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-elasticServiceManagerRuntime-purgeScalingTasks-post", "x-filename-id":"management-weblogic-version-domainruntime-elasticservicemanagerruntime-purgescalingtasks-post" } }, "/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleDown":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Elastic Service Manager Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Scale Down", "operationId":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleDown POST-clusterName-scaleFactor", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Scaling Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the scaling task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "clusterName":{ "type":"string", "description":"

Cluster name

" }, "scaleFactor":{ "type":"integer", "format":"int32", "description":"

the size by which the service must be scaled up

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Perform a scale down operation

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-elasticServiceManagerRuntime-scaleDown-post", "x-filename-id":"management-weblogic-version-domainruntime-elasticservicemanagerruntime-scaledown-post" } }, "/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleUp":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Elastic Service Manager Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Scale Up", "operationId":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleUp POST-clusterName-scaleFactor", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Scaling Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the scaling task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "clusterName":{ "type":"string", "description":"

Cluster name

" }, "scaleFactor":{ "type":"integer", "format":"int32", "description":"

the size by which the service must be scaled up

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Perform a scale up operation

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-elasticServiceManagerRuntime-scaleUp-post", "x-filename-id":"management-weblogic-version-domainruntime-elasticservicemanagerruntime-scaleup-post" } }, "/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Scaling Task Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Scaling Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Scaling Task Runtime" }, "description":"" }, "description":"

Returns a list of scaling task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this scaling task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-elasticServiceManagerRuntime-scalingTasks-get", "x-filename-id":"management-weblogic-version-domainruntime-elasticservicemanagerruntime-scalingtasks-get" } }, "/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Scaling Task Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Scaling Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Scaling Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this scaling task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this scaling task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-elasticServiceManagerRuntime-scalingTasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-elasticservicemanagerruntime-scalingtasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Scaling Task Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-elasticServiceManagerRuntime-scalingTasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-elasticservicemanagerruntime-scalingtasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Elastic Service Manager Runtime/Scaling Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Task Runtime" }, "description":"" }, "description":"

Returns a list of task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-elasticServiceManagerRuntime-scalingTasks-{name}-subTasks-get", "x-filename-id":"management-weblogic-version-domainruntime-elasticservicemanagerruntime-scalingtasks-name-subtasks-get" } }, "/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Elastic Service Manager Runtime/Scaling Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-elasticServiceManagerRuntime-scalingTasks-{name}-subTasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-elasticservicemanagerruntime-scalingtasks-name-subtasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Task Runtime/Elastic Service Manager Runtime/Scaling Tasks/Sub Tasks/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-elasticServiceManagerRuntime-scalingTasks-{name}-subTasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-elasticservicemanagerruntime-scalingtasks-name-subtasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks/{name}/subTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Elastic Service Manager Runtime/Scaling Tasks/Sub Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks/{name}/subTasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Task Runtime" }, "description":"" }, "description":"

Returns a list of task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-elasticServiceManagerRuntime-scalingTasks-{name}-subTasks-{name}-subTasks-get", "x-filename-id":"management-weblogic-version-domainruntime-elasticservicemanagerruntime-scalingtasks-name-subtasks-name-subtasks-get" } }, "/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks/{name}/subTasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Elastic Service Manager Runtime/Scaling Tasks/Sub Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks/{name}/subTasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks/{name}/subTasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks/{name}/subTasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-elasticServiceManagerRuntime-scalingTasks-{name}-subTasks-{name}-subTasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-elasticservicemanagerruntime-scalingtasks-name-subtasks-name-subtasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks/{name}/subTasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Task Runtime/Elastic Service Manager Runtime/Scaling Tasks/Sub Tasks/Sub Tasks/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scalingTasks/{name}/subTasks/{name}/subTasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-elasticServiceManagerRuntime-scalingTasks-{name}-subTasks-{name}-subTasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-elasticservicemanagerruntime-scalingtasks-name-subtasks-name-subtasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/logRuntime":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Log Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Log Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/logRuntime GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Log Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"ensureLogOpened", "uri":"/management/weblogic/{version}/domainRuntime/logRuntime/ensureLogOpened", "description":"

This resource's ensureLogOpened action resource.

" }, { "relationship":"action", "title":"flushLog", "uri":"/management/weblogic/{version}/domainRuntime/logRuntime/flushLog", "description":"

This resource's flushLog action resource.

" }, { "relationship":"action", "title":"forceLogRotation", "uri":"/management/weblogic/{version}/domainRuntime/logRuntime/forceLogRotation", "description":"

This resource's forceLogRotation action resource.

" } ], "description":"

Returns this log runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this log runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-logRuntime-get", "x-filename-id":"management-weblogic-version-domainruntime-logruntime-get" } }, "/management/weblogic/{version}/domainRuntime/logRuntime/ensureLogOpened":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Log Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Ensure Log Opened", "operationId":"/management/weblogic/{version}/domainRuntime/logRuntime/ensureLogOpened POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Ensures that that the output stream to the underlying is opened if it got closed previously due to errors.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-logRuntime-ensureLogOpened-post", "x-filename-id":"management-weblogic-version-domainruntime-logruntime-ensurelogopened-post" } }, "/management/weblogic/{version}/domainRuntime/logRuntime/flushLog":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Log Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Flush Log", "operationId":"/management/weblogic/{version}/domainRuntime/logRuntime/flushLog POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Flushes the buffer to the log file on disk.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-logRuntime-flushLog-post", "x-filename-id":"management-weblogic-version-domainruntime-logruntime-flushlog-post" } }, "/management/weblogic/{version}/domainRuntime/logRuntime/forceLogRotation":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Log Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Force Log Rotation", "operationId":"/management/weblogic/{version}/domainRuntime/logRuntime/forceLogRotation POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Forces the rotation of the underlying log immediately.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-logRuntime-forceLogRotation-post", "x-filename-id":"management-weblogic-version-domainruntime-logruntime-forcelogrotation-post" } }, "/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Message Driven Control EJB Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Message Driven Control EJB Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Message Driven Control EJB Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"printMDBStatus", "uri":"/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/printMDBStatus", "description":"

This resource's printMDBStatus action resource.

" }, { "relationship":"action", "title":"resumeMDBs", "uri":"/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/resumeMDBs", "description":"

This resource's resumeMDBs action resource.

" }, { "relationship":"action", "title":"suspendMDBs", "uri":"/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/suspendMDBs", "description":"

This resource's suspendMDBs action resource.

" } ], "description":"

Returns this message driven control EJB runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this message driven control EJB runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-messageDrivenControlEJBRuntime-get", "x-filename-id":"management-weblogic-version-domainruntime-messagedrivencontrolejbruntime-get" } }, "/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/printMDBStatus":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Message Driven Control EJB Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Print MDB Status", "operationId":"/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/printMDBStatus POST-ejbName-applicationName", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"boolean", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "applicationName":{ "type":"string", "description":"" }, "ejbName":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Prints the MDBStatus for the specific type of MDB

", "x-internal-id":"management-weblogic-{version}-domainRuntime-messageDrivenControlEJBRuntime-printMDBStatus-post", "x-filename-id":"management-weblogic-version-domainruntime-messagedrivencontrolejbruntime-printmdbstatus-post" } }, "/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/resumeMDBs":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Message Driven Control EJB Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Resume MD Bs", "operationId":"/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/resumeMDBs POST-ejbName-applicationName", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"boolean", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "applicationName":{ "type":"string", "description":"" }, "ejbName":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Resumes the specific type of MDB by calling start on the JMS Connection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-messageDrivenControlEJBRuntime-resumeMDBs-post", "x-filename-id":"management-weblogic-version-domainruntime-messagedrivencontrolejbruntime-resumemdbs-post" } }, "/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/suspendMDBs":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Message Driven Control EJB Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Suspend MD Bs", "operationId":"/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/suspendMDBs POST-ejbName-applicationName", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"boolean", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "applicationName":{ "type":"string", "description":"" }, "ejbName":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Suspends the specific type of MDB by calling stop on the JMS Connection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-messageDrivenControlEJBRuntime-suspendMDBs-post", "x-filename-id":"management-weblogic-version-domainruntime-messagedrivencontrolejbruntime-suspendmdbs-post" } }, "/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Migratable Service Coordinator Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Migratable Service Coordinator Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Migratable Service Coordinator Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"migrate", "uri":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrate", "description":"

This resource's migrate action resource.

" }, { "relationship":"action", "title":"migrateJTA", "uri":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateJTA", "description":"

This resource's migrateJTA action resource.

" }, { "relationship":"action", "title":"migrateSingleton", "uri":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateSingleton", "description":"

This resource's migrateSingleton action resource.

" }, { "relationship":"migrationTaskRuntimes", "uri":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes", "description":"

This resource's migrationTaskRuntimes collection resource.

" } ], "description":"

Returns this migratable service coordinator runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this migratable service coordinator runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migratableServiceCoordinatorRuntime-get", "x-filename-id":"management-weblogic-version-domainruntime-migratableservicecoordinatorruntime-get" } }, "/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrate":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "Migratable Service Coordinator Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Migrate ( Migratable Target, Destination )", "operationId":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrate POST-migratableTarget-destination", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "destination":{ "title":"Server Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server reference.

- the new server where the services deployed to migratableTarget shall be activated

" }, "migratableTarget":{ "title":"Migratable Target Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the migratable target reference.

- all services targeted to this target are to be migrated to the destination server. THIS MUST BE A CONFIG MBEAN

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Migrates all services deployed to the migratableTarget to the destination server. This method assumes that the source and the destination server are up and running. Precondition: The migratableTarget must contain at least one server. The destination server must be a member of the migratableTarget's list of candidate servers. If automatic migration mode is disabled, the destination server must not be the currently hosting server (i.e. head of candidate list of the migratableTarget). Postcondition: If automatic migration mode is disabled and if the migration succeeded, the head of the candidate server list in the migratableTarget will be the destination server.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migratableServiceCoordinatorRuntime-migrate-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-migratableservicecoordinatorruntime-migrate-x-operations-0" }, { "tags":[ "Migratable Service Coordinator Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Migrate ( Migratable Target, Destination, Source Up, Destination Up )", "operationId":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrate POST-migratableTarget-destination-sourceUp-destinationUp", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "destination":{ "title":"Server Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server reference.

- the new server where the services deployed to migratableTarget shall be activated

" }, "destinationUp":{ "type":"boolean", "description":"

- the destination server is up and running.

" }, "migratableTarget":{ "title":"Migratable Target Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the migratable target reference.

- all services targeted to this target are to be migrated to the destination server. THIS MUST BE A CONFIG MBEAN

" }, "sourceUp":{ "type":"boolean", "description":"

- the currently active server is up and running. If false, the administrator must ensure that the services deployed to migratableTarget are NOT active.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Migrates all services deployed to the migratableTarget to the destination server. Use this method if either the source or the destination or both are not running. Precondition: The migratableTarget must contain at least one server. The destination server must be a member of the migratableTarget's list of candidate servers. If automatic migration mode is disabled, the destination server must not be the currently hosting server (i.e. head of candidate list of the migratableTarget). Postcondition: If automatic migration mode is disabled and if the migration succeeded, the head of the candidate server list in the migratableTarget will be the destination server.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migratableServiceCoordinatorRuntime-migrate-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-migratableservicecoordinatorruntime-migrate-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrate post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-migratableServiceCoordinatorRuntime-migrate-post", "x-filename-id":"management-weblogic-version-domainruntime-migratableservicecoordinatorruntime-migrate-post" } }, "/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateJTA":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Migratable Service Coordinator Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Migrate JTA", "operationId":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateJTA POST-migratableTarget-destination-sourceUp-destinationUp", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "destination":{ "title":"Server Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server reference." }, "destinationUp":{ "type":"boolean", "description":"" }, "migratableTarget":{ "title":"Migratable Target Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the migratable target reference." }, "sourceUp":{ "type":"boolean", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Migrates the JTARecoveryManager deployed to a migratableTarget to the destination server.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migratableServiceCoordinatorRuntime-migrateJTA-post", "x-filename-id":"management-weblogic-version-domainruntime-migratableservicecoordinatorruntime-migratejta-post" } }, "/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateSingleton":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Migratable Service Coordinator Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Migrate Singleton", "operationId":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateSingleton POST-singletonService-destination", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "destination":{ "title":"Server Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server reference.

- the new server where the singleton service shall be activated

" }, "singletonService":{ "title":"Singleton Service Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the singleton service reference.

- SingletonService to be migrated to the destination server. THIS MUST BE A CONFIG MBEAN

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migratableServiceCoordinatorRuntime-migrateSingleton-post", "x-filename-id":"management-weblogic-version-domainruntime-migratableservicecoordinatorruntime-migratesingleton-post" } }, "/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Migration Task Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Migration Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Migration Task Runtime" }, "description":"" }, "description":"

Returns a list of migration task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this migration task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migratableServiceCoordinatorRuntime-migrationTaskRuntimes-get", "x-filename-id":"management-weblogic-version-domainruntime-migratableservicecoordinatorruntime-migrationtaskruntimes-get" } }, "/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Migration Task Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Migration Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Migration Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this migration task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this migration task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migratableServiceCoordinatorRuntime-migrationTaskRuntimes-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-migratableservicecoordinatorruntime-migrationtaskruntimes-name-get" } }, "/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Migration Task Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migratableServiceCoordinatorRuntime-migrationTaskRuntimes-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-migratableservicecoordinatorruntime-migrationtaskruntimes-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Migratable Service Coordinator Runtime/Migration Task Runtimes/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Task Runtime" }, "description":"" }, "description":"

Returns a list of task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migratableServiceCoordinatorRuntime-migrationTaskRuntimes-{name}-subTasks-get", "x-filename-id":"management-weblogic-version-domainruntime-migratableservicecoordinatorruntime-migrationtaskruntimes-name-subtasks-get" } }, "/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Migratable Service Coordinator Runtime/Migration Task Runtimes/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migratableServiceCoordinatorRuntime-migrationTaskRuntimes-{name}-subTasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-migratableservicecoordinatorruntime-migrationtaskruntimes-name-subtasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Task Runtime/Migratable Service Coordinator Runtime/Migration Task Runtimes/Sub Tasks/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migratableServiceCoordinatorRuntime-migrationTaskRuntimes-{name}-subTasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-migratableservicecoordinatorruntime-migrationtaskruntimes-name-subtasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks/{name}/subTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Migratable Service Coordinator Runtime/Migration Task Runtimes/Sub Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks/{name}/subTasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Task Runtime" }, "description":"" }, "description":"

Returns a list of task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migratableServiceCoordinatorRuntime-migrationTaskRuntimes-{name}-subTasks-{name}-subTasks-get", "x-filename-id":"management-weblogic-version-domainruntime-migratableservicecoordinatorruntime-migrationtaskruntimes-name-subtasks-name-subtasks-get" } }, "/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks/{name}/subTasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Migratable Service Coordinator Runtime/Migration Task Runtimes/Sub Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks/{name}/subTasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks/{name}/subTasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks/{name}/subTasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migratableServiceCoordinatorRuntime-migrationTaskRuntimes-{name}-subTasks-{name}-subTasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-migratableservicecoordinatorruntime-migrationtaskruntimes-name-subtasks-name-subtasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks/{name}/subTasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Task Runtime/Migratable Service Coordinator Runtime/Migration Task Runtimes/Sub Tasks/Sub Tasks/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrationTaskRuntimes/{name}/subTasks/{name}/subTasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migratableServiceCoordinatorRuntime-migrationTaskRuntimes-{name}-subTasks-{name}-subTasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-migratableservicecoordinatorruntime-migrationtaskruntimes-name-subtasks-name-subtasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/migrationDataRuntimes":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Migration Data Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Migration Data Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/migrationDataRuntimes GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Migration Data Runtime" }, "description":"" }, "description":"

Returns a list of migration data runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this migration data runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migrationDataRuntimes-get", "x-filename-id":"management-weblogic-version-domainruntime-migrationdataruntimes-get" } }, "/management/weblogic/{version}/domainRuntime/migrationDataRuntimes/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Migration Data Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Migration Data Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/migrationDataRuntimes/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Migration Data Runtime" }, "description":"

Returns this migration data runtime.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this migration data runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-migrationDataRuntimes-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-migrationdataruntimes-name-get" } }, "/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Node Manager Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Node Manager Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Node Manager Runtime" }, "description":"" }, "description":"

Returns a list of node manager runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this node manager runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-nodeManagerRuntimes-get", "x-filename-id":"management-weblogic-version-domainruntime-nodemanagerruntimes-get" } }, "/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Node Manager Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Node Manager Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Node Manager Runtime" }, "description":"

Returns this node manager runtime.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this node manager runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-nodeManagerRuntimes-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-nodemanagerruntimes-name-get" } }, "/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Wsee Policy Subject Manager Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Wsee Policy Subject Manager Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Wsee Policy Subject Manager Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"getPolicyRefStatus", "uri":"/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/getPolicyRefStatus", "description":"

This resource's getPolicyRefStatus action resource.

" }, { "relationship":"action", "title":"isOWSMAttachable", "uri":"/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/isOWSMAttachable", "description":"

This resource's isOWSMAttachable action resource.

" }, { "relationship":"action", "title":"removePolicyReference", "uri":"/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/removePolicyReference", "description":"

This resource's removePolicyReference action resource.

" }, { "relationship":"action", "title":"setPolicyRefStatus", "uri":"/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/setPolicyRefStatus", "description":"

This resource's setPolicyRefStatus action resource.

" } ], "description":"

Returns this wsee policy subject manager runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this wsee policy subject manager runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-policySubjectManagerRuntime-get", "x-filename-id":"management-weblogic-version-domainruntime-policysubjectmanagerruntime-get" } }, "/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/getPolicyRefStatus":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Wsee Policy Subject Manager Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Get Policy Ref Status", "operationId":"/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/getPolicyRefStatus POST-policySubject-policyReferenceURI", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "policyReferenceURI":{ "type":"string", "description":"" }, "policySubject":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "x-internal-id":"management-weblogic-{version}-domainRuntime-policySubjectManagerRuntime-getPolicyRefStatus-post", "x-filename-id":"management-weblogic-version-domainruntime-policysubjectmanagerruntime-getpolicyrefstatus-post" } }, "/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/isOWSMAttachable":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Wsee Policy Subject Manager Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Is OWSM Attachable", "operationId":"/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/isOWSMAttachable POST-policySubject", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"boolean", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "policySubject":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "x-internal-id":"management-weblogic-{version}-domainRuntime-policySubjectManagerRuntime-isOWSMAttachable-post", "x-filename-id":"management-weblogic-version-domainruntime-policysubjectmanagerruntime-isowsmattachable-post" } }, "/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/removePolicyReference":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Wsee Policy Subject Manager Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Remove Policy Reference", "operationId":"/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/removePolicyReference POST-policySubject-policyReferenceURI", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "policyReferenceURI":{ "type":"string", "description":"" }, "policySubject":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "x-internal-id":"management-weblogic-{version}-domainRuntime-policySubjectManagerRuntime-removePolicyReference-post", "x-filename-id":"management-weblogic-version-domainruntime-policysubjectmanagerruntime-removepolicyreference-post" } }, "/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/setPolicyRefStatus":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Wsee Policy Subject Manager Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Set Policy Ref Status", "operationId":"/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/setPolicyRefStatus POST-policySubject-policyReferenceURI-enable", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "enable":{ "type":"boolean", "description":"" }, "policyReferenceURI":{ "type":"string", "description":"" }, "policySubject":{ "type":"string", "description":"" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "x-internal-id":"management-weblogic-{version}-domainRuntime-policySubjectManagerRuntime-setPolicyRefStatus-post", "x-filename-id":"management-weblogic-version-domainruntime-policysubjectmanagerruntime-setpolicyrefstatus-post" } }, "/management/weblogic/{version}/domainRuntime/restartSystemResource":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Domain Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Restart System Resource", "operationId":"/management/weblogic/{version}/domainRuntime/restartSystemResource POST-resource", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "resource":{ "title":"System Resource Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the system resource reference." } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Restarts a system resource on all nodes to which it is deployed.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-restartSystemResource-post", "x-filename-id":"management-weblogic-version-domainruntime-restartsystemresource-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Rollout Service Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Rollout Service Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Rollout Service Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"deleteWorkflow", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/deleteWorkflow", "description":"

This resource's deleteWorkflow action resource.

" }, { "relationship":"action", "title":"execScript", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/execScript", "description":"

This resource's execScript action resource.

" }, { "relationship":"action", "title":"executeWorkflow", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/executeWorkflow", "description":"

This resource's executeWorkflow action resource.

" }, { "relationship":"action", "title":"getWorkflowTask", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/getWorkflowTask", "description":"

This resource's getWorkflowTask action resource.

" }, { "relationship":"action", "title":"initializeRolloutOracleHome", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/initializeRolloutOracleHome", "description":"

This resource's initializeRolloutOracleHome action resource.

" }, { "relationship":"action", "title":"restartNodeManager", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/restartNodeManager", "description":"

This resource's restartNodeManager action resource.

" }, { "relationship":"action", "title":"revertWorkflow", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/revertWorkflow", "description":"

This resource's revertWorkflow action resource.

" }, { "relationship":"action", "title":"rollingRestart", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/rollingRestart", "description":"

This resource's rollingRestart action resource.

" }, { "relationship":"action", "title":"rolloutApplications", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/rolloutApplications", "description":"

This resource's rolloutApplications action resource.

" }, { "relationship":"action", "title":"rolloutJavaHome", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/rolloutJavaHome", "description":"

This resource's rolloutJavaHome action resource.

" }, { "relationship":"action", "title":"rolloutOracleHome", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/rolloutOracleHome", "description":"

This resource's rolloutOracleHome action resource.

" }, { "relationship":"action", "title":"rolloutUpdate", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/rolloutUpdate", "description":"

This resource's rolloutUpdate action resource.

" }, { "relationship":"action", "title":"shutdownServer", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/shutdownServer", "description":"

This resource's shutdownServer action resource.

" }, { "relationship":"action", "title":"startServer", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/startServer", "description":"

This resource's startServer action resource.

" }, { "relationship":"allWorkflows", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows", "description":"

This resource's allWorkflows collection resource.

" }, { "relationship":"inactiveWorkflows", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows", "description":"

This resource's inactiveWorkflows collection resource.

" }, { "relationship":"stoppedWorkflows", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows", "description":"

This resource's stoppedWorkflows collection resource.

" } ], "description":"

Returns this rollout service runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this rollout service runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Workflow Task Runtime/Rollout Service/All Workflows" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Workflow Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Workflow Task Runtime" }, "description":"" }, "description":"

Returns a list of workflow task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this workflow task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-allWorkflows-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-allworkflows-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Workflow Task Runtime/Rollout Service/All Workflows" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Workflow Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Workflow Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"canResume", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/canResume", "description":"

This resource's canResume action resource.

" }, { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"action", "title":"showNextExecuteStep", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextExecuteStep", "description":"

This resource's showNextExecuteStep action resource.

" }, { "relationship":"action", "title":"showNextRevertStep", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextRevertStep", "description":"

This resource's showNextRevertStep action resource.

" }, { "relationship":"action", "title":"waitFor", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/waitFor", "description":"

This resource's waitFor action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this workflow task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this workflow task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-allWorkflows-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-allworkflows-name-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/canResume":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Workflow Task Runtime/Rollout Service/All Workflows/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Can Resume", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/canResume POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"boolean", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-allWorkflows-{name}-canResume-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-allworkflows-name-canresume-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Workflow Task Runtime/Rollout Service/All Workflows/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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 CANCELED or REVERT_CANCELED.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-allWorkflows-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-allworkflows-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextExecuteStep":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Workflow Task Runtime/Rollout Service/All Workflows/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Show Next Execute Step", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextExecuteStep POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-allWorkflows-{name}-showNextExecuteStep-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-allworkflows-name-shownextexecutestep-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextRevertStep":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Workflow Task Runtime/Rollout Service/All Workflows/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Show Next Revert Step", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextRevertStep POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-allWorkflows-{name}-showNextRevertStep-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-allworkflows-name-shownextrevertstep-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Rollout Service/All Workflows/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Task Runtime" }, "description":"" }, "description":"

Returns a list of task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-allWorkflows-{name}-subTasks-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-allworkflows-name-subtasks-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Rollout Service/All Workflows/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-allWorkflows-{name}-subTasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-allworkflows-name-subtasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Task Runtime/Rollout Service/All Workflows/Sub Tasks/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-allWorkflows-{name}-subTasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-allworkflows-name-subtasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Rollout Service/All Workflows/Sub Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Task Runtime" }, "description":"" }, "description":"

Returns a list of task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-allWorkflows-{name}-subTasks-{name}-subTasks-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-allworkflows-name-subtasks-name-subtasks-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Rollout Service/All Workflows/Sub Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-allWorkflows-{name}-subTasks-{name}-subTasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-allworkflows-name-subtasks-name-subtasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Task Runtime/Rollout Service/All Workflows/Sub Tasks/Sub Tasks/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-allWorkflows-{name}-subTasks-{name}-subTasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-allworkflows-name-subtasks-name-subtasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/waitFor":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Workflow Task Runtime/Rollout Service/All Workflows/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Wait For", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/waitFor POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Waits for the process to finish.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-allWorkflows-{name}-waitFor-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-allworkflows-name-waitfor-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/deleteWorkflow":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Rollout Service Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Delete Workflow", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/deleteWorkflow POST-workflowId", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "workflowId":{ "type":"string", "description":"

is ID of workflow to be deleted - WorkflowTaskRuntimeMBean.getWorkflowId()

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Delete workflow data of finished workflow

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-deleteWorkflow-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-deleteworkflow-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/execScript":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Rollout Service Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Exec Script", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/execScript POST-machineName-scriptName-timeoutMillis", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Workflow Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the workflow task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "machineName":{ "type":"string", "description":"

Name of MachineMBean where the NodeManager runs

" }, "scriptName":{ "type":"string", "description":"

Name of script to run

" }, "timeoutMillis":{ "type":"integer", "format":"int64", "description":"

millis to wait for script exec to complete. Once the specified time has elapsed the script process is halted and the NodeManager returns the error denoting the timeout. Default is 0 where we block until completion.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-execScript-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-execscript-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/executeWorkflow":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Rollout Service Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Execute Workflow", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/executeWorkflow POST-wfTask", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Workflow Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the workflow task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "wfTask":{ "title":"Workflow Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the workflow task runtime reference.

which should be executed - continued. delegate.isStopped() must be null

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-executeWorkflow-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-executeworkflow-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/getWorkflowTask":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Rollout Service Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Get Workflow Task", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/getWorkflowTask POST-id", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Workflow Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the workflow task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "id":{ "type":"string", "description":"

of executed workflow

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Returns 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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-getWorkflowTask-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-getworkflowtask-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Workflow Task Runtime/Rollout Service/Inactive Workflows" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Workflow Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Workflow Task Runtime" }, "description":"" }, "description":"

Returns a list of workflow task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this workflow task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-inactiveWorkflows-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-inactiveworkflows-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Workflow Task Runtime/Rollout Service/Inactive Workflows" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Workflow Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Workflow Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"canResume", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/canResume", "description":"

This resource's canResume action resource.

" }, { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"action", "title":"showNextExecuteStep", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextExecuteStep", "description":"

This resource's showNextExecuteStep action resource.

" }, { "relationship":"action", "title":"showNextRevertStep", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextRevertStep", "description":"

This resource's showNextRevertStep action resource.

" }, { "relationship":"action", "title":"waitFor", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/waitFor", "description":"

This resource's waitFor action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this workflow task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this workflow task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-inactiveWorkflows-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-inactiveworkflows-name-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/canResume":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Workflow Task Runtime/Rollout Service/Inactive Workflows/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Can Resume", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/canResume POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"boolean", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-inactiveWorkflows-{name}-canResume-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-inactiveworkflows-name-canresume-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Workflow Task Runtime/Rollout Service/Inactive Workflows/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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 CANCELED or REVERT_CANCELED.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-inactiveWorkflows-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-inactiveworkflows-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextExecuteStep":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Workflow Task Runtime/Rollout Service/Inactive Workflows/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Show Next Execute Step", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextExecuteStep POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-inactiveWorkflows-{name}-showNextExecuteStep-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-inactiveworkflows-name-shownextexecutestep-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextRevertStep":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Workflow Task Runtime/Rollout Service/Inactive Workflows/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Show Next Revert Step", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextRevertStep POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-inactiveWorkflows-{name}-showNextRevertStep-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-inactiveworkflows-name-shownextrevertstep-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Rollout Service/Inactive Workflows/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Task Runtime" }, "description":"" }, "description":"

Returns a list of task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-inactiveWorkflows-{name}-subTasks-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-inactiveworkflows-name-subtasks-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Rollout Service/Inactive Workflows/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-inactiveWorkflows-{name}-subTasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-inactiveworkflows-name-subtasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Task Runtime/Rollout Service/Inactive Workflows/Sub Tasks/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-inactiveWorkflows-{name}-subTasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-inactiveworkflows-name-subtasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Rollout Service/Inactive Workflows/Sub Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Task Runtime" }, "description":"" }, "description":"

Returns a list of task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-inactiveWorkflows-{name}-subTasks-{name}-subTasks-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-inactiveworkflows-name-subtasks-name-subtasks-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Rollout Service/Inactive Workflows/Sub Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-inactiveWorkflows-{name}-subTasks-{name}-subTasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-inactiveworkflows-name-subtasks-name-subtasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Task Runtime/Rollout Service/Inactive Workflows/Sub Tasks/Sub Tasks/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-inactiveWorkflows-{name}-subTasks-{name}-subTasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-inactiveworkflows-name-subtasks-name-subtasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/waitFor":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Workflow Task Runtime/Rollout Service/Inactive Workflows/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Wait For", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/waitFor POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Waits for the process to finish.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-inactiveWorkflows-{name}-waitFor-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-inactiveworkflows-name-waitfor-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/initializeRolloutOracleHome":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Rollout Service Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Initialize Rollout Oracle Home", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/initializeRolloutOracleHome POST-target-rolloutOracleHome-backupOracleHome-isRollback-options", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Rollout Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the rollout task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "backupOracleHome":{ "type":"string", "description":"

the location where the current OracleHome should be moved

" }, "isRollback":{ "type":"string", "description":"

true if the new OracleHome is a lower patch version than the current one

" }, "options":{ "type":"string", "description":"

comma separated list of = options

" }, "rolloutOracleHome":{ "type":"string", "description":"

the location of the new OracleHome to use

" }, "target":{ "type":"string", "description":"

can be the name of a domain, clusters or servers

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-initializeRolloutOracleHome-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-initializerolloutoraclehome-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/restartNodeManager":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Rollout Service Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Restart Node Manager", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/restartNodeManager POST-machineName-isAdminServer-timeoutMillis", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Workflow Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the workflow task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "isAdminServer":{ "type":"boolean", "description":"

true if the affected server is the AdminServer

" }, "machineName":{ "type":"string", "description":"

Name of MachineMBean where NodeManager runs

" }, "timeoutMillis":{ "type":"integer", "format":"int64", "description":"

How long to wait for the client to reconnect to the NodeManager after it restarts. Timeout exceeded will consider the task failed and the NodeManager not reachable. Default is 3 minutes.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-restartNodeManager-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-restartnodemanager-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/revertWorkflow":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Rollout Service Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Revert Workflow", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/revertWorkflow POST-wfTask", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Workflow Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the workflow task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "wfTask":{ "title":"Workflow Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the workflow task runtime reference.

which should be reverted. delegate.isStopped() must be null

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-revertWorkflow-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-revertworkflow-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/rollingRestart":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Rollout Service Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Rolling Restart", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/rollingRestart POST-target-options", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Workflow Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the workflow task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "options":{ "type":"string", "description":"

comma separated list of = options

" }, "target":{ "type":"string", "description":"

can be the name of a domain, clusters or servers

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-rollingRestart-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-rollingrestart-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/rolloutApplications":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Rollout Service Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Rollout Applications", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/rolloutApplications POST-target-applicationProperties-options", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Workflow Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the workflow task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "applicationProperties":{ "type":"string", "description":"

the path of a formatted text file containing the information needed to upgrade applications

" }, "options":{ "type":"string", "description":"

comma separated list of = options

" }, "target":{ "type":"string", "description":"

can be the name of a domain, clusters or servers

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-rolloutApplications-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-rolloutapplications-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/rolloutJavaHome":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Rollout Service Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Rollout Java Home", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/rolloutJavaHome POST-target-javaHome-options", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Workflow Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the workflow task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "javaHome":{ "type":"string", "description":"

the path to the new JavaHome directory

" }, "options":{ "type":"string", "description":"

comma separated list of = options

" }, "target":{ "type":"string", "description":"

can be the name of a domain, clusters or servers

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-rolloutJavaHome-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-rolloutjavahome-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/rolloutOracleHome":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Rollout Service Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Rollout Oracle Home", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/rolloutOracleHome POST-target-rolloutOracleHome-backupOracleHome-isRollback-options", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Rollout Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the rollout task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "backupOracleHome":{ "type":"string", "description":"

the location where the current OracleHome should be moved

" }, "isRollback":{ "type":"string", "description":"

true if the new OracleHome is a lower patch version than the current one

" }, "options":{ "type":"string", "description":"

comma separated list of = options

" }, "rolloutOracleHome":{ "type":"string", "description":"

the location of the new OracleHome to use

" }, "target":{ "type":"string", "description":"

can be the name of a domain, clusters or servers

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-rolloutOracleHome-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-rolloutoraclehome-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/rolloutUpdate":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Rollout Service Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Rollout Update", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/rolloutUpdate POST-target-rolloutOracleHome-backupOracleHome-isRollback-javaHome-applicationProperties-options", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Workflow Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the workflow task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "applicationProperties":{ "type":"string", "description":"

the path of a formatted text file containing the information needed to upgrade applications

" }, "backupOracleHome":{ "type":"string", "description":"

the location where the current OracleHome should be moved

" }, "isRollback":{ "type":"string", "description":"

true if the new OracleHome is a lower patch version than the current one

" }, "javaHome":{ "type":"string", "description":"

the path to the new JavaHome directory

" }, "options":{ "type":"string", "description":"

comma separated list of = options

" }, "rolloutOracleHome":{ "type":"string", "description":"

the location of the new OracleHome to use

" }, "target":{ "type":"string", "description":"

can be the name of a domain, clusters or servers

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-rolloutUpdate-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-rolloutupdate-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/shutdownServer":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Rollout Service Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Shutdown Server", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/shutdownServer POST-serverName-sessionTimeout-ignoreSessions-waitForAllSessions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Workflow Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the workflow task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "ignoreSessions":{ "type":"boolean", "description":"

Drop sessions immediately rather than waiting for them to complete or timeout.

" }, "serverName":{ "type":"string", "description":"

Name of the server that needs to be shutdown

" }, "sessionTimeout":{ "type":"integer", "format":"int32", "description":"

shutdownTimeout Time limit (in seconds) for server to complete a graceful shutdown. The default is 0 indicating no timeout.

" }, "waitForAllSessions":{ "type":"boolean", "description":"

Wait for all sessions (even sessions backed by a server) to complete.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Shutdowns the named server.

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-shutdownServer-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-shutdownserver-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/startServer":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Rollout Service Runtime/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Start Server", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/startServer POST-serverName-sessionTimeout-ignoreSessions-waitForAllSessions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Workflow Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the workflow task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "ignoreSessions":{ "type":"boolean", "description":"

(required for revert) Drop sessions immediately rather than waiting for them to complete or timeout.

" }, "serverName":{ "type":"string", "description":"

Name of managed server to be started

" }, "sessionTimeout":{ "type":"integer", "format":"int32", "description":"

(required for revert) shutdownTimeout Time limit (in seconds) for server to complete a graceful shutdown.

" }, "waitForAllSessions":{ "type":"boolean", "description":"

Wait for all sessions (even sessions backed by a server) to complete.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-startServer-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-startserver-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Workflow Task Runtime/Rollout Service/Stopped Workflows" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Workflow Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Workflow Task Runtime" }, "description":"" }, "description":"

Returns a list of workflow task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this workflow task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-stoppedWorkflows-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-stoppedworkflows-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Workflow Task Runtime/Rollout Service/Stopped Workflows" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Workflow Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Workflow Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"canResume", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/canResume", "description":"

This resource's canResume action resource.

" }, { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"action", "title":"showNextExecuteStep", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextExecuteStep", "description":"

This resource's showNextExecuteStep action resource.

" }, { "relationship":"action", "title":"showNextRevertStep", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextRevertStep", "description":"

This resource's showNextRevertStep action resource.

" }, { "relationship":"action", "title":"waitFor", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/waitFor", "description":"

This resource's waitFor action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this workflow task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this workflow task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-stoppedWorkflows-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-stoppedworkflows-name-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/canResume":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Workflow Task Runtime/Rollout Service/Stopped Workflows/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Can Resume", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/canResume POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"boolean", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-stoppedWorkflows-{name}-canResume-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-stoppedworkflows-name-canresume-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Workflow Task Runtime/Rollout Service/Stopped Workflows/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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 CANCELED or REVERT_CANCELED.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-stoppedWorkflows-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-stoppedworkflows-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextExecuteStep":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Workflow Task Runtime/Rollout Service/Stopped Workflows/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Show Next Execute Step", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextExecuteStep POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-stoppedWorkflows-{name}-showNextExecuteStep-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-stoppedworkflows-name-shownextexecutestep-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextRevertStep":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Workflow Task Runtime/Rollout Service/Stopped Workflows/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Show Next Revert Step", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextRevertStep POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-stoppedWorkflows-{name}-showNextRevertStep-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-stoppedworkflows-name-shownextrevertstep-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Rollout Service/Stopped Workflows/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Task Runtime" }, "description":"" }, "description":"

Returns a list of task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-stoppedWorkflows-{name}-subTasks-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-stoppedworkflows-name-subtasks-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Rollout Service/Stopped Workflows/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-stoppedWorkflows-{name}-subTasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-stoppedworkflows-name-subtasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Task Runtime/Rollout Service/Stopped Workflows/Sub Tasks/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-stoppedWorkflows-{name}-subTasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-stoppedworkflows-name-subtasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Rollout Service/Stopped Workflows/Sub Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Task Runtime" }, "description":"" }, "description":"

Returns a list of task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-stoppedWorkflows-{name}-subTasks-{name}-subTasks-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-stoppedworkflows-name-subtasks-name-subtasks-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Rollout Service/Stopped Workflows/Sub Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-stoppedWorkflows-{name}-subTasks-{name}-subTasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-stoppedworkflows-name-subtasks-name-subtasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Task Runtime/Rollout Service/Stopped Workflows/Sub Tasks/Sub Tasks/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-stoppedWorkflows-{name}-subTasks-{name}-subTasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-stoppedworkflows-name-subtasks-name-subtasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/waitFor":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Workflow Task Runtime/Rollout Service/Stopped Workflows/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Wait For", "operationId":"/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/waitFor POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Waits for the process to finish.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-rolloutService-stoppedWorkflows-{name}-waitFor-post", "x-filename-id":"management-weblogic-version-domainruntime-rolloutservice-stoppedworkflows-name-waitfor-post" } }, "/management/weblogic/{version}/domainRuntime/search":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Search" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"Search The Domain Runtime Tree", "operationId":"/management/weblogic/{version}/domainRuntime/search POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Search Results", "properties":{ }, "description":"" }, "description":"

The search response includes the results of the search.

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Search Criteria", "properties":{ }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

The search request body includes the search criteria.

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Search the domainRuntime tree.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-search-post", "x-filename-id":"management-weblogic-version-domainruntime-search-post" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Server Life Cycle Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Server Life Cycle Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Server Life Cycle Runtime" }, "description":"" }, "description":"

Returns a list of server life cycle runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this server life cycle runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-get", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-get" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Server Life Cycle Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Server Life Cycle Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Server Life Cycle Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"forceShutdown", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceShutdown", "description":"

This resource's forceShutdown action resource.

" }, { "relationship":"action", "title":"forceSuspend", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceSuspend", "description":"

This resource's forceSuspend action resource.

" }, { "relationship":"action", "title":"getIPv4URL", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv4URL", "description":"

This resource's getIPv4URL action resource.

" }, { "relationship":"action", "title":"getIPv6URL", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv6URL", "description":"

This resource's getIPv6URL action resource.

" }, { "relationship":"action", "title":"resume", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/resume", "description":"

This resource's resume action resource.

" }, { "relationship":"action", "title":"shutdown", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown", "description":"

This resource's shutdown action resource.

" }, { "relationship":"action", "title":"start", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/start", "description":"

This resource's start action resource.

" }, { "relationship":"action", "title":"startInAdmin", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInAdmin", "description":"

This resource's startInAdmin action resource.

" }, { "relationship":"action", "title":"startInStandby", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInStandby", "description":"

This resource's startInStandby action resource.

" }, { "relationship":"action", "title":"suspend", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/suspend", "description":"

This resource's suspend action resource.

" }, { "relationship":"tasks", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks", "description":"

This resource's tasks collection resource.

" } ], "description":"

Returns this server life cycle runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this server life cycle runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-get" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceShutdown":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Server Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Force Shutdown", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceShutdown POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Server Life Cycle Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server life cycle task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

Synchronously invoke the forceShutdown action.

This example uses the POST method to synchronously invoke the forceShutdown action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{}\" \\\n-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\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_15_forceShutdown\"\n    }],\n    \"progress\": \"success\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"forceShutdown\",\n    \"taskStatus\": \"TASK COMPLETED\",\n    \"completed\": true\n}

Asynchronously invoke the forceShutdown action.

This example uses the POST method to asynchronously invoke the forceShutdown action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{}\" \\\n-H \"Prefer:respond-async\" \\\n-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\n\nLocation: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_23_forceShutdown\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_23_forceShutdown\"\n    }],\n    \"progress\": \"processing\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"forceShutdown\",\n    \"taskStatus\": \"TASK IN PROGRESS\",\n    \"completed\": false\n}
", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-forceShutdown-post", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-forceshutdown-post" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceSuspend":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Server Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Force Suspend", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceSuspend POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Server Life Cycle Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server life cycle task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

Synchronously invoke the forceSuspend action.

This example uses the POST method to synchronously invoke the forceSuspend action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{}\" \\\n-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\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_8_forceSuspend\"\n    }],\n    \"progress\": \"success\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"forceSuspend\",\n    \"taskStatus\": \"TASK COMPLETED\",\n    \"completed\": true\n}

Asynchronously invoke the forceSuspend action.

This example uses the POST method to asynchronously invoke the forceSuspend action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{}\" \\\n-H \"Prefer:respond-async\" \\\n-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\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_20_forceSuspend\"\n    }],\n    \"progress\": \"success\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"forceSuspend\",\n    \"taskStatus\": \"TASK COMPLETED\",\n    \"completed\": true\n}
", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-forceSuspend-post", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-forcesuspend-post" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv4URL":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Server Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Get IPv4 URL", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv4URL POST-protocol", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "protocol":{ "type":"string", "description":"

the desired protocol

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

The IPv4 URL that clients use when connecting to this server using the specified protocol.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-getIPv4URL-post", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-getipv4url-post" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv6URL":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Server Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Get IPv6 URL", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv6URL POST-protocol", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "type":"string", "description":"

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "protocol":{ "type":"string", "description":"

the desired protocol

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

The IPv6 URL that clients use when connecting to this server using the specified protocol.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-getIPv6URL-post", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-getipv6url-post" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/resume":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Server Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Resume", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/resume POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Server Life Cycle Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server life cycle task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

Synchronously invoke the resume action.

This example uses the POST method to synchronously invoke the resume action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{}\" \\\n-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\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_6_resume\"\n    }],\n    \"progress\": \"success\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"resume\",\n    \"taskStatus\": \"TASK COMPLETED\",\n    \"completed\": true\n}

Asynchronously invoke the resume action.

This example uses the POST method to asynchronously invoke the resume action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{}\" \\\n-H \"Prefer:respond-async\" \\\n-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\n\nLocation: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_18_resume\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_18_resume\"\n    }],\n    \"progress\": \"processing\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"resume\",\n    \"taskStatus\": \"TASK IN PROGRESS\",\n    \"completed\": false\n}
", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-resume-post", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-resume-post" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "Server Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Shutdown ()", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Server Life Cycle Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server life cycle task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Gracefully transitions a server to the SHUTDOWN state. The server completes all current work before it shuts down.

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

Synchronously invoke the shutdown action.

This example uses the POST method to synchronously invoke the shutdown action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{}\" \\\n-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\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_9_shutdown\"\n    }],\n    \"progress\": \"success\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"shutdown\",\n    \"taskStatus\": \"TASK COMPLETED\",\n    \"completed\": true\n}

Asynchronously invoke the shutdown action.

This example uses the POST method to asynchronously invoke the shutdown action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{}\" \\\n-H \"Prefer:respond-async\" \\\n-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\n\nLocation: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_21_shutdown\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_21_shutdown\"\n    }],\n    \"progress\": \"processing\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"shutdown\",\n    \"taskStatus\": \"TASK IN PROGRESS\",\n    \"completed\": false\n}
", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-shutdown-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-shutdown-x-operations-0" }, { "tags":[ "Server Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Shutdown ( Timeout, Ignore Sessions, Wait For All Sessions )", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown POST-timeout-ignoreSessions-waitForAllSessions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Server Life Cycle Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server life cycle task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "ignoreSessions":{ "type":"boolean", "description":"

Set to true to ignore pending HTTP sessions during inflight work handling.

" }, "timeout":{ "type":"integer", "format":"int32", "description":"

Number of seconds to wait before aborting inflight work and force shutting down the server.

" }, "waitForAllSessions":{ "type":"boolean", "description":"

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Gracefully shutdown the server after handling inflight work. The following inflight work is handled :

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

Synchronously invoke the shutdown action.

This example uses the POST method to synchronously invoke the shutdown action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{ timeout: 20, ignoreSessions: true, waitForAllSessions: true }\" \\\n-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\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_13_shutdown\"\n    }],\n    \"progress\": \"success\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"shutdown\",\n    \"taskStatus\": \"TASK COMPLETED\",\n    \"completed\": true\n}

Asynchronously invoke the shutdown action.

This example uses the POST method to asynchronously invoke the shutdown action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{ timeout: 20, ignoreSessions: true, waitForAllSessions: true }\" \\\n-H \"Prefer:respond-async\" \\\n-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\n\nLocation: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_27_shutdown\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_27_shutdown\"\n    }],\n    \"progress\": \"processing\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"shutdown\",\n    \"taskStatus\": \"TASK IN PROGRESS\",\n    \"completed\": false\n}
", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-shutdown-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-shutdown-x-operations-1" }, { "tags":[ "Server Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Shutdown ( Timeout, Ignore Sessions )", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown POST-timeout-ignoreSessions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Server Life Cycle Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server life cycle task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "ignoreSessions":{ "type":"boolean", "description":"

Set to true to ignore pending HTTP sessions during inflight work handling.

" }, "timeout":{ "type":"integer", "format":"int32", "description":"

Number of seconds to wait before aborting inflight work and force shutting down the server.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Gracefully transitions a server to the SHUTDOWN state. The server completes all current work before it shuts down.

This method is the same as calling:

shutdown(timeout, ignoreSessions, false);

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

Synchronously invoke the shutdown action.

This example uses the POST method to synchronously invoke the shutdown action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{ timeout: 20, ignoreSessions: true }\" \\\n-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\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_11_shutdown\"\n    }],\n    \"progress\": \"success\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"shutdown\",\n    \"taskStatus\": \"TASK COMPLETED\",\n    \"completed\": true\n}

Asynchronously invoke the shutdown action.

This example uses the POST method to asynchronously invoke the shutdown action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{ timeout: 20, ignoreSessions: true }\" \\\n-H \"Prefer:respond-async\" \\\n-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\n\nLocation: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_25_shutdown\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_25_shutdown\"\n    }],\n    \"progress\": \"processing\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"shutdown\",\n    \"taskStatus\": \"TASK IN PROGRESS\",\n    \"completed\": false\n}
", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-shutdown-post-x-operations-2", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-shutdown-x-operations-2" } ], "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-shutdown-post", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-shutdown-post" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/start":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "Server Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Start ()", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/start POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Server Life Cycle Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server life cycle task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Uses the Node Manager to start a Managed Server.

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

Synchronously invoke the start action.

This example uses the POST method to synchronously invoke the start action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{}\" \\\n-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/start
Example Response
HTTP/1.1 200 OK\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_4_start\"\n    }],\n    \"identity\": [\n        \"serverLifeCycleRuntimes\",\n        \"Cluster-0-Server-1\",\n        \"tasks\",\n        \"_4_start\"\n    ],\n    \"running\": false,\n    \"systemTask\": false,\n    \"endTimeAsLong\": 1757705980377,\n    \"name\": \"_4_start\",\n    \"progress\": \"success\",\n    \"description\": \"Starting Cluster-0-Server-1 server ...\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"taskError\": null,\n    \"startTimeAsLong\": 1757705972265,\n    \"type\": \"ServerLifeCycleTaskRuntime\",\n    \"operation\": \"start\",\n    \"taskStatus\": \"TASK COMPLETED\",\n    \"parentTask\": null,\n    \"completed\": true,\n    \"intervalToPoll\": 1000,\n    \"startTime\": \"2025-09-12T15:39:32.265-04:00\",\n    \"endTime\": \"2025-09-12T15:39:40.377-04:00\"\n}

Asynchronously invoke the start action.

This example uses the POST method to asynchronously invoke the start action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{}\" \\\n-H \"Prefer:respond-async\" \\\n-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\n\nLocation: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_16_start\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_16_start\"\n    }],\n    \"progress\": \"processing\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"start\",\n    \"taskStatus\": \"TASK IN PROGRESS\",\n    \"completed\": false\n}
", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-start-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-start-x-operations-0" }, { "tags":[ "Server Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Start ( Disable Msi Mode )", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/start POST-disableMsiMode", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Server Life Cycle Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server life cycle task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "disableMsiMode":{ "type":"boolean", "description":"

if true, the server will not start in Managed Server Independence mode

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Uses the Node Manager to start a Managed Server on the given machine

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-start-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-start-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/start post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-start-post", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-start-post" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInAdmin":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Server Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Start In Admin", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInAdmin POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Server Life Cycle Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server life cycle task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Uses the Node Manager to start a Managed Server and place it in the ADMIN state.

The server transitions through the following states:

SHUTDOWNSUSPENDINGSTANDBYADMIN

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-startInAdmin-post", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-startinadmin-post" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInStandby":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Server Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Start In Standby", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInStandby POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Server Life Cycle Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server life cycle task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Uses the Node Manager to start a Managed Server and place it in the STANDBY state.

The server transitions through the following states:

SHUTDOWNSUSPENDINGSTANDBY

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

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-startInStandby-post", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-startinstandby-post" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/suspend":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "x-operations":[ { "tags":[ "Server Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Suspend ()", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/suspend POST", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Server Life Cycle Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server life cycle task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Gracefully suspends server to ADMIN state. New requests are rejected and inflight work is allowed to complete.

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

Synchronously invoke the suspend action.

This example uses the POST method to synchronously invoke the suspend action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{}\" \\\n-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\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_5_suspendWithTimeout\"\n    }],\n    \"progress\": \"success\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"suspendWithTimeout\",\n    \"taskStatus\": \"TASK COMPLETED\",\n    \"completed\": true\n}

Asynchronously invoke the suspend action.

This example uses the POST method to asynchronously invoke the suspend action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{}\" \\\n-H \"Prefer:respond-async\" \\\n-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\n\nLocation: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_17_suspendWithTimeout\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_17_suspendWithTimeout\"\n    }],\n    \"progress\": \"processing\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"suspendWithTimeout\",\n    \"taskStatus\": \"TASK IN PROGRESS\",\n    \"completed\": false\n}
", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-suspend-post-x-operations-0", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-suspend-x-operations-0" }, { "tags":[ "Server Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Suspend ( Timeout, Ignore Sessions )", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/suspend POST-timeout-ignoreSessions", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"Server Life Cycle Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the server life cycle task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "ignoreSessions":{ "type":"boolean", "description":"

drop inflight HTTP sessions during graceful suspend

" }, "timeout":{ "type":"integer", "format":"int32", "description":"

Seconds to wait for server to transition gracefully. The server calls forceSuspend() after timeout.

" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Transitions the server from RUNNING to ADMIN state gracefully.

Applications are in admin mode. Inflight work is completed.

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

Synchronously invoke the suspend action.

This example uses the POST method to synchronously invoke the suspend action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{ timeout: 10, ignoreSessions: true }\" \\\n-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\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_7_suspendWithTimeout\"\n    }],\n    \"progress\": \"success\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"suspendWithTimeout\",\n    \"taskStatus\": \"TASK COMPLETED\",\n    \"completed\": true\n}

Asynchronously invoke the suspend action.

This example uses the POST method to asynchronously invoke the suspend action.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-H Content-Type:application/json \\\n-d \"{ timeout: 10, ignoreSessions: true }\" \\\n-H \"Prefer:respond-async\" \\\n-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\n\nLocation: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_19_suspendWithTimeout\n\nResponse Body:\n{\n    \"links\": [{\n        \"rel\": \"job\",\n        \"href\": \"http:\\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_19_suspendWithTimeout\"\n    }],\n    \"progress\": \"processing\",\n    \"serverName\": \"Cluster-0-Server-1\",\n    \"operation\": \"suspendWithTimeout\",\n    \"taskStatus\": \"TASK IN PROGRESS\",\n    \"completed\": false\n}
", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-suspend-post-x-operations-1", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-suspend-x-operations-1" } ], "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/suspend post-ignored", "description":"ignored", "responses":{ "200":{ "description":"ignored" } }, "summary":"ignored", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-suspend-post", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-suspend-post" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Server Life Cycle Task Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Server Life Cycle Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Server Life Cycle Task Runtime" }, "description":"" }, "description":"

Returns a list of server life cycle task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this server life cycle task runtime collection.

View this server life cycle task runtime collection.

This example uses the GET method to view this server life cycle task runtime collection.

Example Request
curl -v \\\n--user admin:admin123 \\\n-H X-Requested-By:MyClient \\\n-H Accept:application/json \\\n-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\n\nResponse Body:\n{\n    \"items\": [\n        {\n            \"progress\": \"success\",\n            \"serverName\": \"Cluster-0-Server-1\",\n            \"operation\": \"start\",\n            \"completed\": true\n        },\n        {\n            \"progress\": \"success\",\n            \"serverName\": \"Cluster-0-Server-1\",\n            \"operation\": \"shutdown\",\n            \"completed\": true\n        },\n        {\n            \"progress\": \"success\",\n            \"serverName\": \"Cluster-0-Server-1\",\n            \"operation\": \"start\",\n            \"completed\": true\n        }\n    ]\n}
", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-tasks-get", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-tasks-get" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Server Life Cycle Task Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Server Life Cycle Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Server Life Cycle Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this server life cycle task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this server life cycle task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-tasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-tasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Server Life Cycle Task Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-tasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-tasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Server Life Cycle Runtimes/Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Task Runtime" }, "description":"" }, "description":"

Returns a list of task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-tasks-{name}-subTasks-get", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-tasks-name-subtasks-get" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Server Life Cycle Runtimes/Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-tasks-{name}-subTasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-tasks-name-subtasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Task Runtime/Server Life Cycle Runtimes/Tasks/Sub Tasks/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-tasks-{name}-subTasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-tasks-name-subtasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Server Life Cycle Runtimes/Tasks/Sub Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Task Runtime" }, "description":"" }, "description":"

Returns a list of task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-tasks-{name}-subTasks-{name}-subTasks-get", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-tasks-name-subtasks-name-subtasks-get" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/Server Life Cycle Runtimes/Tasks/Sub Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-tasks-{name}-subTasks-{name}-subTasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-tasks-name-subtasks-name-subtasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Task Runtime/Server Life Cycle Runtimes/Tasks/Sub Tasks/Sub Tasks/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverLifeCycleRuntimes-{name}-tasks-{name}-subTasks-{name}-subTasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-serverlifecycleruntimes-name-tasks-name-subtasks-name-subtasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/serverRuntimes":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Server Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Server Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/serverRuntimes GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Server Runtime" }, "description":"" }, "description":"

Returns a list of server runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this server runtime collection.

Note: Monitors all the running servers in the WebLogic Server domain from the administration server. From this resource, you can monitor each managed server.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serverRuntimes-get", "x-filename-id":"management-weblogic-version-domainruntime-serverruntimes-get" } }, "/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Service Migration Data Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Service Migration Data Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Service Migration Data Runtime" }, "description":"" }, "description":"

Returns a list of service migration data runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this service migration data runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serviceMigrationDataRuntimes-get", "x-filename-id":"management-weblogic-version-domainruntime-servicemigrationdataruntimes-get" } }, "/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Service Migration Data Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Service Migration Data Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Service Migration Data Runtime" }, "description":"

Returns this service migration data runtime.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this service migration data runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-serviceMigrationDataRuntimes-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-servicemigrationdataruntimes-name-get" } }, "/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes":{ "parameters":[ { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "System Component Life Cycle Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This System Component Life Cycle Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/System Component Life Cycle Runtime" }, "description":"" }, "description":"

Returns a list of system component life cycle runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this system component life cycle runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-systemComponentLifeCycleRuntimes-get", "x-filename-id":"management-weblogic-version-domainruntime-systemcomponentlifecycleruntimes-get" } }, "/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "System Component Life Cycle Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This System Component Life Cycle Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/System Component Life Cycle Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"shutdown", "uri":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/shutdown", "description":"

This resource's shutdown action resource.

" }, { "relationship":"action", "title":"softRestart", "uri":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/softRestart", "description":"

This resource's softRestart action resource.

" }, { "relationship":"action", "title":"start", "uri":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/start", "description":"

This resource's start action resource.

" }, { "relationship":"tasks", "uri":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks", "description":"

This resource's tasks collection resource.

" } ], "description":"

Returns this system component life cycle runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this system component life cycle runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-systemComponentLifeCycleRuntimes-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-systemcomponentlifecycleruntimes-name-get" } }, "/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/shutdown":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "System Component Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Shutdown", "operationId":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/shutdown POST-props", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"System Component Life Cycle Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the system component life cycle task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "props":{ "type":"object", "description":"

properties to use when shutting down this system component. These properties are used by the nodemanager plugin.

", "additionalProperties":{ "type":"string" }, "title":"Properties" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-systemComponentLifeCycleRuntimes-{name}-shutdown-post", "x-filename-id":"management-weblogic-version-domainruntime-systemcomponentlifecycleruntimes-name-shutdown-post" } }, "/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/softRestart":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "System Component Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Soft Restart", "operationId":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/softRestart POST-props", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"System Component Life Cycle Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the system component life cycle task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "props":{ "type":"object", "description":"

properties to use when soft-restarting this system component. These properties are used by the nodemanager plugin.

", "additionalProperties":{ "type":"string" }, "title":"Properties" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-systemComponentLifeCycleRuntimes-{name}-softRestart-post", "x-filename-id":"management-weblogic-version-domainruntime-systemcomponentlifecycleruntimes-name-softrestart-post" } }, "/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/start":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "System Component Life Cycle Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Start", "operationId":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/start POST-props", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "type":"object", "title":"Return", "properties":{ "return":{ "title":"System Component Life Cycle Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the system component life cycle task runtime reference.

Returns the action's result.

" } }, "description":"" }, "description":"

Returns the following fields:

" } }, "consumes":[ "application/json" ], "parameters":[ { "schema":{ "type":"object", "title":"Arguments", "properties":{ "props":{ "type":"object", "description":"

properties to use when starting this system component. These properties are used by the nodemanager plugin.

", "additionalProperties":{ "type":"string" }, "title":"Properties" } }, "description":"" }, "name":"payload", "required":true, "in":"body", "description":"

Must contain the following fields:

" }, { "$ref":"#/parameters/Request Header Prefer" }, { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

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.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-systemComponentLifeCycleRuntimes-{name}-start-post", "x-filename-id":"management-weblogic-version-domainruntime-systemcomponentlifecycleruntimes-name-start-post" } }, "/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "System Component Life Cycle Task Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This System Component Life Cycle Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/System Component Life Cycle Task Runtime" }, "description":"" }, "description":"

Returns a list of system component life cycle task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this system component life cycle task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-systemComponentLifeCycleRuntimes-{name}-tasks-get", "x-filename-id":"management-weblogic-version-domainruntime-systemcomponentlifecycleruntimes-name-tasks-get" } }, "/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "System Component Life Cycle Task Runtime" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This System Component Life Cycle Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/System Component Life Cycle Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this system component life cycle task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this system component life cycle task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-systemComponentLifeCycleRuntimes-{name}-tasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-systemcomponentlifecycleruntimes-name-tasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "System Component Life Cycle Task Runtime/Actions" ], "security":[ { "Admin":[ ] }, { "Operator":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-systemComponentLifeCycleRuntimes-{name}-tasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-systemcomponentlifecycleruntimes-name-tasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/System Component Life Cycle Runtimes/Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Task Runtime" }, "description":"" }, "description":"

Returns a list of task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-systemComponentLifeCycleRuntimes-{name}-tasks-{name}-subTasks-get", "x-filename-id":"management-weblogic-version-domainruntime-systemcomponentlifecycleruntimes-name-tasks-name-subtasks-get" } }, "/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/System Component Life Cycle Runtimes/Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-systemComponentLifeCycleRuntimes-{name}-tasks-{name}-subTasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-systemcomponentlifecycleruntimes-name-tasks-name-subtasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Task Runtime/System Component Life Cycle Runtimes/Tasks/Sub Tasks/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-systemComponentLifeCycleRuntimes-{name}-tasks-{name}-subTasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-systemcomponentlifecycleruntimes-name-tasks-name-subtasks-name-cancel-post" } }, "/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/System Component Life Cycle Runtimes/Tasks/Sub Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime Collection", "operationId":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Task Runtime" }, "description":"" }, "description":"

Returns a list of task runtime entities.

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime collection.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-systemComponentLifeCycleRuntimes-{name}-tasks-{name}-subTasks-{name}-subTasks-get", "x-filename-id":"management-weblogic-version-domainruntime-systemcomponentlifecycleruntimes-name-tasks-name-subtasks-name-subtasks-get" } }, "/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "get":{ "tags":[ "Task Runtime/System Component Life Cycle Runtimes/Tasks/Sub Tasks/Sub Tasks" ], "security":[ { "Admin":[ ] }, { "Deployer":[ ] }, { "Monitor":[ ] }, { "Operator":[ ] } ], "summary":"View This Task Runtime", "operationId":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name} GET", "produces":[ "application/json" ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/Task Runtime" }, "x-weblogic-links":[ { "relationship":"action", "title":"cancel", "uri":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel", "description":"

This resource's cancel action resource.

" }, { "relationship":"parentTask", "description":"

This resource's parentTask reference to a task runtime resource.

" }, { "relationship":"subTasks", "uri":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/subTasks", "description":"

This resource's subTasks collection resource.

" } ], "description":"

Returns this task runtime.

This method can return the following links:

" } }, "parameters":[ { "$ref":"#/parameters/Query Parameter excludeFields" }, { "$ref":"#/parameters/Query Parameter excludeLinks" }, { "$ref":"#/parameters/Query Parameter fields" }, { "$ref":"#/parameters/Query Parameter links" } ], "description":"

View this task runtime.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-systemComponentLifeCycleRuntimes-{name}-tasks-{name}-subTasks-{name}-subTasks-{name}-get", "x-filename-id":"management-weblogic-version-domainruntime-systemcomponentlifecycleruntimes-name-tasks-name-subtasks-name-subtasks-name-get" } }, "/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel":{ "parameters":[ { "$ref":"#/parameters/Path Parameter name" }, { "$ref":"#/parameters/Path Parameter version" } ], "post":{ "tags":[ "Task Runtime/System Component Life Cycle Runtimes/Tasks/Sub Tasks/Sub Tasks/Actions" ], "security":[ { "Admin":[ ] } ], "summary":"Cancel", "operationId":"/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel POST", "responses":{ "200":{ "description":"

Returns the following fields:

" } }, "parameters":[ { "$ref":"#/parameters/Request Header X-Requested-By" } ], "description":"

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

", "x-internal-id":"management-weblogic-{version}-domainRuntime-systemComponentLifeCycleRuntimes-{name}-tasks-{name}-subTasks-{name}-subTasks-{name}-cancel-post", "x-filename-id":"management-weblogic-version-domainruntime-systemcomponentlifecycleruntimes-name-tasks-name-subtasks-name-subtasks-name-cancel-post" } } }, "definitions":{ "DB Client Data Deployment Runtime":{ "type":"object", "properties":{ "DBClientDataName":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The DBClientData's name.

Constraints

" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "SNMP Agent Runtime":{ "type":"object", "properties":{ "SNMPAgentName":{ "readOnly":true, "type":"string", "description":"

Gets the name of the SNMPAgent MBean configuration that is currently active. Returns null if no SNMPAgent configuration is currently active on this Server.

" }, "UDPListenPort":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

The UDP port on which this SNMP agent is listening for incoming requests from SNMP managers.

SNMP agents can also communicate through the host server's TCP listen port (7001 by default) or through a TCP port that is configured by a custom network channel.

" }, "attributeChangeTrapCount":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The number of attribute change notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

" }, "counterMonitorTrapCount":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The number of counter monitor notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

" }, "failedAuthenticationCount":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

The number of requests that this agent has rejected because of incorrect user credentials.

" }, "failedAuthorizationCount":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

The number of requests that this agent has rejected because an authenticated user does not have sufficient privileges to view the requested information. You use the WebLogic Server security realm to assign privileges to users.

" }, "failedEncryptionCount":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

The number of requests that this agent has rejected because of incorrect privacy (encryption) credentials

" }, "gaugeMonitorTrapCount":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The number of gauge monitor notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

" }, "logMessageTrapCount":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The number of log message notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

" }, "masterAgentXPort":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

The port that this SNMP agent uses to communicate with subagents.

The agent uses subagents to provide access to custom MBeans (MBeans that you create and register) and to other Oracle software components. WebLogic Server SNMP agents do not enable users to register their own subagents.

" }, "monitorTrapCount":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The total number of all notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "running":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether this SNMP agent is running.

" }, "serverStartTrapCount":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The number of serverStart notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

" }, "serverStopTrapCount":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The number of serverShutdown notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

" }, "stringMonitorTrapCount":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The number of string monitor notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "App Deployment Runtime":{ "type":"object", "properties":{ "applicationName":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The application's name.

Constraints

" }, "applicationVersion":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The application's version identifier.

Constraints

" }, "modules":{ "readOnly":true, "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

The list of modules for the application. These modules can be used in module level targeting.

" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "App Runtime State Runtime":{ "type":"object", "properties":{ "applicationIds":{ "readOnly":true, "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Application State":{ "type":"object", "properties":{ "health":{ "type":"string", "description":"" }, "name":{ "type":"string", "description":"" }, "state":{ "type":"string", "description":"" }, "targetStates":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Application Target State" }, "description":"" }, "type":{ "type":"string", "description":"" } }, "description":"" }, "Application Target State":{ "type":"object", "properties":{ "state":{ "type":"string", "description":"" }, "target":{ "type":"string", "description":"" } }, "description":"" }, "Batch Job Repository Runtime":{ "type":"object", "properties":{ "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Certificate Management Domain Runtime":{ "type":"object", "properties":{ "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Current User":{ "type":"object", "properties":{ "user":{ "type":"string", "description":"

The login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.

" } }, "description":"

The authenticated user that is making the request.

" }, "Deployment Manager":{ "type":"object", "properties":{ "maximumDeploymentProgressObjectsCount":{ "type":"integer", "format":"int32", "description":"

The maximum number of progress objects allowed.

" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Deployment Progress Object":{ "type":"object", "properties":{ "applicationName":{ "readOnly":true, "type":"string", "description":"

The name of the application for the current deployment operation.

" }, "completed":{ "type":"boolean", "description":"

This property indicates whether an asynchronous job has completed.

" }, "deploymentMessages":{ "readOnly":true, "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

Provides an ordered array of status messages generated for the current deployment operation.

" }, "endTime":{ "type":"string", "format":"date-time", "description":"

This property indicates the time when the asynchronous job ended.

This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX" }, "failedTargets":{ "readOnly":true, "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

The targets on which the current deployment operation failed.

" }, "id":{ "readOnly":true, "type":"string", "description":"

The unique ID for the current deployment operation.

" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "operationType":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

The deployment operation type for the current deployment operation. Possible values are 1 (start) and 2 (stop).

" }, "progress":{ "enum":[ "succeeded", "processing", "failed" ], "type":"string", "description":"

This property indicates whether an asynchronous job has succeeded, failed, or is in progress.

" }, "rootExceptions":{ "readOnly":true, "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Throwable" }, "description":"

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

" }, "startTime":{ "type":"string", "format":"date-time", "description":"

This property indicates the time when an asynchronous job was started.

This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX" }, "startTimeAsLong":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The time that the current deployment operation began. The value is in milliseconds consistent with the system time.

" }, "state":{ "readOnly":true, "type":"string", "description":"

The state of the current deployment operation. Possible values are STATE_INITIALIZED, STATE_RUNNING, STATE_COMPLETED, STATE_FAILED and STATE_DEFERRED.

" }, "targets":{ "readOnly":true, "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

The targets specified for the current deployment operation.

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Domain Keystores Domain Runtime":{ "type":"object", "properties":{ "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Domain Runtime":{ "type":"object", "properties":{ "activationTime":{ "readOnly":true, "type":"string", "format":"date-time", "description":"

The time when the domain became active.

This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX" }, "name":{ "readOnly":true, "type":"string", "description":"

The user-specified name of this MBean instance.

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

Name=user-specified-name

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Domain Security Runtime":{ "type":"object", "properties":{ "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "securityValidationWarnings":{ "readOnly":true, "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Security Validation Warning V" }, "description":"

Returns a list of potential security validation warnings for this domain. The returned list is similar to those displayed during server startup when secure mode validation is performed. The returned list contains information about each warning including the message id, description, and server name for the warning. If no issues are present, then an empty array is returned. This method caches the validation warnings for each server in the domain. This cache is refreshed on a scheduled basis every 24 hours. To refresh the cache manually, call the refreshCache method.

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Edit Session Configuration Manager":{ "type":"object", "properties":{ "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Edit Session Configuration Runtime":{ "type":"object", "properties":{ "creator":{ "readOnly":true, "type":"string", "description":"

The original creator of the edit session.

" }, "currentEditor":{ "readOnly":true, "type":"string", "description":"

The current editor of the edit session. The editor owns the lock.

" }, "description":{ "readOnly":true, "type":"string", "description":"

The description of the edit session configuration.

" }, "editSessionName":{ "readOnly":true, "type":"string", "description":"

The name of the edit session configuration.

" }, "editSessionServerJndi":{ "readOnly":true, "type":"string", "description":"

The JNDI name of the related EditSessionServer

" }, "mergeNeeded":{ "readOnly":true, "type":"boolean", "description":"

Returns true if another edit session activates its changes after the last activation of this edit session or after its creation but before this edit session was ever activated.

It indicates that this edit session configuration is probably not the actual runtime configuration. Use the resolve method to merge changes to this configuration.

If this edit session configuration was also modified then there can be conflicts between this session and the runtime configuration. Use the resolve method to remove possible inconsistencies.

" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Elastic Service Manager Runtime":{ "type":"object", "properties":{ "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Health State":{ "type":"object", "properties":{ "state":{ "type":"string", "description":"

This property indicates the reported state as:

" }, "subsystemName":{ "type":"string", "description":"

This property indicates the service for which the health state is reported.

" }, "symptoms":{ "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Symptom" }, "description":"

This property indicates the cause of the reported state.

" } }, "description":"

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.

" }, "Lib Deployment Runtime":{ "type":"object", "properties":{ "implementationVersion":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The library's implementation version, null if none is set

Constraints

" }, "libraryIdentifier":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The library's identifier.

Constraints

" }, "libraryName":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The library's name.

Constraints

" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "specificationVersion":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The library's specification version, null if none is set

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Log Runtime":{ "type":"object", "properties":{ "logFileStreamOpened":{ "readOnly":true, "type":"boolean", "description":"

Gets the opened state of the log file stream represented by this instance.

" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Message Driven Control EJB Runtime":{ "type":"object", "properties":{ "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Migratable Service Coordinator Runtime":{ "type":"object", "properties":{ "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Migration Data Runtime":{ "type":"object", "properties":{ "clusterMasterName":{ "readOnly":true, "type":"string", "description":"

Name of the server that acted as the cluster master for this migration.

" }, "clusterName":{ "readOnly":true, "type":"string", "description":"

Name of the server that acted as the cluster master for this migration.

" }, "machineMigratedFrom":{ "readOnly":true, "type":"string", "description":"

Machine from which the server was migrated from

" }, "machineMigratedTo":{ "readOnly":true, "type":"string", "description":"

Machine to which the server was migrated to or is in the process of being migrated to.

" }, "machinesAttempted":{ "readOnly":true, "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

Get all the machines attempted for migration.

" }, "migrationEndTime":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

End time of migration

" }, "migrationStartTime":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

Start time of migration

" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "serverName":{ "readOnly":true, "type":"string", "description":"

Name of the server migrated

" }, "status":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

Name of the server migrated

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Migration Task Runtime":{ "type":"object", "properties":{ "JTA":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether the migration task moves a JTA recovery manager.

" }, "completed":{ "type":"boolean", "description":"

This property indicates whether an asynchronous job has completed.

" }, "description":{ "readOnly":true, "type":"string", "description":"

A description of this task.

" }, "endTime":{ "type":"string", "format":"date-time", "description":"

This property indicates the time when the asynchronous job ended.

This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "parentTask":{ "readOnly":true, "title":"Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the task runtime reference.

The task of which this task is a part.

A value of null indicates that this task is not a subtask.

" }, "progress":{ "readOnly":true, "type":"string", "description":"

The progress of this task.

" }, "running":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether the Task is still running.

" }, "startTime":{ "type":"string", "format":"date-time", "description":"

This property indicates the time when an asynchronous job was started.

This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX" }, "startTimeAsLong":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The time at which this task was started.

" }, "statusCode":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

Provides an int describing the status of this Task.

" }, "systemTask":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether this task was initiated by the server versus a user.

" }, "taskError":{ "readOnly":true, "$ref":"#/definitions/Throwable" }, "taskStatus":{ "readOnly":true, "type":"string", "description":"

The status of this task.

" }, "terminal":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether the Task was successful, failed or was canceled.

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" }, "waitingForUser":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether the Task is waiting for user input.

" } }, "description":"" }, "Node Manager Runtime":{ "type":"object", "properties":{ "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "reachable":{ "readOnly":true, "type":"boolean", "description":"" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Plugin Deployment Runtime":{ "type":"object", "properties":{ "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "pluginName":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The plugin deployment's name.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Rollout Service Runtime":{ "type":"object", "properties":{ "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Scaling Task Runtime":{ "type":"object", "properties":{ "clusterName":{ "readOnly":true, "type":"string", "description":"" }, "completed":{ "type":"boolean", "description":"

This property indicates whether an asynchronous job has completed.

" }, "description":{ "readOnly":true, "type":"string", "description":"

A description of this task.

" }, "endTime":{ "type":"string", "format":"date-time", "description":"

This property indicates the time when the asynchronous job ended.

This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "parentTask":{ "readOnly":true, "title":"Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the task runtime reference.

The task of which this task is a part.

A value of null indicates that this task is not a subtask.

" }, "progress":{ "readOnly":true, "type":"string", "description":"

The progress of this task.

" }, "running":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether the task is still running.

" }, "scaledInstanceNames":{ "readOnly":true, "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"" }, "scalingType":{ "readOnly":true, "type":"string", "description":"" }, "selectedInstanceMetadata":{ "readOnly":true, "type":"object", "description":"", "additionalProperties":{ "type":"string" }, "title":"Properties" }, "selectedInstanceNames":{ "readOnly":true, "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"" }, "startTime":{ "type":"string", "format":"date-time", "description":"

This property indicates the time when an asynchronous job was started.

This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX" }, "startTimeAsLong":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The time at which this task was started.

" }, "success":{ "readOnly":true, "type":"boolean", "description":"" }, "systemTask":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether this task was initiated by the server versus a user.

" }, "taskError":{ "readOnly":true, "$ref":"#/definitions/Throwable" }, "taskStatus":{ "readOnly":true, "type":"string", "description":"

The status of this task.

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Security Validation Warning V":{ "type":"object", "properties":{ "description":{ "readOnly":true, "type":"string", "description":"

Returns the description of the security validation warning.

" }, "id":{ "readOnly":true, "type":"string", "description":"

Returns the id of the security validation warning.

" }, "serverName":{ "readOnly":true, "type":"string", "description":"

Returns the name of the server to which the security validation warning applies.

" } }, "description":"" }, "Server Life Cycle Runtime":{ "type":"object", "properties":{ "middlewareHome":{ "readOnly":true, "type":"string", "description":"

The Oracle Middleware installation directory.

" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "nodeManagerRestartCount":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

Number of times the server has been restarted using the NodeManager since creation. The first start does not count. The count is valid only if the NodeManager is used to start and restart the server everytime.

" }, "state":{ "readOnly":true, "type":"string", "description":"

The current state of the server.

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" }, "weblogicHome":{ "readOnly":true, "type":"string", "description":"

The directory where the WebLogic Server instance (server) is installed, without the trailing \"/server\".

" } }, "description":"" }, "Server Life Cycle Task Runtime":{ "type":"object", "properties":{ "completed":{ "type":"boolean", "description":"

This property indicates whether an asynchronous job has completed.

" }, "description":{ "readOnly":true, "type":"string", "description":"

A description of this task.

" }, "endTime":{ "type":"string", "format":"date-time", "description":"

This property indicates the time when the asynchronous job ended.

This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "operation":{ "readOnly":true, "type":"string", "description":"

Gets the name of the method that was invoked on the ServerLifeCycleRuntime to initiate this task.

" }, "parentTask":{ "readOnly":true, "title":"Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the task runtime reference.

The task of which this task is a part.

A value of null indicates that this task is not a subtask.

" }, "progress":{ "readOnly":true, "type":"string", "description":"

The progress of this task.

" }, "running":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether the task is still running.

" }, "serverName":{ "readOnly":true, "type":"string", "description":"

The name of the server.

" }, "startTime":{ "type":"string", "format":"date-time", "description":"

This property indicates the time when an asynchronous job was started.

This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX" }, "startTimeAsLong":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The time at which this task was started.

" }, "systemTask":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether this task was initiated by the server versus a user.

" }, "taskError":{ "readOnly":true, "$ref":"#/definitions/Throwable" }, "taskStatus":{ "readOnly":true, "type":"string", "description":"

The status of this task.

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Server Runtime":{ "type":"object", "properties":{ "SSLListenPortEnabled":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether the default SSL listen port is enabled on the server

" }, "activationTime":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The time when the server was started.

" }, "adminServer":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether the server is an Administration Server.

" }, "adminServerHost":{ "readOnly":true, "type":"string", "description":"

The address on which the Administration Server is listening for connections. For example, this might return the string: santiago

" }, "adminServerListenPort":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

The port on which the Administration Server is listening for connections.

" }, "adminServerListenPortSecure":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether the port that the server uses for administrative traffic is configured to use a secure protocol.

" }, "administrationPortEnabled":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether the administration port is enabled on the server

" }, "administrationURL":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The URL that the server and its clients use for administrative connections.

If no administration channel is enabled, then this method returns the URL for connections through the default channel. If the default channel is de-activated, this method returns the URL for a secure channel. If no secure channel is enabled, the method returns null.

The returned URL will be consistent with dynamic channel updates.

Constraints

" }, "currentDirectory":{ "readOnly":true, "type":"string", "description":"

The absolute path of the directory from which the server was started.

This may be used in conjunction with other relative paths in ServerMBean to compute full paths.

" }, "currentMachine":{ "type":"string", "description":"

Return the machine on which the server is running. This will be different from the configuration if the server gets migrated automatically.

" }, "defaultURL":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The URL that clients use to connect to this server's default network channel.

The returned value indicates the default protocol, listen address and listen port:

protocol://listen-addresslisten-port

Note: The default protocol, listen address and listen port are persisted in the domain's config.xml file, however when a server instance is started, command-line options can override these persisted values. This getDefaultURL method returns the URL values that are currently being used, not necessarily the values that are specified in config.xml

The returned URL will be consistent with dynamic channel updates.

Constraints

" }, "healthState":{ "readOnly":true, "$ref":"#/definitions/Health State" }, "inSitConfigState":{ "readOnly":true, "type":"boolean", "description":"

Returns true if sitconfig is applied.

" }, "listenPortEnabled":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether the default listen port is enabled on the server.

" }, "middlewareHome":{ "readOnly":true, "type":"string", "description":"

The Oracle Middleware installation directory.

" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "openSocketsCurrentCount":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

The current number of sockets registered for socket muxing on this server.

" }, "overallHealthState":{ "readOnly":true, "$ref":"#/definitions/Health State" }, "patchList":{ "readOnly":true, "x-weblogic-unharvestable":true, "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

Returns information about installed patches on the server as an array of Strings. Each element of the array describes a patch, which is of the form:

BugNumber;PatchID;DateApplied;Description

Constraints

" }, "restartRequired":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether the server must be restarted in order to activate configuration changes.

" }, "serverClasspath":{ "readOnly":true, "type":"string", "description":"

Get the classpath for this server including domain/lib contents that are automatically picked up and appended to the classpath.

" }, "state":{ "readOnly":true, "type":"string", "description":"

The current life cycle state of this server.

For example, a server can be in a RUNNING state in which it can receive and process requests or in an ADMIN state in which it can receive only administrative requests.

" }, "stateVal":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

Returns current state of the server as in integer. weblogic.management.runtime.ServerStates has more information about the available server states

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" }, "weblogicHome":{ "readOnly":true, "type":"string", "description":"

The directory where the WebLogic Server instance (server) is installed, without the trailing \"/server\".

" }, "weblogicVersion":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The version of this WebLogic Server instance (server).

Constraints

" } }, "description":"" }, "Service Migration Data Runtime":{ "type":"object", "properties":{ "clusterName":{ "readOnly":true, "type":"string", "description":"

Name of the cluster

" }, "coordinatorName":{ "readOnly":true, "type":"string", "description":"

Name of the server that acted as the coordinator for this migration.

" }, "destinationsAttempted":{ "readOnly":true, "title":"Items", "type":"array", "items":{ "type":"string", "description":"" }, "description":"

Get all the destinations attempted for migration.

" }, "migratedFrom":{ "readOnly":true, "type":"string", "description":"

Where this object was migrated from

" }, "migratedTo":{ "readOnly":true, "type":"string", "description":"

Where this object was migrated to

" }, "migrationEndTime":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

End time of migration

" }, "migrationStartTime":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

Start time of migration

" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "serverName":{ "readOnly":true, "type":"string", "description":"

Name of the object migrated

" }, "status":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

Status of the migration (SUCCESSFUL, IN_PROGRESS, or FAILED)

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Symptom":{ "type":"object", "properties":{ "info":{ "type":"string", "description":"

This property provides additional information about the symptom if available.

" }, "instanceId":{ "type":"string", "description":"

This property represents an identifier for the symptom.

" }, "severity":{ "type":"string", "description":"

This property indicates a low, medium, or high severity level.

" }, "type":{ "type":"string", "description":"

This property represents the cause of the symptom (low memory, network error, stuck threads, and so on).

" } }, "description":"

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.

" }, "System Component Life Cycle Runtime":{ "type":"object", "properties":{ "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "nodeManagerRestartCount":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

The number of times the server has been restarted using the Node Manager since its creation. The first start does not count. The count is valid only if the Node Manager is used to start and restart the server every time.

" }, "state":{ "readOnly":true, "type":"string", "description":"

The current state of the server.

Server states are described in \"Managing Server Startup and Shutdown for Oracle WebLogic Server.\"

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "System Component Life Cycle Task Runtime":{ "type":"object", "properties":{ "completed":{ "type":"boolean", "description":"

This property indicates whether an asynchronous job has completed.

" }, "description":{ "readOnly":true, "type":"string", "description":"

A description of this task.

" }, "endTime":{ "type":"string", "format":"date-time", "description":"

This property indicates the time when the asynchronous job ended.

This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "operation":{ "readOnly":true, "type":"string", "description":"

Gets the name of the method that was invoked on the ServerLifeCycleRuntime to initiate this task.

" }, "parentTask":{ "readOnly":true, "title":"Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the task runtime reference.

The task of which this task is a part.

A value of null indicates that this task is not a subtask.

" }, "progress":{ "readOnly":true, "type":"string", "description":"

The progress of this task.

" }, "running":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether the task is still running.

" }, "serverName":{ "readOnly":true, "type":"string", "description":"

The name of the server.

" }, "startTime":{ "type":"string", "format":"date-time", "description":"

This property indicates the time when an asynchronous job was started.

This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX" }, "startTimeAsLong":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The time at which this task was started.

" }, "systemTask":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether this task was initiated by the server versus a user.

" }, "taskError":{ "readOnly":true, "$ref":"#/definitions/Throwable" }, "taskStatus":{ "readOnly":true, "type":"string", "description":"

The status of this task.

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Task Runtime":{ "type":"object", "properties":{ "completed":{ "type":"boolean", "description":"

This property indicates whether an asynchronous job has completed.

" }, "description":{ "readOnly":true, "type":"string", "description":"

A description of this task.

" }, "endTime":{ "type":"string", "format":"date-time", "description":"

This property indicates the time when the asynchronous job ended.

This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "parentTask":{ "readOnly":true, "title":"Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the task runtime reference.

The task of which this task is a part.

A value of null indicates that this task is not a subtask.

" }, "progress":{ "readOnly":true, "type":"string", "description":"

The progress of this task.

" }, "running":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether the task is still running.

" }, "startTime":{ "type":"string", "format":"date-time", "description":"

This property indicates the time when an asynchronous job was started.

This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX" }, "startTimeAsLong":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The time at which this task was started.

" }, "systemTask":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether this task was initiated by the server versus a user.

" }, "taskError":{ "readOnly":true, "$ref":"#/definitions/Throwable" }, "taskStatus":{ "readOnly":true, "type":"string", "description":"

The status of this task.

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "Throwable":{ "type":"object", "properties":{ "cause":{ "$ref":"#/definitions/Throwable" }, "message":{ "type":"string", "description":"

This property contains the reason why the error or exception was thrown.

" }, "state":{ "type":"string", "description":"" } }, "description":"

Represents errors and exceptions.

" }, "Version":{ "type":"object", "properties":{ "isLatest":{ "type":"boolean", "description":"

True if this is the default version.

" }, "lifecycle":{ "enum":[ "active", "deprecated" ], "type":"string", "description":"

The lifecycle of this version: active or deprecated

" }, "version":{ "type":"string", "description":"

The name of this version.

" } }, "description":"

Describes a version of the WebLogic Server resources.

" }, "Workflow Task Runtime":{ "type":"object", "properties":{ "completed":{ "type":"boolean", "description":"

This property indicates whether an asynchronous job has completed.

" }, "description":{ "readOnly":true, "type":"string", "description":"

A description of this task.

" }, "endTime":{ "type":"string", "format":"date-time", "description":"

This property indicates the time when the asynchronous job ended.

This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX" }, "errors":{ "readOnly":true, "title":"Items", "type":"array", "items":{ "$ref":"#/definitions/Throwable" }, "description":"

Lists all errors in the workflow.

" }, "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "numCompletedCommands":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

Number of completed commands in the workflow. Together with getNumTotalCommands() defines kind of progress information.

" }, "numTotalCommands":{ "readOnly":true, "type":"integer", "format":"int32", "description":"

Number of all commands in the workflow. Together with getNumCompletedCommands() defines kind of progress information.

" }, "parentTask":{ "readOnly":true, "title":"Task Runtime Reference", "type":"array", "items":{ "type":"string", "description":"" }, "description":"Contains the task runtime reference.

The task of which this task is a part.

A value of null indicates that this task is not a subtask.

" }, "progress":{ "readOnly":true, "type":"string", "description":"

The progress of this task.

" }, "progressString":{ "readOnly":true, "type":"string", "description":"

Human-readable message containing information about the current workflow progress.

" }, "running":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether the task is still running.

" }, "startTime":{ "type":"string", "format":"date-time", "description":"

This property indicates the time when an asynchronous job was started.

This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX" }, "startTimeAsLong":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

The time at which this task was started.

" }, "statusHistory":{ "readOnly":true, "type":"string", "description":"

Provides step by step information (log) about the progress of the workflow.

" }, "systemTask":{ "readOnly":true, "type":"boolean", "description":"

Indicates whether this task was initiated by the server versus a user.

" }, "taskError":{ "readOnly":true, "$ref":"#/definitions/Throwable" }, "taskStatus":{ "readOnly":true, "type":"string", "description":"

The status of this task.

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" }, "workflowId":{ "readOnly":true, "type":"string", "description":"

Each workflow has a unique id.

" }, "workflowName":{ "readOnly":true, "type":"string", "description":"

User defined name of this workflow.

" }, "workflowTarget":{ "readOnly":true, "type":"string", "description":"

Returns the target that was specified when the workflow was created. It will typically be either the name of the domain, of one or more clusters, or one or more servers.

" }, "workflowType":{ "readOnly":true, "type":"string", "description":"

Returns a string that can be used to identify the different types of workflows.

" } }, "description":"" }, "Wsee Policy Subject Manager Runtime":{ "type":"object", "properties":{ "name":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Constraints

" }, "type":{ "readOnly":true, "x-weblogic-unharvestable":true, "type":"string", "description":"

Returns the type of the MBean.

Constraints

" } }, "description":"" }, "X509 Certificate Info V":{ "type":"object", "properties":{ "alias":{ "readOnly":true, "type":"string", "description":"

Get the alias for this certificate.

" }, "entryType":{ "readOnly":true, "type":"string", "description":"

Get the entry type for this certificate: either TRUST_CERTIFICATE or IDENTITY_CERTIFICATE

" }, "issuer":{ "readOnly":true, "type":"string", "description":"

Get the Issuer field from the certificate.

" }, "notAfter":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

Get the Not After field from the certificate (i.e., when the validity period ends).

" }, "notBefore":{ "readOnly":true, "type":"integer", "format":"int64", "description":"

Get the Not Before field from the certificate (i.e., when the validity period starts).

" }, "serialNumber":{ "readOnly":true, "type":"string", "description":"

Get the Serial Number field from the certificate.

" }, "subject":{ "readOnly":true, "type":"string", "description":"

Get the Subject field from the certificate.

" } }, "description":"" } }, "securityDefinitions":{ "Admin":{ "type":"basic", "description":"A user in the Admin security role." }, "Deployer":{ "type":"basic", "description":"A user in the Deployer security role." }, "Monitor":{ "type":"basic", "description":"A user in the Monitor security role." }, "Operator":{ "type":"basic", "description":"A user in the Operator security role." } } }