新しいイメージ・シリーズの追加
POST
/series/{seriesId}
seriesIdパラメータに指定された名前の新しいシリーズ・リソースを作成します。
リクエスト
サポートされるメディア・タイプ
- application/json
パス・パラメータ
- seriesId: string
シリーズの名前。
レスポンス
サポートされるメディア・タイプ
- application/json
200 レスポンス
OK。複数のプロパティを持つシリーズ・リソース表現と、少なくとも"self"リンクを持つlinks配列を含むJSONオブジェクト。
ネストされたスキーマ: singleResourceLinks
タイプ:
ソースの表示
object
- href(optional): string
絶対形式で指定された参照ハイパーリンク要素。
- rel(optional): string
指定できる値:
[ "self", "collection", "up", "describedBy" ]
説明されたリソースを持つリンクの関係のタイプを指定します。
デフォルト・レスポンス
予期しないエラー操作の実行中の問題のエラー詳細を含むJSONオブジェクト。
ルート・スキーマ: 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エラー・コード・ページへのリンク。
例
次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、リクエスト本体body.json
で指定されたイメージ・シリーズを作成してイメージ(オプション)を挿入する方法を示しています。
curl -u restUser -X POST -H "Content-Type: application/json" -d "@body.json" "https://RHP_node_name:8894/rhp-restapi/rhp/series/CRM_DB_Serie1"
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: 229
Date: Tue, 19 Jun 2018 14:03:23 GMT
リクエスト本体(body.json)
レスポンス・ヘッダーの例を次に示します。
{
"imageName": "DB_Image2"
}
レスポンス本体
{
"seriesId": "CRM_DB_Serie1",
"imageNames": ["DB_Image2"],
"subscribedUsers": [],
"links": [{
"uri": "https://RHP_node_name:8894/rhp-restapi/rhp/series/CRM_DB_Serie1",
"rel": "self"
}]
}