ジャンプ先

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

すべての作業用コピーの取得

GET

/rhp-restapi/rhp/workingcopies

サーバーで使用可能な作業用コピーの名前のリストを返します。

リクエスト

この操作にはリクエスト・パラメータはありません。

レスポンス

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

• application/json

200 レスポンス

OK。少なくともIdプロパティを持つ0個以上の要素が移入された"items"プロパティと、少なくとも"self"リンクを持つlinks配列を含むJSONオブジェクト。

Body ()

ルート・スキーマ: arrayOfItems

タイプ: object

ソースの表示

• items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/singleResource"
            }
        }
    }
}

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

タイプ: array

ソースの表示

• [0]: object singleResource

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

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

タイプ: object

ソースの表示

• links(optional): array links
• resourceId(optional): string

{
    "type":"object",
    "properties":{
        "resourceId":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/singleResourceLinks"
            }
        }
    }
}

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

タイプ: array

ソースの表示

• [0]: object singleResourceLinks

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

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

タイプ: object

ソースの表示

• href(optional): string
  絶対形式で指定された参照ハイパーリンク要素。
• rel(optional): 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(optional): string
  tittleに表示されるエラー・メッセージに関連する、アプリケーション固有のエラー・コード。
• errorDetails(optional): array errorDetails
  複数のエラーがレポートされている場合は、この配列の階層構造に編成できます。
• errorPath(optional): string
  エラーの発生場所を示すXPathまたはJSONパス。
• instance(optional): string
  エラーに関する詳細を提供するリンクへのURI。
• status(optional): integer
  HTTPステータス・コード。
• title(optional): string
  要約エラー・メッセージ。
• type(optional): 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

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

ソースの表示

• [0]: 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"
        }
    ]
}

例

次の例は、cURLを使用してRESTリソースにGETリクエストを送信することによって、使用可能なすべての作業用コピーのリストを取得する方法を示しています。

curl -u restUser -X GET "https://RHP_node_name:8894/rhp-restapi/rhp/workingcopies" 	

HTTPステータス・コードとレスポンス・ヘッダー

レスポンス・ヘッダーの例を次に示します。

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: 239
Date:  Tue, 19 Jun 2018 14:03:23 GMT

レスポンス本体

{
  "items": [
    {
      "workingCopyId": "DB_WCopy1",
      "links": [{
                      "uri": "https://RHP_node_name:8894/rhp-restapi/rhp/workingcopies/DB_WCopy1",
                      "rel": "self"
          }
      ]
    }
  ]
}