Delete working copy
delete
/workingcopies/{workingCopyId}
Delete the specified workingcopy from the server.
Request
Supported Media Types
- application/json
Path Parameters
-
workingCopyId: string
Name of the working copy.
describe
Root Schema : DeleteWorkingCopyBody
Type:
Show Source
object
-
auth(optional):
string
Use an authentication plugin to access the remote node
-
authArgs(optional):
object authArgs
Additional Properties Allowed: additionalPropertiesAdditional properties for the selected authentication plugin
-
cc(optional):
string
List of users to whom email notifications will be sent, in addition to owner of working copy
-
cred(optional):
string
Credential name to associate the user/password credentials to access a remote node
-
force(optional):
boolean
To forcibly delete the database working copy
-
notify(optional):
boolean
Send email notification
-
root(optional):
boolean
Use root credentials to access the remote node
-
schedule(optional):
string
Preferred time to execute the operation
-
sudoPath(optional):
string
location of sudo binary
-
sudoUser(optional):
string
perform super user operations as sudo user name
-
superUserPasswd(optional):
string
The password for the super user account
-
targetNode(optional):
string
Name of a node in a remote cluster with no Rapid Home Provisioning Client
-
userActionData(optional):
string
Value to be passed to useractiondata parameter of useraction script
Nested Schema : authArgs
Type:
object
Additional Properties Allowed
Show Source
Additional properties for the selected authentication plugin
Security
-
basicAuthentication: basic
Type:
basic
Response
Supported Media Types
- application/json
202 Response
Accepted. A JSON object containing job resource details of the accepted operation to obtain status and output of the progress.
Headers
-
Location: string
URL to the job that will execute the operation
Nested Schema : singleResourceLinks
Type:
Show Source
object
-
href(optional):
string
The referenced hyperlink element provided in an absolute format.
-
rel(optional):
string
Allowed Values:
[ "self", "collection", "up", "describedBy" ]
Specify the type of relationship the link has with the described resource.
Nested Schema : collectionResourceLinks
Type:
Show Source
object
-
href(optional):
string
The referenced hyperlink element provided in an absolute format with the correct URL parameters.
-
rel(optional):
string
Allowed Values:
[ "next", "prev", "first", "last" ]
Specify the type of relationship the link has with the described resource.
400 Response
Bad Request. A JSON object containing error details of the issue found while parsing a parameter value or name.
Root Schema : errorResource
Type:
Show Source
object
-
errorCode(optional):
string
Application specific error code, related to the error message shown at title.
-
errorDetails(optional):
array errorDetails
If multiple errors are reported they can be organized in a hierarchical structure in this array.
-
errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
instance(optional):
string
URI to the link that provides more detail about the error.
-
status(optional):
integer
HTTP status code.
-
title(optional):
string
Summary error message.
-
type(optional):
string
Link to HTTP error code page.
Nested Schema : errorDetails
Type:
array
If multiple errors are reported they can be organized in a hierarchical structure in this array.
Show Source
Default Response
Unexpected error. A JSON object containing error details of the issue while executing the operation.
Root Schema : errorResource
Type:
Show Source
object
-
errorCode(optional):
string
Application specific error code, related to the error message shown at title.
-
errorDetails(optional):
array errorDetails
If multiple errors are reported they can be organized in a hierarchical structure in this array.
-
errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
instance(optional):
string
URI to the link that provides more detail about the error.
-
status(optional):
integer
HTTP status code.
-
title(optional):
string
Summary error message.
-
type(optional):
string
Link to HTTP error code page.
Nested Schema : errorDetails
Type:
array
If multiple errors are reported they can be organized in a hierarchical structure in this array.
Show Source
Examples
The following example shows how to delete a workingcopy with name DBWC_1
by submitting a DELETE
request on the REST resource using cURL.
curl -u restUser -X DELETE -H "Content-Type: application/json" -d "@body.json" "https://RHP_node_name:8894/rhp-restapi/rhp/workingcopies/DBWC_1"
HTTP Status Code and Response Headers
The following shows an example of the response header.
HTTP/1.1 202
Location: https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET,PUT,POST,DELETE,PATCH,OPTIONS
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Content-Length, Authorization
Connection: keep-alive
Content-Type: application/json
Content-Length: 168
Date: Tue, 19 Jun 2018 14:03:23 GMT
Request Body (body.json)
{
"force" : true
}
Response Body
{
"links": [{
"uri": "https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1",
"rel": "self"
}],
"jobId": "1",
"output": { }
}}