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	ID van de kaart. Gedrag van eigenschap: - alleen-lezen - vereist voor updatebewerkingen
height	integer	Hoogte van de kaart in pixels. Gedrag van eigenschap: - vereist voor aanmaakbewerkingen
name	string	Naam van de kaart. Gedrag van eigenschap: - vereist voor aanmaakbewerkingen
width	integer	Breedte van de kaart in pixels. Gedrag van eigenschap: - vereist voor aanmaakbewerkingen
backgroundid	string	ID van de afbeelding die als achtergrond voor de kaart wordt gebruikt.
expand_macros	integer	Of macro's in labels moeten worden uitgevouwen bij het configureren van de kaart. Mogelijke waarden: 0 - (standaard) macro's niet uitvouwen; 1 - macro's uitvouwen.
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 rooster is ingeschakeld. Mogelijke waarden: 0 - uitlijnen op rooster uitschakelen; 1 - (standaard) uitlijnen op rooster inschakelen.
grid_show	integer	Of het rooster op de kaart wordt weergegeven. Mogelijke waarden: 0 - het rooster niet weergeven; 1 - (standaard) het rooster weergeven.
grid_size	integer	Grootte van het kaartrooster 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 - geavanceerde labels uitschakelen; 1 - geavanceerde labels inschakelen.
label_location	integer	Plaats 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. Gedrag van eigenschap: - vereist als `label_type_host` is ingesteld op "aangepast"
label_string_hostgroup	string	Aangepast label voor hostgroep-elementen. Gedrag van eigenschap: - vereist als `label_type_hostgroup` is ingesteld op "aangepast"
label_string_image	string	Aangepast label voor beeldelementen. Gedrag van eigenschap: - vereist als `label_type_image` is ingesteld op "aangepast"
label_string_map	string	Aangepast label voor kaartelementen. Gedrag van eigenschap: - vereist als `label_type_map` is ingesteld op "aangepast"
label_string_trigger	string	Aangepast label voor triggerelementen. Gedrag van eigenschap: - vereist als `label_type_trigger` is ingesteld op "aangepast"
label_type	integer	Type label van het kaartelement. 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 beeldelementen. 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 onlangs hun status hebben gewijzigd, moeten worden gemarkeerd. Mogelijke waarden: 0 - (standaard) elementen niet markeren; 1 - elementen markeren.
severity_min	integer	Minimale ernst van de triggertypen die op de kaart worden weergegeven. Zie de trigger `severity`-eigenschap voor een lijst met ondersteunde triggerernst.
show_unack	integer	Hoe problemen moeten worden weergegeven. Mogelijke waarden: 0 - (standaard) het aantal problemen weergeven; 1 - alleen het aantal niet-erkende problemen weergeven; 2 - het aantal erkende en niet-erkende problemen apart weergeven.
userid	string	ID van de eigenaar van de kaart.
private	integer	Type kaartdeling. Mogelijke waarden: 0 - openbare kaart; 1 - (standaard) privékaart.
show_suppressed	integer	Of onderdrukte problemen worden weergegeven. Mogelijke waarden: 0 - (standaard) onderdrukte problemen verbergen; 1 - onderdrukte problemen weergeven.

Kaartelement

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

Eigenschap	Type	Omschrijving
selementid	string	ID van het kaartelement. Gedrag van eigenschap: - alleen-lezen
elements	array	Elementgegevensobject. Gedrag van eigenschap: - vereist als `elementtype` is ingesteld op "host", "map", "trigger" of "host group"
elementtype	integer	Type van het kaartelement. Mogelijke waarden: 0 - host; 1 - kaart; 2 - trigger; 3 - hostgroep; 4 - afbeelding. Gedrag van eigenschap: - vereist
iconid_off	string	ID van de afbeelding die wordt gebruikt om het element in de standaardtoestand weer te geven. Gedrag van eigenschap: - vereist
areatype	integer	Hoe afzonderlijke hosts van hostgroepen moeten worden weergegeven. Mogelijke waarden: 0 - (standaard) het hostgroepselement neemt de hele kaart in beslag; 1 - het hostgroepselement heeft een vaste grootte.
elementsubtype	integer	Hoe een hostgroepselement op een kaart moet worden weergegeven. Mogelijke waarden: 0 - (standaard) de hostgroep weergeven als een enkel element; 1 - elke host in de groep afzonderlijk weergeven.
evaltype	integer	Evaluatiemethode voor voorwaardelijke tagfiltering van kaartelementen. Mogelijke waarden: 0 - (standaard) EN / OF; 2 - OF.
height	integer	Hoogte van het hostgroepselement met vaste grootte in pixels. Standaard: 200.
iconid_disabled	string	ID van de afbeelding die wordt gebruikt om uitgeschakelde kaartelementen weer te geven. Gedrag van eigenschap: - ondersteund als `elementtype` is ingesteld op "host", "map", "trigger" of "host group"
iconid_maintenance	string	ID van de afbeelding die wordt gebruikt om kaartelementen weer te geven in onderhoudsmodus. Gedrag van eigenschap: - ondersteund als `elementtype` is ingesteld op "host", "map", "trigger" of "host group"
iconid_on	string	ID van de afbeelding die wordt gebruikt om kaartelementen met problemen weer te geven. Gedrag van eigenschap: - ondersteund als `elementtype` is ingesteld op "host", "map", "trigger" of "host group"
label	string	Label van het element.
label_location	integer	Locatie van het label van het kaartelement. Mogelijke waarden: -1 - (standaard) standaardlocatie; 0 - onderaan; 1 - links; 2 - rechts; 3 - bovenaan.
permission	integer	Type machtigingsniveau. Mogelijke waarden: -1 - geen; 2 - alleen lezen; 3 - lezen en schrijven.
sysmapid	string	ID van de kaart waartoe het element behoort. Gedrag van eigenschap: - alleen-lezen
urls	array	URL's van kaartelementen. Het kaartelement-URL-object wordt hieronder in detail beschreven.
use_iconmap	integer	Of er icon mapping moet worden gebruikt voor hostelementen. Mogelijke waarden: 0 - geen icon mapping gebruiken; 1 - (standaard) icon mapping gebruiken.
viewtype	integer	Plaatsingsalgoritme voor hostgroepselementen. Mogelijke waarden: 0 - (standaard) rooster.
width	integer	Breedte van het hostgroepselement 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

Kaartelement-tag

Het kaartelementtag-object heeft de volgende eigenschappen.

Eigenschap	Type	Omschrijving
tag	string	Naam van het kaartelement-tag. Gedrag van eigenschap: - vereist
operator	integer	Voorwaardelijke operator van het kaartelement-tag. Mogelijke waarden: 0 - (standaard) Bevat; 1 - Is gelijk aan; 2 - Bevat niet; 3 - Is niet gelijk aan; 4 - Bestaat; 5 - Bestaat niet.
value	string	Waarde van het kaartelement-tag.

Kaartelement URL

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

Eigenschap	Type	Omschrijving
sysmapelementurlid	string	ID van de kaartelement URL. Gedrag van eigenschap: - alleen-lezen
name	string	Bijschrift van de link. Gedrag van eigenschap: - vereist
url	string	Link URL. Gedrag van eigenschap: - vereist
selementid	string	ID van het kaartelement waartoe de URL behoort.

Kaartkoppeling

Het kaartkoppelingsobject definieert een koppeling tussen twee kaartelementen. Het heeft de volgende eigenschappen:

Eigenschap	Type	Omschrijving
linkid	string	ID van de kaartkoppeling. Gedrag van eigenschap: - alleen-lezen
selementid1	string	ID van het eerste kaartelement waarmee aan één uiteinde is gekoppeld. Gedrag van eigenschap: - vereist
selementid2	string	ID van het tweede kaartelement waarmee aan het andere uiteinde is gekoppeld. Gedrag van eigenschap: - vereist
color	string	Kleur van de lijn als hexadecimaal kleurcode. Standaard: `000000`.
drawtype	integer	Tekeningstijl van de lijn van de koppeling. Mogelijke waarden: 0 - (standaard) lijn; 2 - vette lijn; 3 - gestippelde lijn; 4 - stippellijn.
label	string	Label van de koppeling.
linktriggers	array	Kaartkoppelingstriggers om te gebruiken als statusindicatoren voor de koppeling. Het kaartkoppelingstriggerobject wordt hieronder in detail beschreven.
permission	integer	Type toestemmingsniveau. Mogelijke waarden: -1 - geen; 2 - alleen lezen; 3 - lezen en schrijven.
sysmapid	string	ID van de kaart waartoe de koppeling behoort.

Kaartkoppelingstrigger

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

Eigenschap	Type	Omschrijving
linktriggerid	string	ID van de kaartkoppelingstrigger. Gedrag van eigenschap: - alleen-lezen
triggerid	string	ID van de trigger die wordt gebruikt als indicatie voor de koppeling. Gedrag van eigenschap: - vereist
color	string	Kleur van de indicator als hexadecimale kleurcode. Standaard: `DD0000`.
drawtype	integer	Tekeningstijl van de indicator. Mogelijke waarden: 0 - (standaard) lijn; 2 - vette lijn; 3 - gestippelde lijn; 4 - stippellijn.
linkid	string	ID van de kaartkoppeling waartoe de koppelingstrigger behoort.

Kaart-URL

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

Eigenschap	Type	Omschrijving
sysmapurlid	string	ID van de kaart-URL. Gedrag van eigenschap: - alleen-lezen
name	string	Bijschrift van de link. Gedrag van eigenschap: - vereist
url	string	URL van de link. Gedrag van eigenschap: - vereist
elementtype	integer	Type van kaartelement waarvoor de URL beschikbaar zal zijn. Zie de kaartelement `type` eigenschap voor een lijst van ondersteunde typen. Standaard: 0.
sysmapid	string	ID van de kaart waartoe de URL behoort.

Kaart-gebruiker

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

Eigenschap	Type	Omschrijving
sysmapuserid	string	ID van de kaart-gebruiker. Gedrag van eigenschap: - alleen-lezen
userid	string	Gebruikers-ID. Gedrag van eigenschap: - vereist
permission	integer	Type van permissieniveau. Mogelijke waarden: 2 - alleen lezen; 3 - lezen en schrijven. Gedrag van eigenschap: - vereist

Kaart-gebruikersgroep

Lijst met kaartpermissies op basis van gebruikersgroepen. Het heeft de volgende eigenschappen:

Eigenschap	Type	Omschrijving
sysmapusrgrpid	string	ID van de kaart-gebruikersgroep. Gedrag van eigenschap: - alleen-lezen
usrgrpid	string	ID van de gebruikersgroep. Gedrag van eigenschap: - vereist
permission	integer	Type van permissieniveau. Mogelijke waarden: 2 - alleen lezen; 3 - lezen en schrijven. Gedrag van eigenschap: - vereist

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	ID van het kaartvormelement. Gedrag van eigenschap: - alleen-lezen
type	integer	Type van het kaartvormelement. Mogelijke waarden: 0 - rechthoek; 1 - ellips. Eigenschap is vereist bij het maken van nieuwe vormen. Gedrag van eigenschap: - vereist
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, Charcoal, 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 lettertype 12 - “Lucida Console”, Monaco, monospace lettertype Standaard: 9.
font_size	integer	Lettergrootte in pixels. Standaard: 11.
font_color	string	Tekstkleur. Standaard: `000000`.
text_halign	integer	Horizontale uitlijning van de tekst. Mogelijke waarden: 0 - midden; 1 - links; 2 - rechts. Standaard: 0.
text_valign	integer	Verticale uitlijning van de 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	ID van het kaartvormelement. Gedrag van eigenschap: - alleen-lezen
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