Mapオブジェクト

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

マップ

マップオブジェクトには以下のプロパティがあります。

プロパティ 型 説明
sysmapid ID マップのID。

プロパティの動作:
- 読み取り専用
- 更新操作で 必須
height integer マップの高さ（ピクセル単位）。

プロパティの動作:
- 作成操作で 必須
name string マップ名。

プロパティの動作:
- 作成操作で 必須
width integer マップの幅（ピクセル単位）。

プロパティの動作:
- 作成操作で 必須
backgroundid ID マップの背景として使用される画像のID。
background_scale integer 背景画像の縦横比を維持したスケーリングを有効にするかどうか。

指定可能な値:
0 - スケーリングを無効にする;
1 - (デフォルト) 画像のスケーリングを有効にする。
expand_macros integer マップの設定時にラベル内のマクロを展開するかどうか。

指定可能な値:
0 - (デフォルト) マクロを展開しない;
1 - マクロを展開する。
expandproblem integer 問題が1件のみの要素について、障害トリガーを表示するかどうか。

指定可能な値:
0 - 常に障害数を表示する;
1 - (デフォルト) 障害が1件のみの場合は障害トリガーを表示する。
grid_align integer グリッドへの整列を有効にするかどうか。

指定可能な値:
0 - グリッドへの整列を無効にする;
1 - (デフォルト) グリッドへの整列を有効にする。
grid_show integer マップ上にグリッドを表示するかどうか。

指定可能な値:
0 - グリッドを表示しない;
1 - (デフォルト) グリッドを表示する。
grid_size integer マップグリッドのサイズ（ピクセル単位）。

サポートされる値: 20、40、50、75、100。

デフォルト: 50。
highlight integer アイコンのハイライトを有効にするかどうか。

指定可能な値:
0 - ハイライト無効;
1 - (デフォルト) ハイライト有効。
iconmapid ID マップで使用されるアイコンマップのID。
label_format integer 高度なラベルを有効にするかどうか。

指定可能な値:
0 - (デフォルト) 高度なラベルを無効にする;
1 - 高度なラベルを有効にする。
label_location integer マップ要素ラベルの位置。

指定可能な値:
0 - (デフォルト) 下;
1 - 左;
2 - 右;
3 - 上。
label_string_host string ホスト要素のカスタムラベル。

プロパティの動作:
- label_type_host が "custom" に設定されている場合は 必須
label_string_hostgroup string ホストグループ要素のカスタムラベル。

プロパティの動作:
- label_type_hostgroup が "custom" に設定されている場合は 必須
label_string_image string 画像要素のカスタムラベル。

プロパティの動作:
- label_type_image が "custom" に設定されている場合は 必須
label_string_map string マップ要素のカスタムラベル。

プロパティの動作:
- label_type_map が "custom" に設定されている場合は 必須
label_string_trigger string トリガー要素のカスタムラベル。

プロパティの動作:
- label_type_trigger が "custom" に設定されている場合は 必須
label_type integer マップ要素ラベルのタイプ。

指定可能な値:
0 - ラベル;
1 - IPアドレス;
2 - (デフォルト) 要素名;
3 - ステータスのみ;
4 - なし。
label_type_host integer ホスト要素のラベルタイプ。

指定可能な値:
0 - ラベル;
1 - IPアドレス;
2 - (デフォルト) 要素名;
3 - ステータスのみ;
4 - なし;
5 - カスタム。
label_type_hostgroup integer ホストグループ要素のラベルタイプ。

指定可能な値:
0 - ラベル;
2 - (デフォルト) 要素名;
3 - ステータスのみ;
4 - なし;
5 - カスタム。
label_type_image integer ホストグループ要素のラベルタイプ。

指定可能な値:
0 - ラベル;
2 - (デフォルト) 要素名;
4 - なし;
5 - カスタム。
label_type_map integer マップ要素のラベルタイプ。

指定可能な値:
0 - ラベル;
2 - (デフォルト) 要素名;
3 - ステータスのみ;
4 - なし;
5 - カスタム。
label_type_trigger integer トリガー要素のラベルタイプ。

指定可能な値:
0 - ラベル;
2 - (デフォルト) 要素名;
3 - ステータスのみ;
4 - なし;
5 - カスタム。
markelements integer 最近ステータスが変化したマップ要素をハイライトするかどうか。

指定可能な値:
0 - (デフォルト) 要素をハイライトしない;
1 - 要素をハイライトする。
severity_min integer マップに表示されるトリガーの最小深刻度。

サポートされるトリガー深刻度の一覧については、trigger severity プロパティを参照してください。
show_element_label integer 要素ラベルのデフォルトの表示方法。

指定可能な値:
0 - 常に表示;
1 - (デフォルト) 自動非表示。
show_link_label integer リンクラベルのデフォルトの表示方法。

指定可能な値:
0 - 常に表示;
1 - (デフォルト) 自動非表示。
show_unack integer 障害の表示方法。

指定可能な値:
0 - (デフォルト) すべての障害数を表示する;
1 - 未確認の障害数のみを表示する;
2 - 確認済みと未確認の障害数を別々に表示する。
userid ID マップの所有者であるユーザーのID。
private integer マップ共有のタイプ。

指定可能な値:
0 - 公開マップ;
1 - (デフォルト) 非公開マップ。
show_suppressed integer 抑制された障害を表示するかどうか。

指定可能な値:
0 - (デフォルト) 抑制された障害を非表示にする;
1 - 抑制された障害を表示する。

マップ要素

マップ要素オブジェクトは、マップ上に表示されるオブジェクトを定義します。
このオブジェクトには、以下のプロパティがあります。

Property Type Description
selementid ID マップ要素のID。

プロパティの動作:
- read-only
elements array 要素データオブジェクト。

プロパティの動作:
- elementtype が "host"、"map"、"trigger"、または "host group" に設定されている場合は required
elementtype integer マップ要素のタイプ。

指定可能な値:
0 - ホスト;
1 - マップ;
2 - トリガー;
3 - ホストグループ;
4 - 画像。

プロパティの動作:
- required
iconid_off ID デフォルト状態で要素を表示するために使用される画像のID。

プロパティの動作:
- required
areatype integer ホストグループ内の各ホストをどのように表示するか。

指定可能な値:
0 - (default) ホストグループ要素がマップ全体を占有する;
1 - ホストグループ要素が固定サイズになる。
elementsubtype integer ホストグループ要素をマップ上でどのように表示するか。

指定可能な値:
0 - (default) ホストグループを単一の要素として表示する;
1 - グループ内の各ホストを個別に表示する。
evaltype integer マップ要素のタグフィルタリング条件の評価方法。

指定可能な値:
0 - (default) And/Or;
2 - Or。
height integer 固定サイズのホストグループ要素の高さ（ピクセル単位）。

デフォルト: 200。
iconid_disabled ID 無効なマップ要素を表示するために使用される画像のID。

プロパティの動作:
- elementtype が "host"、"map"、"trigger"、または "host group" に設定されている場合に supported
iconid_maintenance ID メンテナンス中のマップ要素を表示するために使用される画像のID。

プロパティの動作:
- elementtype が "host"、"map"、"trigger"、または "host group" に設定されている場合に supported
iconid_on ID 障害のあるマップ要素を表示するために使用される画像のID。

プロパティの動作:
- elementtype が "host"、"map"、"trigger"、または "host group" に設定されている場合に supported
label string 要素のラベル。
label_location integer マップ要素ラベルの位置。

指定可能な値:
-1 - (default) デフォルトの位置;
0 - 下;
1 - 左;
2 - 右;
3 - 上。
permission integer 権限レベルのタイプ。

指定可能な値:
-1 - なし;
2 - 読み取り専用;
3 - 読み書き。
show_label integer 要素ラベルの表示方法。

指定可能な値:
-1 - (default) マップのデフォルト;
0 - 常に表示;
1 - 自動的に非表示。
sysmapid ID この要素が属するマップのID。

プロパティの動作:
- read-only
urls array マップ要素のURL。

マップ要素URLオブジェクトについては、以下で詳しく説明します。
use_iconmap integer ホスト要素に対してアイコンマッピングを使用するかどうか。

指定可能な値:
0 - アイコンマッピングを使用しない;
1 - (default) アイコンマッピングを使用する。
viewtype integer ホストグループ要素の配置アルゴリズム。

指定可能な値:
0 - (default) グリッド。
width integer 固定サイズのホストグループ要素の幅（ピクセル単位）。

デフォルト: 200。
x integer 要素のX座標（ピクセル単位）。

デフォルト: 0。
y integer 要素のY座標（ピクセル単位）。

デフォルト: 0。
zindex integer マップ要素の順序付けに使用される値（z-index）。

デフォルト: 0。

マップ要素 ホスト

マップ要素のホストオブジェクトは、1つのホスト要素を定義します。

プロパティ Type 説明
hostid ID ホストのID。

マップ要素 ホストグループ

マップ要素のホストグループオブジェクトは、1つのホストグループ要素を定義します。

プロパティ Type 説明
groupid ID ホストグループのID。

マップ要素 Map

マップ要素のMapオブジェクトは、1つのマップ要素を定義します。

プロパティ Type 説明
sysmapid ID マップのID。

マップ要素 トリガー

マップ要素のトリガーオブジェクトは、1つ以上のトリガー要素を定義します。

プロパティ Type 説明
triggerid ID トリガーのID。

マップ要素タグ

マップ要素のタグオブジェクトには、以下のプロパティがあります。

プロパティ 型 説明
tag string マップ要素のタグ名。

プロパティの動作:
- 必須
operator integer マップ要素のタグ条件の演算子。

使用可能な値:
0 - (デフォルト) 含む;
1 - 等しい;
2 - 含まない;
3 - 等しくない;
4 - 存在する;
5 - 存在しない。
value string マップ要素のタグ値。

マップ要素URL

マップ要素URLオブジェクトは、特定のマップ要素で利用可能なクリック可能なリンクを定義します。以下のプロパティがあります。

プロパティ 型 説明
sysmapelementurlid ID マップ要素URLのID。

プロパティの動作:
- 読み取り専用
name string リンクのキャプション。

プロパティの動作:
- 必須
url string リンクURL。

プロパティの動作:
- 必須
selementid ID このURLが属するマップ要素のID。

マップリンク

マップリンクオブジェクトは、2つのマップ要素間のリンクを定義します。以下の プロパティがあります。

プロパティ 型 説明
linkid ID マップリンクのID。

プロパティの動作:
- 読み取り専用
sysmapid ID リンクが属するマップのID。
selementid1 ID 一方の端でリンクされる最初のマップ要素のID。

プロパティの動作:
- 必須
selementid2 ID もう一方の端でリンクされる最初のマップ要素のID。

プロパティの動作:
- 必須
drawtype integer リンク線の描画スタイル。

指定可能な値:
0 - (デフォルト) 実線;
2 - 太線;
3 - 点線;
4 - 破線。
color string 16進数カラーコードで表した線の色。

デフォルト: 000000。
label string リンクラベル。
show_label integer リンクラベルの表示方法。

指定可能な値:
-1 - (デフォルト) マップのデフォルト;
0 - 常に表示;
1 - 自動的に非表示。
indicator_type integer リンクインジケーターのタイプを選択します。

指定可能な値:
0 - (デフォルト) 静的リンク;
1 - トリガー;
2 - アイテムの値。
linktriggers array リンクステータスインジケーターとして使用するマップリンクトリガー。

マップリンクトリガーオブジェクトの詳細は以下で説明しています。

プロパティの動作:
- indicator_type が "trigger" (1) に設定されている場合は 必須。
itemid ID アイテムのID。

プロパティの動作:
- indicator_type が "item value" (2) に設定されている場合は 必須。
highlights array リンクステータスインジケーターとして使用するマップリンクハイライト。

マップリンクインジケーターオブジェクトの詳細は以下で説明しています。

プロパティの動作:
- indicator_type が "item value" (2) に設定されている場合は 必須。
thresholds array リンクステータスインジケーターとして使用するマップリンクしきい値。

マップリンクインジケーターオブジェクトの詳細は以下で説明しています。

プロパティの動作:
- indicator_type が "item value" (2) に設定されている場合は 必須。
permission integer 権限レベルのタイプ。

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

マップリンクトリガー

マップリンクトリガーオブジェクトは、トリガーの状態に基づくマップリンクのステータスインジケーターを定義します。次のプロパティがあります。

プロパティ 型 説明
triggerid ID リンクインジケーターとして使用されるトリガーのID。

プロパティの動作:
- 必須
color string 16進数のカラーコードによるインジケーターの色。

デフォルト: DD0000。
drawtype integer インジケーターの描画スタイル。

使用可能な値:
0 - (デフォルト) 線;
2 - 太線;
3 - 点線;
4 - 破線。

マップリンクインジケーター

マップリンクインジケーターオブジェクトは、アイテムの値に基づくマップリンクのステータスインジケーターを定義します。 このオブジェクトには、次のプロパティがあります。

プロパティ Type 説明
pattern string 比較対象の正規表現です。ハイライトでのみ使用できます。
sortorder integer ハイライトのソート順を定義するために使用されます。ハイライトでのみ使用できます。
threshold string 比較対象の数値です。しきい値でのみ使用できます。
drawtype integer インジケーターの描画スタイルです。

使用可能な値:
0 - (デフォルト) 実線;
2 - 太線;
3 - 点線;
4 - 破線。
color string 16進数のカラーコードで指定するインジケーターの色です。

デフォルト: DD0000。

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

マップURL

マップURLオブジェクトは、マップ上の特定のタイプのすべての要素で利用可能な、クリック可能なリンクを定義します。以下のプロパティがあります。

プロパティ Type 説明
sysmapurlid ID マップURLのID。

Property behavior:
- read-only
name string リンクのキャプション。

Property behavior:
- required
url string リンクURL。

Property behavior:
- required
elementtype integer URLを利用可能にするマップ要素のタイプ。

サポートされているタイプの一覧については、マップ要素のtypeプロパティを参照してください。

デフォルト: 0。
sysmapid ID このURLが属するマップのID。

マップユーザー

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

プロパティ 型 説明
sysmapuserid ID マップユーザーのID。

プロパティの動作:
- 読み取り専用
userid ID ユーザーのID。

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

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

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

マップユーザーグループ

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

プロパティ 型 説明
sysmapusrgrpid ID マップユーザーグループのID。

プロパティの動作:
- 読み取り専用
usrgrpid ID ユーザーグループのID。

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

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

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

マップ図形

マップ図形オブジェクトは、マップ上に表示される幾何学図形（テキストありまたはなし）を定義します。 このオブジェクトには、以下のプロパティがあります。

Property Type Description
sysmap_shapeid ID マップ図形要素のID。

プロパティの動作:
- 読み取り専用
type integer マップ図形要素のタイプ。

使用可能な値:
0 - 長方形;
1 - 楕円。

新しい図形を作成する場合、このプロパティは必須です。

プロパティの動作:
- 必須
x integer 図形のX座標（ピクセル単位）。

デフォルト: 0。
y integer 図形のY座標（ピクセル単位）。

デフォルト: 0。
width integer 図形の幅（ピクセル単位）。

デフォルト: 200。
height integer 図形の高さ（ピクセル単位）。

デフォルト: 200。
text string 図形のテキスト。
font integer 図形内のテキストのフォント。

使用可能な値:
0 - Georgia, serif
1 - “Palatino Linotype”, “Book Antiqua”, Palatino, serif
2 - “Times New Roman”, Times, serif
3 - Arial, Helvetica, sans-serif
4 - “Arial Black”, Gadget, sans-serif
5 - “Comic Sans MS”, cursive, sans-serif
6 - Impact, Charcoal, sans-serif
7 - “Lucida Sans Unicode”, “Lucida Grande”, sans-serif
8 - Tahoma, Geneva, sans-serif
9 - “Trebuchet MS”, Helvetica, sans-serif
10 - Verdana, Geneva, sans-serif
11 - “Courier New”, Courier, monospace
12 - “Lucida Console”, Monaco, monospace

デフォルト: 9。
font_size integer フォントサイズ（ピクセル単位）。

デフォルト: 11。
font_color string フォントの色。

デフォルト: 000000。
text_halign integer テキストの水平方向の配置。

使用可能な値:
0 - 中央;
1 - 左;
2 - 右。

デフォルト: 0。
text_valign integer テキストの垂直方向の配置。

使用可能な値:
0 - 中央;
1 - 上;
2 - 下。

デフォルト: 0。
border_type integer 枠線のタイプ。

使用可能な値:
0 - なし;
1 - —————;
2 - ·····;
3 - - - -。

デフォルト: 0。
border_width integer 枠線の幅（ピクセル単位）。

デフォルト: 0。
border_color string 枠線の色。

デフォルト: 000000。
background_color string 背景色（塗りつぶし色）。

デフォルト: (空)。
zindex integer すべての図形および線の順序付けに使用される値（z-index）。

デフォルト: 0。

マップの線

マップの線オブジェクトは、マップ上に表示される線を定義します。
このオブジェクトには、以下のプロパティがあります。

プロパティ 型 説明
sysmap_shapeid ID マップ図形要素のID。

プロパティの動作:
- 読み取り専用
x1 integer 線の点1のX座標（ピクセル単位）。

デフォルト: 0。
y1 integer 線の点1のY座標（ピクセル単位）。

デフォルト: 0。
x2 integer 線の点2のX座標（ピクセル単位）。

デフォルト: 200。
y2 integer 線の点2のY座標（ピクセル単位）。

デフォルト: 200。
line_type integer 線の種類。

使用可能な値:
0 - なし;
1 - —————;
2 - ·····;
3 - - - -.

デフォルト: 0。
line_width integer 線の幅（ピクセル単位）。

デフォルト: 0。
line_color string 線の色。

デフォルト: 000000。
zindex integer すべての図形および線の順序付けに使用される値（z-index）。

デフォルト: 0。