Table of Contents

> Kaartobject

> Kaartobject

De volgende objecten zijn direct gerelateerd aan de map API.

Kaart

Het kaartobject heeft de volgende eigenschappen.

Eigenschap	Type	Omschrijving
sysmapid	string	(alleen-lezen) ID van de kaart.
hoogte (vereist)	integer	Hoogte van de kaart in pixels.
naam (vereist)	string	Naam van de kaart.
breedte (vereist)	integer	Breedte van de kaart in pixels.
backgroundid	string	ID van de afbeelding die als achtergrond voor de kaart wordt gebruikt.
expand_macros	integer	Of macro's moeten worden uitgebreid in labels bij het configureren van de kaart. Mogelijke waarden: 0 - (standaard) macro's niet uitbreiden; 1 - macro's uitbreiden.
expandproblem	integer	Of de probleemtrigger wordt weergegeven voor elementen met slechts één probleem. Mogelijke waarden: 0 - altijd het aantal problemen weergeven; 1 - (standaard) de probleemtrigger weergeven als er slechts één probleem is.
grid_align	integer	Of het uitlijnen op het raster moet worden ingeschakeld. Mogelijke waarden: 0 - uitlijnen op raster uitschakelen; 1 - (standaard) uitlijnen op raster inschakelen.
grid_show	integer	Of het raster op de kaart moet worden weergegeven. Mogelijke waarden: 0 - het raster niet weergeven; 1 - (standaard) het raster weergeven.
grid_size	integer	Grootte van het kaartraster in pixels. Ondersteunde waarden: 20, 40, 50, 75 en 100. Standaard: 50.
highlight	integer	Of het markeren van pictogrammen is ingeschakeld. Mogelijke waarden: 0 - markeren uitgeschakeld; 1 - (standaard) markeren ingeschakeld.
iconmapid	string	ID van de pictogramkaart die op de kaart wordt gebruikt.
label_format	integer	Of geavanceerde labels moeten worden ingeschakeld. Mogelijke waarden: 0 - (standaard) geavanceerde labels uitschakelen; 1 - geavanceerde labels inschakelen.
label_location	integer	Locatie van het label van het kaartelement. Mogelijke waarden: 0 - (standaard) onderaan; 1 - links; 2 - rechts; 3 - bovenaan.
label_string_host	string	Aangepast label voor hostelementen. Vereist voor kaarten met aangepast hostlabeltype.
label_string_hostgroup	string	Aangepast label voor hostgroep-elementen. Vereist voor kaarten met aangepast hostgroep-labeltype.
label_string_image	string	Aangepast label voor afbeeldingselementen. Vereist voor kaarten met aangepast afbeeldinglabeltype.
label_string_map	string	Aangepast label voor kaartelementen. Vereist voor kaarten met aangepast kaartlabeltype.
label_string_trigger	string	Aangepast label voor triggerelementen. Vereist voor kaarten met aangepast triggerelementtype.
label_type	integer	Kaartelementlabeltype. Mogelijke waarden: 0 - label; 1 - IP-adres; 2 - (standaard) elementnaam; 3 - alleen status; 4 - niets.
label_type_host	integer	Labeltype voor hostelementen. Mogelijke waarden: 0 - label; 1 - IP-adres; 2 - (standaard) elementnaam; 3 - alleen status; 4 - niets; 5 - aangepast.
label_type_hostgroup	integer	Labeltype voor hostgroep-elementen. Mogelijke waarden: 0 - label; 2 - (standaard) elementnaam; 3 - alleen status; 4 - niets; 5 - aangepast.
label_type_image	integer	Labeltype voor afbeeldingselementen. Mogelijke waarden: 0 - label; 2 - (standaard) elementnaam; 4 - niets; 5 - aangepast.
label_type_map	integer	Labeltype voor kaartelementen. Mogelijke waarden: 0 - label; 2 - (standaard) elementnaam; 3 - alleen status; 4 - niets; 5 - aangepast.
label_type_trigger	integer	Labeltype voor triggerelementen. Mogelijke waarden: 0 - label; 2 - (standaard) elementnaam; 3 - alleen status; 4 - niets; 5 - aangepast.
markelements	integer	Of kaartelementen die recentelijk hun status hebben gewijzigd moeten worden gemarkeerd. Mogelijke waarden: 0 - (standaard) elementen niet markeren; 1 - elementen markeren.
severity_min	integer	Minimale ernst van de triggers die op de kaart worden weergegeven. Zie de eigenschap "ernst" van de trigger voor een lijst van ondersteunde triggerernsten.
show_unack	integer	Hoe problemen moeten worden weergegeven. Mogelijke waarden: 0 - (standaard) het aantal alle problemen weergeven; 1 - alleen het aantal niet-erkende problemen weergeven; 2 - het aantal erkende en niet-erkende problemen afzonderlijk weergeven.
userid	string	Gebruikers-ID van de kaarteigenaar.
private	integer	Type delen van de kaart. Mogelijke waarden: 0 - openbare kaart; 1 - (standaard) private kaart.
show_suppressed	integer	Of onderdrukte problemen worden weergegeven. Mogelijke waarden: 0 - (standaard) onderdrukte problemen verbergen; 1 - onderdrukte problemen weergeven.

Let op dat voor sommige methoden (update, delete) de vereiste/optionele parametercombinatie anders is.

Kaartelement

Het kaartelementobject definieert een object dat op een kaart wordt weergegeven. Het heeft de volgende eigenschappen.

Eigenschap	Type	Beschrijving
selementid	string	(alleen-lezen) ID van het kaartelement.
elementen (verplicht)	array	Element data-object. Vereist voor host-, hostgroep-, trigger- en kaarttype-elementen.
elementtype (vereist)	geheel getal	Type kaartelement. Mogelijke waarden: 0 - host; 1 - kaart; 2 - trigger; 3 - hostgroep; 4 - afbeelding.
iconid_off (verplicht)	string	ID van de afbeelding die wordt gebruikt om het element in de standaardstatus weer te geven.
areatype	integer	Hoe afzonderlijke hostgroephosts moeten worden weergegeven. Mogelijke waarden: 0 - (standaard) het hostgroepelement neemt de hele kaart in beslag; 1 - de hostgroepelement zal een vaste grootte hebben.
elementsubtype	integer	Hoe een hostgroepelement op een kaart moet worden weergegeven. Mogelijke waarden: 0 - (standaard) geeft de hostgroep weer als een enkel element; 1 - geef elke host in de groep afzonderlijk weer.
evaltype	integer	Evaluatiemethode voor filtercondities van kaartelementtag. Mogelijke waarden: 0 - (standaard) AND / OR; 2 - OR.
height	integer	Hoogte van het hostgroepelement met vaste grootte in pixels. Standaard: 200.
iconid_disabled	string	ID van de afbeelding die wordt gebruikt om uitgeschakelde kaartelementen weer te geven. Ongebruikt voor afbeeldingselementen.
iconid_maintenance	string	ID van de afbeelding die wordt gebruikt om kaartelementen in onderhoud weer te geven. Ongebruikt voor afbeeldingselementen.
iconid_on	string	ID van de afbeelding die wordt gebruikt om kaartelementen met problemen weer te geven. Ongebruikt voor afbeeldingselementen.
label	string	Label van het element.
label_location	integer	Locatie van het label van het kaartelement. Mogelijke waarden: -1 - (standaard) standaardlocatie; 0 - onder; 1 - links ; 2 - rechts; 3 - boven.
permission	integer	Type machtigingsniveau. Mogelijke waarden: -1 - geen; 2 - alleen lezen; 3 - lezen-schrijven.
sysmapid	string	(alleen-lezen) ID van de kaart waartoe het element behoort.
urls	array	URL's van kaartelement. Het URL-object van het kaartelement wordt hieronder in detail beschreven.
use_iconmap	integer	Of pictogramtoewijzing moet worden gebruikt voor hostelementen. Mogelijke waarden: 0 - gebruik geen pictogramtoewijzing; 1 - (standaard) gebruik pictogramtoewijzing .
viewtype	integer	Algoritme voor het plaatsen van hostgroepelementen. Mogelijke waarden: 0 - (standaard) raster.
width	integer	Breedte van het hostgroepelement met vaste grootte in pixels. Standaard: 200.
x	integer	X-coördinaten van het element in pixels. Standaard: 0.
y	integer	Y-coördinaten van het element in pixels. Standaard: 0.

Kaartelement Host

Het kaartelement Host-object definieert één hostelement.

Eigenschap	Type	Beschrijving
hostid	string	Host-ID

Kaartelement Hostgroep

Het kaartelement Host-groepsobject definieert één hostgroepselement.

Eigenschap	Type	Beschrijving
groupid	string	Hostgroep-ID

Kaartelement Kaart

Het kaartelement Kaartobject definieert één kaartelement.

Eigenschap	Type	Beschrijving
sysmapid	string	Kaart-ID

Kaartelement Trigger

Het kaartelement Trigger-object definieert een of meer triggerelementen.

Eigenschap	Type	Beschrijving
triggerid	string	Trigger-ID

Kaart element tag

Het kaart element tag object heeft de volgende eigenschappen.

Eigenschap	Type	Omschrijving
tag (verplicht)	string	Naam van het kaart element tag.
operator	integer	Vergelijkingsoperator voor het kaart element tag voorwaarde. Mogelijke waarden: 0 - (standaard) Bevat; 1 - Gelijk aan; 2 - Bevat niet; 3 - Niet gelijk aan; 4 - Bestaat; 5 - Bestaat niet.
value	string	Waarde van het kaart element tag.

URL van kaartelement

Het URL-object van het kaartelement definieert een klikbare link die beschikbaar voor een specifiek kaartelement. Het heeft de volgende eigenschappen:

Eigenschap	Type	Beschrijving
sysmapelementurlid	string	(alleen-lezen) ID van de kaartelement-URL.
naam (verplicht)	string	Linkbijschrift.
url (verplicht)	string	Link-URL.
selementid	string	ID van het kaartelement waartoe de URL behoort.

Kaartlink

Het map link-object definieert een link tussen twee kaartelementen. Het heeft de volgende eigenschappen.

Eigenschap	Type	Beschrijving
linkid	string	(alleen-lezen) ID van de kaartlink.
selementid1 (verplicht)	string	ID van het eerste kaartelement dat aan één kant is gekoppeld.
selementid2 (verplicht)	string	ID van het eerste kaartelement dat aan de andere kant is gekoppeld.
color	string	Lijnkleur als hexadecimale kleurcode. Standaard: `000000`.
drawtype	integer	Link lijntekenstijl. Mogelijke waarden: 0 - (standaard) lijn; 2 - vette lijn; 3 - stippellijn; 4 - stippellijn.
label	string	Link label.
linktriggers	array	Maplinktriggers om te gebruiken als linkstatusindicatoren. Het triggerobject voor de kaartlink wordt hieronder in detail beschreven.
permission	integer	Type machtigingsniveau. Mogelijke waarden: -1 - geen; 2 - alleen lezen; 3 - lezen-schrijven.
sysmapid	string	ID van de kaart waartoe de link behoort.

Kaartlink-trigger

Het triggerobject voor de kaartkoppeling definieert een statusindicator voor de kaartkoppeling op basis van: de toestand van een trigger. Het heeft de volgende eigenschappen:

Eigenschap	Type	Beschrijving
linktriggerid	string	(alleen-lezen) ID van de kaartlink-trigger.
triggerid (vereist)	string	ID van de trigger die als linkindicator wordt gebruikt.
color	string	Indicatorkleur als hexadecimale kleurcode. Standaard: `DD0000`.
drawtype	integer	Indicator tekenstijl. Mogelijke waarden: 0 - (standaard) regel; 2 - vette lijn; 3 - stippellijn; 4 - stippellijn.
linkid	string	ID van de kaartlink waartoe de linktrigger behoort.

Kaart-URL

Het kaart-URL-object definieert een klikbare link die beschikbaar zal zijn voor: alle elementen van een bepaald type op de kaart. Het heeft het volgende: eigendommen:

Property	Type	Beschrijving
sysmapurlid	string	(alleen-lezen) ID van de kaart-URL.
naam (vereist)	string	Linkbijschrift.
url (verplicht)	string	Link-URL.
elementtype	integer	Type kaartelement waarvoor de URL beschikbaar zal zijn. Raadpleeg de eigenschap van het kaartelement "type" voor een lijst met ondersteunde typen. < br>Standaard: 0.
sysmapid	string	ID van de kaart waartoe de URL behoort.

Kaartgebruiker

Lijst met kaartmachtigingen op basis van gebruikers. Het heeft de volgende eigenschappen:

Eigenschap	Type	Beschrijving
sysmapuserid	string	(alleen-lezen) ID van de kaartgebruiker.
use-ID (vereist)	string	Gebruikers-ID.
machtiging (vereist)	geheel getal	Type machtigingsniveau. Mogelijke waarden: 2 - alleen lezen; 3 - lezen-schrijven;

Gebruikersgroep in kaart brengen

Lijst met kaartrechten op basis van gebruikersgroepen. Het heeft het volgende: eigendommen:

Eigenschap	Type	Beschrijving
sysmapusrgrpid	string	(alleen-lezen) ID van de kaartgebruikersgroep.
usrgrpid (vereist)	string	Gebruikersgroep-ID.
machtiging (vereist)	geheel getal	Type machtigingsniveau. Mogelijke waarden: 2 - alleen lezen; 3 - lezen-schrijven;

Kaartvormen

Het kaartvormobject definieert een geometrische vorm (met of zonder tekst) die op een kaart wordt weergegeven. Het heeft de volgende eigenschappen:

Eigenschap	Type	Omschrijving
sysmap_shapeid	string	(alleen-lezen) ID van het kaartvormelement.
type (vereist)	integer	Type van het kaartvormelement. Mogelijke waarden: 0 - rechthoek; 1 - ellips. Eigenschap is vereist bij het aanmaken van nieuwe vormen.
x	integer	X-coördinaten van de vorm in pixels. Standaard: 0.
y	integer	Y-coördinaten van de vorm in pixels. Standaard: 0.
width	integer	Breedte van de vorm in pixels. Standaard: 200.
height	integer	Hoogte van de vorm in pixels. Standaard: 200.
text	string	Tekst van de vorm.
font	integer	Lettertype van de tekst binnen de vorm. Mogelijke waarden: 0 - Georgia, schreeflettertype 1 - "Palatino Linotype", "Book Antiqua", Palatino, schreeflettertype 2 - "Times New Roman", Times, schreeflettertype 3 - Arial, Helvetica, schreefloos lettertype 4 - "Arial Black", Gadget, schreefloos lettertype 5 - "Comic Sans MS", cursief, schreefloos lettertype 6 - Impact, houtskool, schreefloos lettertype 7 - "Lucida Sans Unicode", "Lucida Grande", schreefloos lettertype 8 - Tahoma, Geneva, schreefloos lettertype 9 - "Trebuchet MS", Helvetica, schreefloos lettertype 10 - Verdana, Geneva, schreefloos lettertype 11 - "Courier New", Courier, monospace 12 - "Lucida Console", Monaco, monospace Standaard: 9.
font_size	integer	Lettergrootte in pixels. Standaard: 11.
font_color	string	Letterkleur. Standaard: '000000'.
text_halign	integer	Horizontale uitlijning van tekst. Mogelijke waarden: 0 - midden; 1 - links; 2 - rechts. Standaard: 0.
text_valign	integer	Verticale uitlijning van tekst. Mogelijke waarden: 0 - midden; 1 - boven; 2 - onder. Standaard: 0.
border_type	integer	Type van de rand. Mogelijke waarden: 0 - geen; 1 - `—————`; 2 - `·····`; 3 - `- - -`. Standaard: 0.
border_width	integer	Breedte van de rand in pixels. Standaard: 0.
border_color	string	Randkleur. Standaard: '000000'.
background_color	string	Achtergrondkleur (vulkleur). Standaard: `(leeg)`.
zindex	integer	Waarde die wordt gebruikt om alle vormen en lijnen te ordenen (z-index). Standaard: 0.

Kaartlijnen

Het kaartlijnobject definieert een lijn die op een kaart wordt weergegeven. Het heeft de volgende eigenschappen:

Eigenschap	Type	Omschrijving
sysmap_shapeid	string	(alleen-lezen) ID van het kaartvormelement.
x1	integer	X-coördinaten van punt 1 van de lijn in pixels. Standaard: 0.
y1	integer	Y-coördinaten van punt 1 van de lijn in pixels. Standaard: 0.
x2	integer	X-coördinaten van punt 2 van de lijn in pixels. Standaard: 200.
y2	integer	Y-coördinaten van punt 2 van de lijn in pixels. Standaard: 200.
line_type	integer	Type van de lijnen. Mogelijke waarden: 0 - geen; 1 - `—————`; 2 - `·····`; 3 - `- - -`. Standaard: 0.
line_width	integer	Breedte van de lijnen in pixels. Standaard: 0.
line_color	string	Lijnkleur. Standaard: '000000'.
zindex	integer	Waarde die wordt gebruikt om alle vormen en lijnen te ordenen (z-index). Standaard: 0.

Documentation