Dashboardオブジェクト

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

ダッシュボード

dashboard オブジェクトには次のプロパティがあります。

Property Type Description
dashboardid ID ダッシュボードのID。

Property behavior:
- read-only
- 更新操作では required
name string ダッシュボードの名前。

Property behavior:
- 作成操作では required
userid ID ダッシュボードの所有者であるユーザーのID。
private integer ダッシュボード共有の種類。

Possible values:
0 - public dashboard;
1 - (default) private dashboard.
display_period integer デフォルトのスライドショー間隔（秒）。

Possible values: 10, 30, 60, 120, 600, 1800, 3600.

Default: 30.
auto_start integer スライドショーを自動開始するかどうか。

Possible values:
0 - do not auto start slideshow;
1 - (default) auto start slideshow.

ダッシュボードページ

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

Property Type Description
dashboard_pageid ID ダッシュボードページのID。

Property behavior:
- read-only
name string ダッシュボードページ名。

Default: empty string.
display_period integer ダッシュボードのスライドショー間隔（秒）。

Possible values: 0, 10, 30, 60, 120, 600, 1800, 3600.

Default: 0 (will use the default slideshow interval).
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 - 深刻度別の障害;
scatterplot - 散布図;
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 説明
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。

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

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

Property behavior:
- required

ダッシュボードユーザー

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

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

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

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

Property behavior:
- required