5.20.2　ダッシュボード定義の一覧取得

機能

ダッシュボード定義の一覧を取得するAPIです。

定義されているダッシュボードの定義（ダッシュボード定義オブジェクト）の配列を取得します。ただし，ダッシュボード定義オブジェクトのdata（パネルデータ）の値はnullとなります。取得する配列の数に上限はありません。

管理者用のダッシュボード取得／一覧取得／削除機能が有効の場合，JP1資源グループが「*」，かつ，JP1_Console_Admin権限を持つJP1ユーザーでログインしているときは，ほかのJP1ユーザーが所有するダッシュボード定義も含めた一覧を取得します。それ以外の権限のJP1ユーザーでログインしているとき，または，管理者用のダッシュボード取得／一覧取得／削除機能が無効の場合は，ログインしたJP1ユーザーが所有するダッシュボード定義の一覧と，公開範囲が「共有」であるダッシュボード定義の一覧を，併せて取得します。

管理者用のダッシュボード取得／一覧取得／削除機能の有効/無効とログインしたJP1ユーザーの権限に応じて一覧で取得できるダッシュボード定義を，次の表に示します。

管理者用のダッシュボード取得／一覧取得／削除機能については，マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.2.4 ダッシュボードのインポート・エクスポート機能と削除機能の拡充」を参照してください。

表5‒18　ログインしているJP1ユーザーの権限に応じて一覧で取得できるダッシュボード定義
JP1ユーザーの権限	管理者用のダッシュボード取得／一覧取得／削除機能
JP1ユーザーの権限	有効	無効
JP1資源グループが「*」，かつ，JP1_Console_Admin権限を持つ。	すべてのダッシュボード定義	自身が所有，または，共有のダッシュボード定義^※
上記以外	自身が所有，または，共有のダッシュボード定義^※	自身が所有，または，共有のダッシュボード定義^※

注※: ログインしたJP1ユーザーが所有するダッシュボード定義の一覧と，公開範囲が「共有」であるダッシュボード定義の一覧を併せて取得します。

実行権限

JP1_Console_Admin
JP1_Console_Operator
JP1_Console_User

管理者用のダッシュボード取得／一覧取得／削除機能が有効の場合: JP1資源グループが「*」，かつ，JP1_Console_Adminの操作権限を持つJP1ユーザーでログインしているときは，ほかのJP1ユーザーが所有するダッシュボード定義も含めて一覧で取得できます。

APIのバージョン

形式

リクエスト行

GET /application/component/apiVersion/dashboard/uis httpVersion

リクエストのヘッダー

「5.2.3 リクエスト形式」のリクエストヘッダーに従います。

リクエストのメッセージボディー

なし

レスポンスのメッセージボディー

ダッシュボード定義オブジェクトの配列

パラメーター

なし

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを，次の表に示します。

ステータスコード	出力されるメッセージ	説明
200	−	APIの処理が成功しました。
500	KAJY12007-E	ダッシュボードの取得処理に失敗しました。

戻り値

ステータスコードが200の場合

レスポンスのメッセージボディーに，「7.2.6(1) ダッシュボード定義オブジェクト」に記載されているダッシュボード定義オブジェクトの配列が返却されます。
ステータスコードが200以外の場合

レスポンスのメッセージボディーに，「5.2.6 エラー発生時のレスポンスメッセージ」に記載されているレスポンス形式の例外オブジェクトが返却されます。

使用例

リクエスト：

GET http://immhost01:20703/im/api/v1/dashboard/uis

レスポンス：

< HTTP/1.1 200 OK
< Content-Type: application/json
[
    {
        "id": 1,
        "title": "CPU使用率週次レポート",
        "memo": "{\"sid\":\"_ROOT_AllSystems/_HOST_HOST8150143/_CATEGORY_otherApplications/_OBJECT_JP1BASETRAP\"}",
        "data": null,
        "owner": "jp1user1",
        "scope": "protected",
        "createTime": 1710566717,
        "updateTime": 1710566717
    },
    {
        "id": 2,
        "title": "メモリ使用量週次レポート",
        "memo": "{\"sid\":\"_ROOT_AllSystems/_HOST_HOST8150143/_CATEGORY_otherApplications/_OBJECT_JP1BASETRAP\"}",
        "data": null,
        "owner": "jp1user2",
        "scope": "protected",
        "createTime": 1710566717,
        "updateTime": 1710566717
    }
]

ページの先頭へ

5.20.2 ダッシュボード定義の一覧取得

5.20.2　ダッシュボード定義の一覧取得