Karten-Objekt

Die folgenden Objekte stehen in direktem Zusammenhang mit der map API.

Karte

Das Kartenobjekt hat die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
sysmapid ID ID der Karte.

Verhalten der Eigenschaft:
- schreibgeschützt
- erforderlich für Aktualisierungsvorgänge
height integer Höhe der Karte in Pixeln.

Verhalten der Eigenschaft:
- erforderlich für Erstellungsvorgänge
name string Name der Karte.

Verhalten der Eigenschaft:
- erforderlich für Erstellungsvorgänge
width integer Breite der Karte in Pixeln.

Verhalten der Eigenschaft:
- erforderlich für Erstellungsvorgänge
backgroundid ID ID des Bildes, das als Hintergrund für die Karte verwendet wird.
background_scale integer Ob die proportionale Skalierung des Hintergrundbildes aktiviert werden soll.

Mögliche Werte:
0 - Skalierung deaktivieren;
1 - (Standard) Bildskalierung aktivieren.
expand_macros integer Ob Makros in Beschriftungen beim Konfigurieren der Karte erweitert werden sollen.

Mögliche Werte:
0 - (Standard) Makros nicht erweitern;
1 - Makros erweitern.
expandproblem integer Ob der Problem-Auslöser für Elemente mit genau einem Problem angezeigt wird.

Mögliche Werte:
0 - immer die Anzahl der Probleme anzeigen;
1 - (Standard) den Problem-Auslöser anzeigen, wenn es nur ein Problem gibt.
grid_align integer Ob die Ausrichtung am Raster aktiviert werden soll.

Mögliche Werte:
0 - Ausrichtung am Raster deaktivieren;
1 - (Standard) Ausrichtung am Raster aktivieren.
grid_show integer Ob das Raster auf der Karte angezeigt werden soll.

Mögliche Werte:
0 - Raster nicht anzeigen;
1 - (Standard) Raster anzeigen.
grid_size integer Größe des Kartenrasters in Pixeln.

Unterstützte Werte: 20, 40, 50, 75 und 100.

Standard: 50.
highlight integer Ob die Hervorhebung von Symbolen aktiviert ist.

Mögliche Werte:
0 - Hervorhebung deaktiviert;
1 - (Standard) Hervorhebung aktiviert.
iconmapid ID ID der Symbolzuordnung, die auf der Karte verwendet wird.
label_format integer Ob erweiterte Beschriftungen aktiviert werden sollen.

Mögliche Werte:
0 - (Standard) erweiterte Beschriftungen deaktivieren;
1 - erweiterte Beschriftungen aktivieren.
label_location integer Position der Beschriftung des Kartenelements.

Mögliche Werte:
0 - (Standard) unten;
1 - links;
2 - rechts;
3 - oben.
label_string_host string Benutzerdefinierte Beschriftung für Host-Elemente.

Verhalten der Eigenschaft:
- erforderlich, wenn label_type_host auf „custom“ gesetzt ist
label_string_hostgroup string Benutzerdefinierte Beschriftung für Hostgruppen-Elemente.

Verhalten der Eigenschaft:
- erforderlich, wenn label_type_hostgroup auf „custom“ gesetzt ist
label_string_image string Benutzerdefinierte Beschriftung für Bildelemente.

Verhalten der Eigenschaft:
- erforderlich, wenn label_type_image auf „custom“ gesetzt ist
label_string_map string Benutzerdefinierte Beschriftung für Kartenelemente.

Verhalten der Eigenschaft:
- erforderlich, wenn label_type_map auf „custom“ gesetzt ist
label_string_trigger string Benutzerdefinierte Beschriftung für Auslöser-Elemente.

Verhalten der Eigenschaft:
- erforderlich, wenn label_type_trigger auf „custom“ gesetzt ist
label_type integer Beschriftungstyp des Kartenelements.

Mögliche Werte:
0 - Beschriftung;
1 - IP-Adresse;
2 - (Standard) Elementname;
3 - nur Status;
4 - nichts.
label_type_host integer Beschriftungstyp für Host-Elemente.

Mögliche Werte:
0 - Beschriftung;
1 - IP-Adresse;
2 - (Standard) Elementname;
3 - nur Status;
4 - nichts;
5 - benutzerdefiniert.
label_type_hostgroup integer Beschriftungstyp für Hostgruppen-Elemente.

Mögliche Werte:
0 - Beschriftung;
2 - (Standard) Elementname;
3 - nur Status;
4 - nichts;
5 - benutzerdefiniert.
label_type_image integer Beschriftungstyp für Hostgruppen-Elemente.

Mögliche Werte:
0 - Beschriftung;
2 - (Standard) Elementname;
4 - nichts;
5 - benutzerdefiniert.
label_type_map integer Beschriftungstyp für Kartenelemente.

Mögliche Werte:
0 - Beschriftung;
2 - (Standard) Elementname;
3 - nur Status;
4 - nichts;
5 - benutzerdefiniert.
label_type_trigger integer Beschriftungstyp für Auslöser-Elemente.

Mögliche Werte:
0 - Beschriftung;
2 - (Standard) Elementname;
3 - nur Status;
4 - nichts;
5 - benutzerdefiniert.
markelements integer Ob Kartenelemente hervorgehoben werden sollen, deren Status sich kürzlich geändert hat.

Mögliche Werte:
0 - (Standard) Elemente nicht hervorheben;
1 - Elemente hervorheben.
severity_min integer Mindestschweregrad der Auslöser, die auf der Karte angezeigt werden.

Eine Liste der unterstützten Auslöser-Schweregrade finden Sie in der Auslöser-Eigenschaft severity.
show_element_label integer Wie Elementbeschriftungen standardmäßig angezeigt werden sollen.

Mögliche Werte:
0 - immer anzeigen;
1 - (Standard) automatisch ausblenden.
show_link_label integer Wie Verknüpfungsbeschriftungen standardmäßig angezeigt werden sollen.

Mögliche Werte:
0 - immer anzeigen;
1 - (Standard) automatisch ausblenden.
show_unack integer Wie Probleme angezeigt werden sollen.

Mögliche Werte:
0 - (Standard) die Anzahl aller Probleme anzeigen;
1 - nur die Anzahl unbestätigter Probleme anzeigen;
2 - die Anzahl bestätigter und unbestätigter Probleme getrennt anzeigen.
userid ID ID des Benutzers, der Eigentümer der Karte ist.
private integer Typ der Kartenfreigabe.

Mögliche Werte:
0 - öffentliche Karte;
1 - (Standard) private Karte.
show_suppressed integer Ob unterdrückte Probleme angezeigt werden.

Mögliche Werte:
0 - (Standard) unterdrückte Probleme ausblenden;
1 - unterdrückte Probleme anzeigen.

Kartenelement

Das Kartenelement-Objekt definiert ein Objekt, das auf einer Karte angezeigt wird. Es hat die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
selementid ID ID des Kartenelements.

Verhalten der Eigenschaft:
- schreibgeschützt
elements array Datenobjekt Element.

Verhalten der Eigenschaft:
- erforderlich, wenn elementtype auf "host", "map", "trigger" oder "host group" gesetzt ist
elementtype integer Typ des Kartenelements.

Mögliche Werte:
0 - Host;
1 - Karte;
2 - Auslöser;
3 - Host-Gruppe;
4 - Bild.

Verhalten der Eigenschaft:
- erforderlich
iconid_off ID ID des Bildes, das verwendet wird, um das Element im Standardzustand anzuzeigen.

Verhalten der Eigenschaft:
- erforderlich
areatype integer Wie separate Hosts einer Host-Gruppe angezeigt werden sollen.

Mögliche Werte:
0 - (Standard) das Element der Host-Gruppe nimmt die gesamte Karte ein;
1 - das Element der Host-Gruppe hat eine feste Größe.
elementsubtype integer Wie ein Host-Gruppen-Element auf einer Karte angezeigt werden soll.

Mögliche Werte:
0 - (Standard) die Host-Gruppe als einzelnes Element anzeigen;
1 - jeden Host in der Gruppe separat anzeigen.
evaltype integer Bedingung für die Tag-Filterung von Kartenelementen Auswertungsmethode.

Mögliche Werte:
0 - (Standard) Und/Oder;
2 - Oder.
height integer Höhe des Host-Gruppen-Elements mit fester Größe in Pixeln.

Standard: 200.
iconid_disabled ID ID des Bildes, das verwendet wird, um deaktivierte Kartenelemente anzuzeigen.

Verhalten der Eigenschaft:
- unterstützt, wenn elementtype auf "host", "map", "trigger" oder "host group" gesetzt ist
iconid_maintenance ID ID des Bildes, das verwendet wird, um Kartenelemente in Wartung anzuzeigen.

Verhalten der Eigenschaft:
- unterstützt, wenn elementtype auf "host", "map", "trigger" oder "host group" gesetzt ist
iconid_on ID ID des Bildes, das verwendet wird, um Kartenelemente mit Problemen anzuzeigen.

Verhalten der Eigenschaft:
- unterstützt, wenn elementtype auf "host", "map", "trigger" oder "host group" gesetzt ist
label string Beschriftung des Elements.
label_location integer Position der Beschriftung des Kartenelements.

Mögliche Werte:
-1 - (Standard) Standardposition;
0 - unten;
1 - links;
2 - rechts;
3 - oben.
permission integer Typ der Berechtigungsstufe.

Mögliche Werte:
-1 - keine;
2 - schreibgeschützt;
3 - Lesen/Schreiben.
show_label integer Wie die Elementbeschriftung angezeigt werden soll.

Mögliche Werte:
-1 - (Standard) Kartenstandard;
0 - immer anzeigen;
1 - automatisch ausblenden.
sysmapid ID ID der Karte, zu der das Element gehört.

Verhalten der Eigenschaft:
- schreibgeschützt
urls array URLs des Kartenelements.

Das URL-Objekt des Kartenelements wird weiter unten im Detail beschrieben.
use_iconmap integer Gibt an, ob die Symbolzuordnung für Host-Elemente verwendet werden muss.

Mögliche Werte:
0 - Symbolzuordnung nicht verwenden;
1 - (Standard) Symbolzuordnung verwenden.
viewtype integer Platzierungsalgorithmus für Host-Gruppen-Elemente.

Mögliche Werte:
0 - (Standard) Raster.
width integer Breite des Host-Gruppen-Elements mit fester Größe in Pixeln.

Standard: 200.
x integer X-Koordinaten des Elements in Pixeln.

Standard: 0.
y integer Y-Koordinaten des Elements in Pixeln.

Standard: 0.
zindex integer Wert, der zum Anordnen von Kartenelementen verwendet wird (z-index).

Standard: 0.

Kartenelement Host

Das Objekt „Kartenelement Host“ definiert ein Host-Element.

Eigenschaft Type Beschreibung
hostid ID ID des Hosts.

Kartenelement Host-Gruppe

Das Objekt des Kartenelements Host-Gruppe definiert ein Host-Gruppenelement.

Eigenschaft Type Beschreibung
groupid ID ID der Host-Gruppe.

Kartenelement Karte

Das Objekt „Kartenelement Karte“ definiert ein Kartenelement.

Eigenschaft Typ Beschreibung
sysmapid ID ID der Karte.

Kartenelement Auslöser

Das Objekt des Kartenelements Auslöser definiert ein oder mehrere Auslöser-Elemente.

Eigenschaft Type Beschreibung
triggerid ID ID des Auslösers.

Tag des Kartenelements

Das Tag-Objekt des Kartenelements hat die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
tag string Name des Tags des Kartenelements.

Verhalten der Eigenschaft:
- erforderlich
operator integer Operator der Tag-Bedingung des Kartenelements.

Mögliche Werte:
0 - (Standard) Enthält;
1 - Entspricht;
2 - Enthält nicht;
3 - Entspricht nicht;
4 - Existiert;
5 - Existiert nicht.
value string Wert des Tags des Kartenelements.

URL des Kartenelements

Das URL-Objekt des Kartenelements definiert einen anklickbaren Link, der für ein bestimmtes Kartenelement verfügbar ist. Es hat die folgenden Eigenschaften:

Eigenschaft Typ Beschreibung
sysmapelementurlid ID ID der URL des Kartenelements.

Verhalten der Eigenschaft:
- schreibgeschützt
name string Beschriftung des Links.

Verhalten der Eigenschaft:
- erforderlich
url string URL des Links.

Verhalten der Eigenschaft:
- erforderlich
selementid ID ID des Kartenelements, zu dem die URL gehört.

Kartenverknüpfung

Das Objekt der Kartenverknüpfung definiert eine Verknüpfung zwischen zwei Kartenelementen. Es hat die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
linkid ID ID der Kartenverknüpfung.

Verhalten der Eigenschaft:
- schreibgeschützt
sysmapid ID ID der Karte, zu der die Verknüpfung gehört.
selementid1 ID ID des ersten Kartenelements, das an einem Ende verknüpft ist.

Verhalten der Eigenschaft:
- erforderlich
selementid2 ID ID des ersten Kartenelements, das am anderen Ende verknüpft ist.

Verhalten der Eigenschaft:
- erforderlich
drawtype integer Zeichenstil der Verknüpfungslinie.

Mögliche Werte:
0 - (Standard) Linie;
2 - fette Linie;
3 - gepunktete Linie;
4 - gestrichelte Linie.
color string Linienfarbe als hexadezimaler Farbcode.

Standard: 000000.
label string Bezeichnung der Verknüpfung.
show_label integer Wie die Bezeichnung der Verknüpfung angezeigt werden soll.

Mögliche Werte:
-1 - (Standard) Kartenstandard;
0 - immer anzeigen;
1 - automatisch ausblenden.
indicator_type integer Typ des Verknüpfungsindikators auswählen.

Mögliche Werte:
0 - (Standard) statische Verknüpfung;
1 - Auslöser;
2 - Datenpunktwert.
linktriggers array Auslöser der Kartenverknüpfung, die als Indikatoren für den Verknüpfungsstatus verwendet werden.

Das Objekt für den Auslöser der Kartenverknüpfung wird weiter unten im Detail beschrieben.

Verhalten der Eigenschaft:
- erforderlich, wenn indicator_type auf "trigger" (1) gesetzt ist.
itemid ID ID des Datenpunkts.

Verhalten der Eigenschaft:
- erforderlich, wenn indicator_type auf "item value" (2) gesetzt ist.
highlights array Hervorhebungen der Kartenverknüpfung, die als Indikatoren für den Verknüpfungsstatus verwendet werden.

Das Objekt für die Indikatoren der Kartenverknüpfung wird weiter unten im Detail beschrieben.

Verhalten der Eigenschaft:
- erforderlich, wenn indicator_type auf "item value" (2) gesetzt ist.
thresholds array Schwellenwerte der Kartenverknüpfung, die als Indikatoren für den Verknüpfungsstatus verwendet werden.

Das Objekt für die Indikatoren der Kartenverknüpfung wird weiter unten im Detail beschrieben.

Verhalten der Eigenschaft:
- erforderlich, wenn indicator_type auf "item value" (2) gesetzt ist.
permission integer Typ der Berechtigungsstufe.

Mögliche Werte:
-1 - keine;
2 - nur Lesen;
3 - Lesen und Schreiben.

Auslöser für Kartenverknüpfung

Das Objekt für den Auslöser einer Kartenverknüpfung definiert einen Statusindikator für eine Kartenverknüpfung basierend auf dem Zustand eines Auslösers. Es hat die folgenden Eigenschaften:

Eigenschaft Typ Beschreibung
triggerid ID ID des Auslösers, der als Verknüpfungsindikator verwendet wird.

Verhalten der Eigenschaft:
- erforderlich
color string Farbe des Indikators als hexadezimaler Farbcode.

Standard: DD0000.
drawtype integer Zeichenstil des Indikators.

Mögliche Werte:
0 - (Standard) Linie;
2 - fette Linie;
3 - gepunktete Linie;
4 - gestrichelte Linie.

Indikatoren für Kartenverknüpfungen

Das Objekt für Indikatoren von Kartenverknüpfungen definiert einen Statusindikator für eine Kartenverknüpfung basierend auf dem Wert des Datenpunkts. Es hat die folgenden Eigenschaften:

Eigenschaft Type Beschreibung
pattern string Regulärer Ausdruck für den Vergleich. Nur für Hervorhebungen verfügbar.
sortorder integer Wird verwendet, um die Sortierreihenfolge von Hervorhebungen festzulegen. Nur für Hervorhebungen verfügbar.
threshold string Numerischer Wert für den Vergleich. Nur für Schwellenwerte verfügbar.
drawtype integer Zeichenstil des Indikators.

Mögliche Werte:
0 - (Standard) Linie;
2 - fette Linie;
3 - gepunktete Linie;
4 - gestrichelte Linie.
color string Farbe des Indikators als hexadezimaler Farbcode.

Standard: DD0000.

Property behavior:
- erforderlich

Karten-URL

Das Objekt „Karten-URL“ definiert einen anklickbaren Link, der für alle Elemente eines bestimmten Typs auf der Karte verfügbar ist. Es hat die folgenden Eigenschaften:

Eigenschaft Typ Beschreibung
sysmapurlid ID ID der Karten-URL.

Verhalten von Eigenschaften:
- schreibgeschützt
name string Link-Beschriftung.

Verhalten von Eigenschaften:
- erforderlich
url string Link-URL.

Verhalten von Eigenschaften:
- erforderlich
elementtype integer Typ des Kartenelements, für das die URL verfügbar sein wird.

Eine Liste der unterstützten Typen finden Sie in der Eigenschaft type des Kartenelements.

Standard: 0.
sysmapid ID ID der Karte, zu der die URL gehört.

Kartenbenutzer

Liste der Kartenberechtigungen basierend auf Benutzern. Sie hat die folgenden Eigenschaften:

Eigenschaft Type Beschreibung
sysmapuserid ID ID des Kartenbenutzers.

Property behavior:
- read-only
userid ID ID des Benutzers.

Property behavior:
- required
permission integer Typ der Berechtigungsstufe.

Mögliche Werte:
2 - nur Lesen;
3 - Lesen und Schreiben.

Property behavior:
- required

Karten-Benutzergruppe

Liste der Kartenberechtigungen basierend auf Benutzergruppen. Sie hat die folgenden Eigenschaften:

Eigenschaft Type Beschreibung
sysmapusrgrpid ID ID der Karten-Benutzergruppe.

Property behavior:
- read-only
usrgrpid ID ID der Benutzergruppe.

Property behavior:
- required
permission integer Typ der Berechtigungsstufe.

Mögliche Werte:
2 - nur lesen;
3 - Lesen und Schreiben.

Property behavior:
- required

Kartenformen

Das Kartenform-Objekt definiert eine geometrische Form (mit oder ohne Text), die auf einer Karte angezeigt wird. Es hat die folgenden Eigenschaften:

Eigenschaft Typ Beschreibung
sysmap_shapeid ID ID des Kartenform-Elements.

Verhalten der Eigenschaft:
- schreibgeschützt
type integer Typ des Kartenform-Elements.

Mögliche Werte:
0 - Rechteck;
1 - Ellipse.

Die Eigenschaft ist erforderlich, wenn neue Formen erstellt werden.

Verhalten der Eigenschaft:
- erforderlich
x integer X-Koordinaten der Form in Pixeln.

Standard: 0.
y integer Y-Koordinaten der Form in Pixeln.

Standard: 0.
width integer Breite der Form in Pixeln.

Standard: 200.
height integer Höhe der Form in Pixeln.

Standard: 200.
text string Text der Form.
font integer Schriftart des Textes innerhalb der Form.

Mögliche Werte:
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

Standard: 9.
font_size integer Schriftgröße in Pixeln.

Standard: 11.
font_color string Schriftfarbe.

Standard: 000000.
text_halign integer Horizontale Ausrichtung des Textes.

Mögliche Werte:
0 - zentriert;
1 - links;
2 - rechts.

Standard: 0.
text_valign integer Vertikale Ausrichtung des Textes.

Mögliche Werte:
0 - mittig;
1 - oben;
2 - unten.

Standard: 0.
border_type integer Typ des Rahmens.

Mögliche Werte:
0 - keiner;
1 - —————;
2 - ·····;
3 - - - -.

Standard: 0.
border_width integer Breite des Rahmens in Pixeln.

Standard: 0.
border_color string Rahmenfarbe.

Standard: 000000.
background_color string Hintergrundfarbe (Füllfarbe).

Standard: (leer).
zindex integer Wert, der zur Anordnung aller Formen und Linien verwendet wird (z-index).

Standard: 0.

Kartenlinien

Das Objekt für Kartenlinien definiert eine Linie, die auf einer Karte angezeigt wird. Es hat die folgenden Eigenschaften:

Eigenschaft Typ Beschreibung
sysmap_shapeid ID ID des Kartenelement-Formobjekts.

Eigenschaftsverhalten:
- schreibgeschützt
x1 integer X-Koordinaten des ersten Linienpunkts in Pixeln.

Standard: 0.
y1 integer Y-Koordinaten des ersten Linienpunkts in Pixeln.

Standard: 0.
x2 integer X-Koordinaten des zweiten Linienpunkts in Pixeln.

Standard: 200.
y2 integer Y-Koordinaten des zweiten Linienpunkts in Pixeln.

Standard: 200.
line_type integer Typ der Linien.

Mögliche Werte:
0 - keine;
1 - —————;
2 - ·····;
3 - - - -.

Standard: 0.
line_width integer Breite der Linien in Pixeln.

Standard: 0.
line_color string Linienfarbe.

Standard: 000000.
zindex integer Wert, der zur Anordnung aller Formen und Linien verwendet wird (z-index).

Standard: 0.