Table of Contents

Mapオブジェクト

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	単一の問題を持つ要素に対して問題トリガーを表示するかどうか。設定可能な値: 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	マップ上に表示されるトリガーの最小深刻度。サポートされるトリガーの深刻度についてはトリガーの`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 - 抑制された問題を表示。

マップ要素

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

プロパティ	型	説明
selementid	ID	マップ要素のID。プロパティの動作: - 読み取り専用
elements	array	要素データオブジェクト。プロパティの動作: - `elementtype`が「ホスト」、「マップ」、「トリガー」または「ホストグループ」に設定されている場合は必須
elementtype	integer	マップ要素のタイプ。可能な値: 0 - ホスト; 1 - マップ; 2 - トリガー; 3 - ホストグループ; 4 - イメージ。プロパティの動作: - 必須
iconid_off	ID	デフォルト状態で要素を表示するために使用されるイメージのID。プロパティの動作: - 必須
areatype	integer	ホストグループのホストをどのように表示するか。可能な値: 0 - (デフォルト) ホストグループ要素がマップ全体を占有する; 1 - ホストグループ要素が固定サイズになる。
elementsubtype	integer	ホストグループ要素をマップ上でどのように表示するか。可能な値: 0 - (デフォルト) ホストグループを単一の要素として表示; 1 - グループ内の各ホストを個別に表示。
evaltype	integer	マップ要素タグフィルタ条件の評価方法。可能な値: 0 - (デフォルト) And/Or; 2 - Or。
height	integer	固定サイズのホストグループ要素の高さ（ピクセル単位）。デフォルト: 200。
iconid_disabled	ID	無効なマップ要素を表示するために使用されるイメージのID。プロパティの動作: - `elementtype`が「ホスト」、「マップ」、「トリガー」または「ホストグループ」に設定されている場合にサポート
iconid_maintenance	ID	メンテナンス中のマップ要素を表示するために使用されるイメージのID。プロパティの動作: - `elementtype`が「ホスト」、「マップ」、「トリガー」または「ホストグループ」に設定されている場合にサポート
iconid_on	ID	問題のあるマップ要素を表示するために使用されるイメージのID。プロパティの動作: - `elementtype`が「ホスト」、「マップ」、「トリガー」または「ホストグループ」に設定されている場合にサポート
label	string	要素のラベル。
label_location	integer	マップ要素ラベルの位置。可能な値: -1 - (デフォルト) デフォルト位置; 0 - 下; 1 - 左; 2 - 右; 3 - 上。
permission	integer	権限レベルのタイプ。可能な値: -1 - なし; 2 - 読み取り専用; 3 - 読み書き。
show_label	integer	要素ラベルの表示方法。可能な値: -1 - (デフォルト) マップのデフォルト; 0 - 常に表示; 1 - 自動非表示。
sysmapid	ID	要素が属するマップのID。プロパティの動作: - 読み取り専用
urls	array	マップ要素のURL。マップ要素URLオブジェクトは以下で詳細に説明されています。
use_iconmap	integer	ホスト要素にアイコンマッピングを使用するかどうか。可能な値: 0 - アイコンマッピングを使用しない; 1 - (デフォルト) アイコンマッピングを使用する。
viewtype	integer	ホストグループ要素の配置アルゴリズム。可能な値: 0 - (デフォルト) グリッド。
width	integer	固定サイズのホストグループ要素の幅（ピクセル単位）。デフォルト: 200。
x	integer	要素のX座標（ピクセル単位）。デフォルト: 0。
y	integer	要素のY座標（ピクセル単位）。デフォルト: 0。
zindex	integer	マップ要素の順序付けに使用される値（z-index）。デフォルト: 0。

マップ要素ホスト

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

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

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

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

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

マップ要素マップ

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

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

マップ要素トリガー

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

プロパティ	タイプ	説明
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 - 破線。

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

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

プロパティ	タイプ	説明
pattern	string	比較する正規表現。ハイライトでのみ利用可能。
sortorder	integer	ハイライトのソート順を定義するために使用。ハイライトでのみ利用可能。
threshold	string	比較する数値。しきい値でのみ利用可能。
drawtype	integer	インジケーターの描画スタイル。利用可能な値: 0 - (デフォルト) 線; 2 - 太線; 3 - 点線; 4 - 破線。
color	string	16進数カラーコードで指定するインジケーターの色。デフォルト: `DD0000`。プロパティの動作: - 必須

マップURL

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

プロパティ	タイプ	説明
sysmapurlid	ID	マップURLのID。プロパティの動作: - 読み取り専用
name	string	リンクのキャプション。プロパティの動作: - 必須
url	string	リンクのURL。プロパティの動作: - 必須
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 - 読み書き。プロパティの動作: - 必須

マップシェイプ

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

プロパティ	型	説明
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。

Documentation