Jump to

• Request
• Response

Get working copy based in client and Oracle Home

get

/rhp-restapi/rhp/workingcopies/fetchWorkingcopy

Returns the working copy matching client and Oracle Home.

Request

Supported Media Types

• application/json

Query Parameters

• client(required): string
  Client cluster name
• path(required): string
  Home path

Back to Top

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.

Body ()

Root Schema : workingcopyResource

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "accessControl":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "additionalBugFixesNotInImage":{
            "type":"string"
        },
        "additionalPatchesComparedToImage":{
            "type":"string"
        },
        "allPatchesAvailableInHome":{
            "type":"string"
        },
        "clusterClient":{
            "type":"string"
        },
        "clusterClass":{
            "type":"string"
        },
        "clusterName":{
            "type":"string"
        },
        "clusterNodes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "clusterType":{
            "type":"string"
        },
        "complete":{
            "type":"boolean",
            "default":false
        },
        "configuredDatabases":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "goldImagePath":{
            "type":"string"
        },
        "groupsConfiguredInWorkingCopy":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "imageName":{
            "type":"string"
        },
        "imageTypeName":{
            "type":"string"
        },
        "oracleBase":{
            "type":"string"
        },
        "owner":{
            "type":"string"
        },
        "softwareHomePath":{
            "type":"string"
        },
        "storageType":{
            "type":"string"
        },
        "workingCopyId":{
            "type":"string"
        },
        "workPath":{
            "type":"string"
        },
        "softwareOnly":{
            "type":"boolean",
            "default":false
        },
        "clusterNameAlias":{
            "type":"string"
        },
        "clusterMode":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/singleResourceLinks"
            }
        }
    }
}

Nested Schema : accessControl

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : clusterNodes

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : configuredDatabases

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : groupsConfiguredInWorkingCopy

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object singleResourceLinks

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/singleResourceLinks"
    }
}

Nested Schema : singleResourceLinks

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Specify the type of relationship the link has with the described resource.",
            "enum":[
                "self",
                "collection",
                "up",
                "describedBy"
            ]
        },
        "href":{
            "type":"string",
            "description":"The referenced hyperlink element provided in an absolute format."
        }
    }
}

Default Response

Unexpected error. A JSON object containing error details of the issue while executing the operation.

Body ()

Root Schema : errorResource

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer",
            "description":"HTTP status code."
        },
        "type":{
            "type":"string",
            "description":"Link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "errorDetails":{
            "type":"array",
            "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
            "items":{
                "$ref":"#/definitions/errorResource"
            }
        },
        "errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code, related to the error message shown at tittle."
        }
    }
}

Nested Schema : errorDetails

Type: array

If multiple errors are reported they can be organized in a hierarchical structure in this array.

Show Source

• Array of: object errorResource

{
    "type":"array",
    "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
    "items":{
        "$ref":"#/definitions/errorResource"
    }
}

Back to Top