Get working copy details
get
/rhp-restapi/rhp/workingcopies/{workingCopyId}
Return the working copy configuration.
Request
Supported Media Types
- application/json
Path Parameters
-
workingCopyId(required): string
Name of the working copy.
Response
Supported Media Types
- application/json
- text/html
200 Response
OK. A JSON object containing a working copy resource representation with multiple properties and the links array with at least the "self" link.
Root Schema : workingcopyResource
Type:
Show Source
object
-
accessControl:
array accessControl
-
additionalBugFixesNotInImage:
string
-
additionalPatchesComparedToImage:
string
-
allPatchesAvailableInHome:
string
-
clusterClass:
string
-
clusterClient:
string
-
clusterMode:
string
-
clusterName:
string
-
clusterNameAlias:
string
-
clusterNodes:
array clusterNodes
-
clusterType:
string
-
complete:
boolean
Default Value:
false
-
configuredDatabases:
array configuredDatabases
-
goldImagePath:
string
-
groupsConfiguredInWorkingCopy:
array groupsConfiguredInWorkingCopy
-
imageName:
string
-
imageTypeName:
string
-
links:
array links
-
oracleBase:
string
-
owner:
string
-
softwareHomePath:
string
-
softwareOnly:
boolean
Default Value:
false
-
storageType:
string
-
workingCopyId:
string
-
workPath:
string
Nested Schema : singleResourceLinks
Type:
Show Source
object
-
href:
string
The referenced hyperlink element provided in an absolute format.
-
rel:
string
Allowed Values:
[ "self", "collection", "up", "describedBy" ]
Specify the type of relationship the link has with the described resource.
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:
string
Application specific error code, related to the error message shown at tittle.
-
errorDetails:
array errorDetails
If multiple errors are reported they can be organized in a hierarchical structure in this array.
-
errorPath:
string
XPath or JSON path to indicate where the error occurs.
-
instance:
string
URI to the link that provides more detail about the error.
-
status:
integer
HTTP status code.
-
title:
string
Summary error message.
-
type:
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 view the configuration details of a working copy by submitting a GET request on the REST resource using cURL.
curl -u restUser -X GET "https://RHP_node_name:8894/rhp-restapi/rhp/workingcopies/DB_WCopy181"
HTTP Status Code and Response Headers
The following shows an example of the response header.
HTTP/1.1 200
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: 845
Date: Tue, 19 Jun 2018 14:03:23 GMT
Response Body
{
"links": [{
"uri": "https://RHP_node_name:8894/rhp-restapi/rhp/workingcopies/DB_Wcopy181",
"rel": "self"
}
],
"workPath": "",
"imageName": "DB_Image1",
"workingCopyId": "DB_Wcopy181",
"complete": true,
"clusterClient": "clusterClientNodeName01",
"oracleBase": "/oracle/wcobase1",
"accessControl": ["USER:gridUser1@clusterClientNodeName01","ROLE:GH_WC_ADMIN"],
"additionalBugFixesNotInImage": "",
"additionalPatchesComparedToImage": "",
"allPatchesAvailableInHome": "",
"configuredDatabases": ["dbwc1","dbwc2"],
"goldImagePath": "",
"groupsConfiguredInWorkingCopy": ["OSDBA=svrtech","OSOPER=svrtech","OSBACKUP=svrtech","OSDG=svrtech","OSKM=svrtech","OSRAC=svrtech"],
"softwareHomePath": "/oracle/dbwc1",
"storageType": "LOCAL",
"imageTypeName": "ORACLEDBSOFTWARE",
"owner": "gridUser1@clusterClientNodeName01"
}