5.20.4 ダッシュボード定義の削除
- 機能
-
URLで指定したダッシュボードIDのダッシュボード定義を削除するAPIです。
管理者用のダッシュボード取得／一覧取得／削除機能が有効の場合，JP1資源グループが「*」，かつ，JP1_Console_Admin権限を持つJP1ユーザーでログインしているときは，ほかのJP1ユーザーが所有するダッシュボード定義も削除できます。それ以外の権限のJP1ユーザーでログインしているとき，または，管理者用のダッシュボード取得／一覧取得／削除機能が無効の場合は，ログインしたJP1ユーザーが所有するダッシュボード定義だけを削除できます。
管理者用のダッシュボード取得／一覧取得／削除機能の有効／無効とログインしたJP1ユーザーの権限に応じて削除できるダッシュボード定義を，次の表に示します。
管理者用のダッシュボード取得／一覧取得／削除機能については，マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.2.4 ダッシュボードのインポート・エクスポート機能と削除機能の拡充」を参照してください。
表5‒19 ログインしているJP1ユーザーの権限に応じて削除できるダッシュボード定義 JP1ユーザーの権限
管理者用のダッシュボード取得／一覧取得／削除機能
有効
無効
JP1資源グループが「*」，かつ，JP1_Console_Admin権限を持つ。
すべてのダッシュボード定義
自身が所有するダッシュボード定義
上記以外
自身が所有するダッシュボード定義
- 実行権限
-
-
JP1_Console_Admin
-
JP1_Console_Operator
-
JP1_Console_User
- 管理者用のダッシュボード取得／一覧取得／削除機能が有効の場合
-
JP1資源グループが「*」，かつ，JP1_Console_Admin権限を持つJP1ユーザーでログインしているときは，ほかのJP1ユーザーが所有するダッシュボード定義も削除できます。
-
- APIのバージョン
-
v1
- 形式
-
- リクエスト行
DELETE /application/component/apiVersion/dashboard/uis/ダッシュボードID httpVersion
- リクエストのヘッダー
-
「5.2.3 リクエスト形式」のリクエストヘッダーに従います。
- リクエストのメッセージボディー
-
なし
- レスポンスのメッセージボディー
削除数
- パラメーター
-
なし
- ステータスコード
-
リクエストに対するレスポンスとして返却されるステータスコードを，次の表に示します。
ステータスコード
出力されるメッセージ
説明
200
−
APIの処理が成功しました。
500
KAJY12011-E
ダッシュボードの削除処理に失敗しました。
- 戻り値
-
-
ステータスコードが200の場合
レスポンスボディーに，次の情報を返却します。
パラメーター名
データ型
省略可否
説明
−
int
不可
削除したダッシュボード定義数を返却します。存在しないダッシュボード定義や参照/編集権限がないダッシュボード定義を指定した場合は0を返却します。
（凡例） −：該当なし
-
ステータスコードが200以外の場合
レスポンスのメッセージボディーに，「5.2.6 エラー発生時のレスポンスメッセージ」に記載されているレスポンス形式の例外オブジェクトが返却されます。
-
- 使用例
-
- リクエスト：
DELETE http://immhost01:20703/im/api/v1/dashboard/uis/1
- レスポンス：
< HTTP/1.1 200 OK < Content-Type: application/json 1