Table of Contents

> Objet Carte

> Objet Carte

Les objets suivants sont directement liés à l'API map.

Carte

L'objet carte a les propriétés suivantes.

Propriété	Type	Description
sysmapid	string	(lecture seule) ID de la carte.
height (obligatoire)	integer	Hauteur de la carte en pixels.
name (obligatoire)	string	Nom de la carte.
width (obligatoire)	integer	Largeur de la carte en pixels.
backgroundid	string	ID de l'image utilisée comme arrière-plan de la carte.
expand_macros	integer	Indique s'il faut développer les macros dans les étiquettes lors de la configuration de la carte. Valeurs possibles : 0 - (par défaut) ne pas développer ; 1 - développer.
expandproblem	integer	Indique si le déclencheur du problème sera affiché pour les éléments avec un seul problème. Valeurs possibles : 0 - affiche toujours le nombre de problèmes ; 1 - (par défaut) affiche le déclencheur du problème s'il n'y a qu'un seul problème.
grid_align	integer	Indique s'il faut activer l'alignement sur la grille. Valeurs possibles : 0 - désactiver l'alignement sur la grille ; 1 - (par défaut) activer l'alignement sur la grille.
grid_show	integer	Indique s'il faut afficher la grille sur la carte. Valeurs possibles : 0 - ne pas montrer la grille ; 1 - (par défaut) montrer la grille.
grid_size	integer	Taille de la grille de la carte en pixels. Valeurs supportées : 20, 40, 50, 75 et 100. Par défaut : 50.
highlight	integer	Indique si la mise en surbrillance des icônes est activée. Valeurs possibles : 0 - surbrillance désactivée ; 1 - (par défaut) surbrillance activée.
iconmapid	string	ID de la correspondance d'icône utilisée sur la carte.
label_format	integer	Indique s'il faut activer les étiquettes avancées. Valeurs possibles : 0 - (par défaut) désactiver les étiquettes avancées ; 1 - activer les étiquettes avancées.
label_location	integer	Emplacement de l'étiquette de l'élément de carte. Valeurs possibles : 0 - (par défaut) bas ; 1 - gauche ; 2 - droite ; 3 - haut.
label_string_host	string	Étiquette personnalisée pour les éléments hôtes. Requis pour les cartes avec un type d'étiquette d'hôte personnalisé.
label_string_hostgroup	string	Étiquette personnalisée pour les éléments groupe d'hôtes. Requis pour les cartes avec un type d'étiquette groupe d'hôtes personnalisé.
label_string_image	string	Étiquette personnalisée pour les éléments images. Requis pour les cartes avec un type d'étiquette image personnalisé.
label_string_map	string	Étiquette personnalisée pour les éléments cartes. Requis pour les cartes avec un type d'étiquette carte personnalisé.
label_string_trigger	string	Étiquette personnalisée pour les éléments déclencheurs. Requis pour les cartes avec un type d'étiquette déclencheur personnalisé.
label_type	integer	Type d'étiquette d'élément de carte. Valeurs possibles : 0 - étiquette ; 1 - adresse IP ; 2 - (par défaut) nom de l'élément ; 3 - statut uniquement ; 4 - rien.
label_type_host	integer	Type d'étiquette pour les éléments hôtes. Valeurs possibles : 0 - étiquette ; 1 - adresse IP ; 2 - (par défaut) nom de l'élément ; 3 - statut uniquement ; 4 - rien ; 5 - personnalisé.
label_type_hostgroup	integer	Type d'étiquette pour les éléments groupes d'hôtes. Valeurs possibles : 0 - étiquette ; 2 - (par défaut) nom de l'élément ; 3 - statut uniquement ; 4 - rien ; 5 - personnalisé.
label_type_image	integer	Type d'étiquette pour les éléments images. Valeurs possibles : 0 - étiquette ; 2 - (par défaut) nom de l'élément ; 4 - rien ; 5 - personnalisé.
label_type_map	integer	Type d'étiquette pour les éléments cartes. Valeurs possibles : 0 - étiquette ; 2 - (par défaut) nom de l'élément ; 3 - statut uniquement ; 4 - rien ; 5 - personnalisé.
label_type_trigger	integer	Type d'étiquette pour les éléments déclencheurs. Valeurs possibles : 0 - étiquette ; 2 - (par défaut) nom de l'élément ; 3 - statut uniquement ; 4 - rien ; 5 - personnalisé.
markelements	integer	Indique s'il faut mettre en évidence les éléments de la carte qui ont récemment changé de statut. Valeurs possibles : 0 - (par défaut) ne pas surligner les éléments ; 1 - surligner les éléments.
severity_min	integer	Sévérité minimale des déclencheurs qui seront affichés sur la carte. Se référer à la propriété "sévérité" d'un déclencheur pour une liste de sévérités supportées.
show_unack	integer	Manière dont les problèmes doivent être affichés. Valeurs possibles : 0 - (par défaut) afficher le nombre de tous les problèmes ; 1 - afficher uniquement le nombre de problèmes non acquittés ; 2 - afficher le nombre de problèmes acquittés et non acquittés séparément.
userid	string	ID utilisateur du propriétaire de la carte.
private	integer	Type de partage de carte. Valeurs possibles : 0 - carte publique ; 1 - (par défaut) carte privée.
show_suppressed	integer	Indique si les problèmes supprimés sont affichés. Valeurs possibles : 0 - (par défaut) masquer les problèmes supprimés ; 1 - afficher les problèmes supprimés.

Notez que pour certaines méthodes (mise à jour, suppression) la combinaison de paramètres requise/optionnelle est différente.

Elément de carte

L'objet élément de carte définit un objet affiché sur une carte. Il a les propriétés suivantes.

Propriété	Type	Description
selementid	string	(lecture seule) ID de l'élément de carte.
elements (obligatoire)	array	Objet de données d'élément. Requis pour les éléments de type hôte, groupe d'hôtes, déclencheur et carte.
elementtype (obligatoire)	integer	Type d'élément de carte. Valeurs possibles : 0 - hôte ; 1 - carte ; 2 - déclencheur ; 3 - groupe d'hôtes ; 4 - image.
iconid_off (obligatoire)	string	ID de l'image utilisée pour afficher l'élément à l'état par défaut.
areatype	integer	Manière dont les différents hôtes du groupe d'hôtes doivent être affichés. Valeurs possibles : 0 - (par défaut) l'élément du groupe d'hôtes occupera toute la carte ; 1 - l'élément du groupe d'hôtes aura une taille fixe.
elementsubtype	integer	Manière dont un élément de groupe d'hôtes doit être affiché sur une carte. Valeurs possibles : 0 - (par défaut) afficher le groupe d'hôtes en tant qu'élément unique ; 1 - affiche chaque hôte du groupe séparément.
evaltype	integer	Méthode d'évaluation des conditions de filtrage des balises d'élément cartographique. Valeurs possibles : 0 - (par défaut) AND / OR; 2 - OR.
height	integer	Hauteur de l'élément de groupe d'hôtes de taille fixe en pixels. Par défaut : 200.
iconid_disabled	string	ID de l'icône utilisée pour afficher les éléments de carte désactivés. Non utilisé pour les éléments de type image.
iconid_maintenance	string	ID de l'icône utilisée pour afficher les éléments de la carte en maintenance. Non utilisé pour les éléments de type image.
iconid_on	string	ID de l'icône utilisée pour afficher les éléments de carte avec des problèmes. Non utilisé pour les éléments de type image.
label	string	Etiquette de l'élément.
label_location	integer	Position de l'étiquette de l'élément de carte. Valeurs possibles : -1 - (par défaut) position par défaut ; 0 - bas ; 1 - gauche ; 2 - droite ; 3 - haut.
permission	integer	Type de niveau d'autorisation. Valeurs possibles : -1 - aucun ; 2 - lecture seule ; 3 - lecture-écriture.
sysmapid	string	(lecture seule) ID de la carte à laquelle l'élément appartient.
urls	array	Éléments de carte URL. L'objet élément de carte URL est décrit en détail ci-dessous.
use_iconmap	integer	Indique si la correspondance d'icône doit être utilisée pour les éléments hôtes. Valeurs possibles : 0 - ne pas utiliser la correspondance d'icône ; 1 - (par défaut) utiliser la correspondance d'icône.
viewtype	integer	Algorithme de placement d'élément groupe d'hôtes. Valeurs possibles : 0 - (par défaut) grille.
width	integer	Largeur de l'élément groupe d'hôtes de taille fixe en pixels. Par défaut : 200.
x	integer	Coordonnée X de l'élément en pixels. Par défaut : 0.
y	integer	Coordonnée Y de l'élément en pixels. Par défaut : 0.

Élément de carte Hôte

L'objet élément de carte Hôte définit un élément hôte.

Propriété	Type	Description
hostid	string	ID de l'hôte.

Élément de carte Groupe d'hôtes

L'objet élément de carte Groupe d'hôtes définit un élément groupe d'hôtes.

Propriété	Type	Description
groupid	string	ID du groupe d'hôtes.

Élément de carte Carte

L'objet élément de carte Carte définit un élément de carte.

Propriété	Type	Description
sysmapid	string	ID de la carte.

Élément de carte Déclencheur

L'objet élément de carte Déclencheur définit un ou plusieurs éléments déclencheurs.

Propriété	Type	Description
triggerid	string	ID du déclencheur.

Élément de carte Tag

L'objet d'élément de carte Tag a les propriétés suivantes.

Propriété	Type	Description
tag (obligatoire)	string	Nom de balise d'élément de carte.
operator	string	Opérateur de condition de balise d'élément de carte. Valeurs possibles : 0 - (par défaut) Contains; 1 - Equals; 2 - Does not contain; 3 - Does not equal; 4 - Exists; 5 - Does not exist.
value	string	Valeur de balise d'élément de carte.

Élément de carte URL

L'objet élément de carte URL définit un lien cliquable qui sera disponible pour un élément de carte spécifique. Il a les propriétés suivantes :

Propriété	Type	Description
sysmapelementurlid	string	(lecture seule) ID de l'élément de carte URL.
name (obligatoire)	string	Légende de lien.
url (obligatoire)	string	URL du lien.
selementid	string	ID de l'élément de carte auquel l'URL appartient.

Lien de carte

L'objet lien de carte définit un lien entre deux éléments de carte. Il a les propriétés suivantes.

Propriété	Type	Description
linkid	string	(lecture seule) ID du lien de carte.
selementid1 (obligatoire)	string	ID du premier élément de carte lié à une extrémité.
selementid2 (obligatoire)	string	ID du premier élément de carte lié à l'autre extrémité.
color	string	Couleur de ligne sous forme de code couleur hexadécimal. Par défaut : `000000`.
drawtype	integer	Style de ligne de lien. Valeurs possibles : 0 - (par défaut) ligne ; 2 - ligne en gras ; 3 - ligne pointillée ; 4 - ligne avec des tirets.
label	string	Étiquette de lien.
linktriggers	array	Les déclencheurs de lien de carte à utiliser comme indicateurs d'état de lien. L'objet déclencheur de lien de carte est décrit en détail ci-dessous.
permission	integer	Type de niveau d'autorisation. Valeurs possibles : -1 - aucun ; 2 - lecture seule ; 3 - lecture-écriture.
sysmapid	string	ID de la carte à laquelle le lien appartient.

Déclencheur de lien de carte

L'objet déclencheur de lien de carte définit un indicateur d'état de lien de carte basé sur l'état d'un déclencheur. Il a les propriétés suivantes :

Propriété	Type	Description
linktriggerid	string	(lecture seule) ID du déclencheur de lien de carte.
triggerid (obligatoire)	string	ID du déclencheur utilisé comme indicateur de lien.
color	string	Couleur de l'indicateur sous forme de code couleur hexadécimal. Par défaut : `DD0000`.
drawtype	integer	Style de dessin de l'indicateur. Valeurs possibles : 0 - (par défaut) ligne ; 2 - ligne en gras ; 3 - ligne pointillée ; 4 - ligne avec des tirets.
linkid	string	ID du lien de carte auquel le déclencheur de lien appartient.

URL de carte

L'objet URL de carte définit un lien cliquable qui sera disponible pour tous les éléments d'un type spécifique sur la carte. Il a les propriétés suivantes :

Propriété	Type	Description
sysmapurlid	string	(lecture seule) ID de l'URL de carte.
name (obligatoire)	string	Légende du lien.
url (obligatoire)	string	URL du lien.
elementtype	integer	Type d'élément de carte pour lequel l'URL sera disponible. Se référer à [la propriété "elementtype" de l'élément de carte(object#map_element) pour une liste de types supportés. Par défaut : 0.
sysmapid	string	ID de la carte à laquelle l'URL appartient.

Utilisateur de carte

L'objet Utilisateur de carte liste des autorisations de carte basées sur les utilisateurs. Il a les propriétés suivantes :

Propriété	Type	Description
sysmapuserid	string	(lecture seule) ID de l'utilisateur de carte.
userid (obligatoire)	string	ID de l'utilisateur.
permission (obligatoire)	integer	Type de niveau d'autorisation. Valeurs possibles : 2 - lecture seule ; 3 - lecture-écriture ;

Groupe d'utilisateurs de carte

L'objet Groupe d'utilisateurs de carte liste des autorisations de carte basées sur les groupes d'utilisateurs. Il a les propriétés suivantes :

PropriétéType	Description
sysmapusrgrpid	string	(lecture seule) ID du groupe d'utilisateurs de carte.
usrgrpid (obligatoire)	string	ID du groupe d'utilisateurs.
permission (obligatoire)	integer	Type de niveau d'autorisation. Valeurs possibles : 2 - lecture seule ; 3 - lecture-écriture ;

Forme de carte

L'objet Forme de carte définit une forme géométrique (avec ou sans texte) affichée sur une carte. Il a les propriétés suivantes :

Propriété	Type	Description
sysmap_shapeid	string	(lecture seule) ID de la forme de carte.
type (obligatoire)	integer	Type de la forme de carte. Valeurs possibles : 0 - rectangle ; 1 - ellipse. Cette propriété est requise lorsque de nouvelles formes sont créées.
x	integer	Coordonnée X de la forme en pixels. Par défaut : 0.
y	integer	Coordonnée Y de la forme en pixels. Par défaut : 0.
width	integer	Largeur de la forme en pixels. Par défaut : 200.
height	integer	Hauteur de la forme en pixels. Par défaut : 200.
text	string	Texte de la forme.
font	integer	Police du texte dans la forme. Valeurs possibles : 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 Par défaut : 9.
font_size	integer	Taille de la police en pixels. Par défaut : 11.
font_color	string	Couleur de la police. Par défaut : '000000'.
text_halign	integer	Alignement horizontal du texte. Valeurs possibles : 0 - centre ; 1 - gauche ; 2 - droite. Par défaut : 0.
text_valign	integer	Alignement vertical du texte Valeurs possibles : 0 - milieu ; 1 - haut ; 2 - bas. Par défaut : 0.
border_type	integer	Type de bordure. Valeurs possibles : 0 - aucune ; 1 - `—————` ; 2 - `·····` ; 3 - `- - -`. Par défaut : 0.
border_width	integer	Largeur de la bordure en pixels. Par défaut : 0.
border_color	string	Couleur de la bordure. Par défaut : '000000'.
background_color	string	Couleur de fond (couleur de remplissage). Par défaut : `(vide)`.
zindex	integer	Valeur utilisée pour ordonner toutes les formes et lignes (z-index). Par défaut : 0.

Ligne de carte

L'objet Ligne de carte définit une ligne affichée sur une carte. Il a les propriétés suivantes :

Propriété	Type	Description
sysmap_shapeid	string	(lecture seule) ID de la forme de carte.
x1	integer	Coordonnée X du point 1 de la ligne en pixels. Par défaut : 0.
y1	integer	Coordonnée Y du point 1 de la ligne en pixels. Par défaut : 0.
x2	integer	Coordonnée X du point 2 de la ligne en pixels. Par défaut : 200.
y2	integer	Coordonnée Y du point 2 de la ligne en pixels. Par défaut : 200.
line_type	integer	Type de ligne. Valeurs possibles : 0 - aucune ; 1 - `—————` ; 2 - `·····` ; 3 - `- - -`. Par défaut : 0.
line_width	integer	Largeur de la ligne en pixels. Par défaut : 0.
line_color	string	Couleur de la ligne. Par défaut : '000000'.
zindex	integer	Valeur utilisée pour ordonner toutes les formes et lignes (z-index). Par défaut : 0.

Documentation