フリート・パッチ適用およびプロビジョニング用のREST API

シリーズからのユーザーのサブスクライブ解除

DELETE

/rhp-restapi/rhp/series/{seriesId}/users/{userId}

既存のシリーズのサブスクライブ済ユーザー・リストから既存のユーザーを削除します。

リクエスト

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

application/json

パス・パラメータ

seriesId(必須): string

シリーズの名前。
userId(必須): string

OSユーザー名。

ルート・スキーマ: SubscribeSeriesBody

タイプ: object

ソースの表示

client: string

クライアント・クラスタ名

{
    "type":"object",
    "properties":{
        "client":{
            "type":"string",
            "description":"Client cluster name"
        }
    }
}

先頭に戻る

レスポンス

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

application/json
text/html

200 レスポンス

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

ルート・スキーマ: seriesResource

タイプ: object

ソースの表示

imageNames: array imageNames
links: array links
seriesId: string
subscribedUsers: array subscribedUsers

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

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

タイプ: array

ソースの表示

配列: 文字列

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

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

タイプ: array

ソースの表示

配列: オブジェクト singleResourceLinks

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

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

タイプ: array

ソースの表示

配列: 文字列

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

ネストされたスキーマ: 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オブジェクト。

ルート・スキーマ: 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"
    }
}

先頭に戻る

例

次の例は、cURLを使用してRESTリソースにDELETEリクエストを発行することによって、イメージ・シリーズからサブスクライバを削除する方法を示しています。

curl -u restUser -X DELETE -H "Content-Type: application/json" "https://RHP_node_name:8894/rhp-restapi/rhp/series/CRM_DB_Serie1/users/grid"

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

レスポンス本体

{
     "seriesId": "CRM_DB_Serie1",
     "imageNames": ["DB_Image1", "DB_Image2"],
     "subscribedUsers": [ "oracle"],
     "links": [{
         "uri": "https://RHP_node_name:8894/rhp-restapi/rhp/series/CRM_DB_Serie1",
         "rel": "self"
      }]
}

先頭に戻る