Dashboardオブジェクト

次のオブジェクトは、dashboardAPIに直接関連しています。

ダッシュボード

ダッシュボードオブジェクトには、以下のプロパティがあります。

プロパティ 型 説明
dashboardid ID ダッシュボードのID。

プロパティの動作:
- 読み取り専用
- 更新操作では必須
name string ダッシュボードの名前。

プロパティの動作:
- 作成操作では必須
userid ID ダッシュボードの所有者であるユーザーのID。
private integer ダッシュボードの共有タイプ。

指定可能な値:
0 - パブリックダッシュボード;
1 - (デフォルト) プライベートダッシュボード。
display_period integer デフォルトのページ表示期間（秒単位）。

指定可能な値: 10, 30, 60, 120, 600, 1800, 3600。

デフォルト: 30。
auto_start integer スライドショーを自動開始します。

指定可能な値:
0 - スライドショーを自動開始しない;
1 - (デフォルト) スライドショーを自動開始する。

ダッシュボードページ

ダッシュボードページオブジェクトには、以下のプロパティがあります。

プロパティ Type 説明
dashboard_pageid ID ダッシュボードページのID。

プロパティの動作:
- 読み取り専用
name string ダッシュボードページ名。

デフォルト: 空文字列。
display_period integer ダッシュボードページの表示期間（秒単位）。

指定可能な値: 0、10、30、60、120、600、1800、3600。

デフォルト: 0（デフォルトのページ表示期間が使用されます）。
widgets array ダッシュボードウィジェットオブジェクトの配列。

ダッシュボードウィジェット

ダッシュボードウィジェットオブジェクトには、以下のプロパティがあります。

プロパティ 型 説明
widgetid ID ダッシュボードウィジェットのID。

プロパティの動作:
- 読み取り専用
type string ダッシュボードウィジェットのタイプ。

指定可能な値:
actionlog - アクションログ;
clock - 時計;
discovery - ディスカバリーステータス;
favgraphs - お気に入りグラフ;
favmaps - お気に入りマップ;
gauge - ゲージ;
geomap - ジオマップ;
graph - グラフ（クラシック）;
graphprototype - グラフプロトタイプ;
honeycomb - ハニカム;
hostavail - ホストの可用性;
hostcard - ホストカード;
hostnavigator - ホストナビゲーター;
itemcard - アイテムカード;
itemhistory - アイテム履歴;
itemnavigator - アイテムナビゲーター;
item - アイテムの値;
map - マップ;
navtree - マップナビゲーションツリー;
piechart - 円グラフ;
problemhosts - 障害ホスト;
problems - 障害;
problemsbysv - 深刻度別の障害;
slareport - SLAレポート;
svggraph - グラフ;
systeminfo - システム情報;
tophosts - 上位ホスト;
topitems - 上位アイテム;
toptriggers - 上位トリガー;
trigover - トリガーの概要;
url - URL;
web - Web監視。

プロパティの動作:
- 必須
name string カスタムウィジェット名。
x integer ダッシュボードの左端からの水平方向の位置。

指定可能な値の範囲は 0 から 71 です。
y integer ダッシュボードの上端からの垂直方向の位置。

指定可能な値の範囲は 0 から 63 です。
width integer ウィジェットの幅。

指定可能な値の範囲は 1 から 72 です。
height integer ウィジェットの高さ。

指定可能な値の範囲は 1 から 64 です。
view_mode integer ウィジェットの表示モード。

指定可能な値:
0 - (デフォルト) デフォルトのウィジェット表示;
1 - ヘッダーを非表示;
fields array ダッシュボードウィジェットフィールドオブジェクトの配列。

プロパティの動作:
- ダッシュボードウィジェットフィールド の各ウィジェットを参照
ダッシュボードウィジェットフィールド

ダッシュボードウィジェットフィールドオブジェクトには、以下のプロパティがあります。

プロパティ 型 説明
type integer ウィジェットフィールドのタイプ。

指定可能な値:
0 - 整数;
1 - 文字列;
2 - ホストグループ;
3 - ホスト;
4 - アイテム;
5 - アイテムのプロトタイプ;
6 - グラフ;
7 - グラフのプロトタイプ;
8 - マップ;
9 - サービス;
10 - SLA;
11 - ユーザー;
12 - アクション;
13 - メディアタイプ。

プロパティの動作:
- 必須
name string ウィジェットフィールド名。

指定可能な値: ダッシュボードウィジェットフィールドを参照してください。

プロパティの動作:
- 必須
value mixed タイプに応じたウィジェットフィールドの値。

指定可能な値: ダッシュボードウィジェットフィールドを参照してください。

プロパティの動作:
- 必須

ダッシュボードユーザーグループ

ユーザーグループに基づくダッシュボード権限の一覧です。以下の プロパティがあります。

プロパティ Type 説明
usrgrpid ID ユーザーグループのID。

プロパティの動作:
- 必須
permission integer 権限レベルの種類。

指定可能な値:
2 - 読み取り専用;
3 - 読み書き。

プロパティの動作:
- 必須

ダッシュボードユーザー

ユーザーに基づくダッシュボード権限の一覧です。以下の プロパティがあります。

プロパティ Type 説明
userid ID ユーザーのID。

Property behavior:
- required
permission integer 権限レベルの種類。

指定可能な値:
2 - 読み取り専用;
3 - 読み取り/書き込み。

Property behavior:
- required