ジャンプ先

• リクエスト
• レスポンス

クライアントおよびOracle Homeに基づく作業用コピーの取得

GET

/rhp-restapi/rhp/workingcopies/fetchWorkingcopy

クライアントおよびOracle Homeに一致する作業用コピーを返します。

リクエスト

サポートされるメディア・タイプ

• application/json

問合せパラメータ

• client(必須): string
  クライアント・クラスタ名
• path(必須): string
  ホーム・パス

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json
• text/html

200 レスポンス

OK。複数のプロパティを持つ作業用コピー・リソース表現と、少なくとも"self"リンクを持つlinks配列を含むJSONオブジェクト。

Body ()

ルート・スキーマ: workingcopyResource

タイプ: 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
  デフォルト値: false
• configuredDatabases: array configuredDatabases
• goldImagePath: string
• groupsConfiguredInWorkingCopy: array groupsConfiguredInWorkingCopy
• imageName: string
• imageTypeName: string
• links: array links
• oracleBase: string
• owner: string
• softwareHomePath: string
• softwareOnly: boolean
  デフォルト値: 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"
            }
        }
    }
}

ネストされたスキーマ: accessControl

タイプ: array

ソースの表示

• 配列: 文字列

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

ネストされたスキーマ: clusterNodes

タイプ: array

ソースの表示

• 配列: 文字列

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

ネストされたスキーマ: configuredDatabases

タイプ: array

ソースの表示

• 配列: 文字列

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

ネストされたスキーマ: groupsConfiguredInWorkingCopy

タイプ: array

ソースの表示

• 配列: 文字列

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

ネストされたスキーマ: links

タイプ: array

ソースの表示

• 配列: オブジェクト singleResourceLinks

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

ネストされたスキーマ: singleResourceLinks

タイプ: object

ソースの表示

• href: string
  絶対形式で指定された参照ハイパーリンク要素。
• rel: string
  指定できる値: [ "self", "collection", "up", "describedBy" ]

  説明されたリソースを持つリンクの関係のタイプを指定します。

{
    "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."
        }
    }
}

デフォルト・レスポンス

予期しないエラー操作の実行中の問題のエラー詳細を含むJSONオブジェクト。

Body ()

ルート・スキーマ: errorResource

タイプ: object

ソースの表示

• errorCode: string
  tittleに表示されるエラー・メッセージに関連する、アプリケーション固有のエラー・コード。
• errorDetails: array errorDetails
  複数のエラーがレポートされている場合は、この配列の階層構造に編成できます。
• errorPath: string
  エラーの発生場所を示すXPathまたはJSONパス。
• instance: string
  エラーに関する詳細を提供するリンクへのURI。
• status: integer
  HTTPステータス・コード。
• title: string
  要約エラー・メッセージ。
• type: string
  HTTPエラー・コード・ページへのリンク。

{
    "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."
        }
    }
}

ネストされたスキーマ: errorDetails

タイプ: array

複数のエラーがレポートされている場合は、この配列の階層構造に編成できます。

ソースの表示

• 配列: オブジェクト errorResource

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

先頭に戻る