Table of Contents

> Objeto de mapa

> Objeto de mapa

Los siguientes objetos están directamente relacionados con la API "map".

Mapa

El objeto de mapa tiene las siguientes propiedades.

Propiedad	Tipo	Descripción
sysmapid	string	(readonly) ID del mapa.
height (obligatorio)	entero	Alto del mapa en píxeles.
name (obligatorio)	cadena	Nombre del mapa.
width (obligatorio)	entero	Ancho del mapa en píxeles.
backgroundid	cadena	ID de la imagen utilizada como fondo del mapa.
expand_macros	entero	Si se deben expandir las macros en las etiquetas al configurar el mapa. Valores posibles: 0 - (predeterminado) no expandir las macros; 1 - expandir las macros.
expandproblem	entero	Si el iniciador del problema se mostrará para métricas con un solo problema. Valores posibles: 0: siempre muestra el número de problemas; 1 - (predeterminado) muestra el iniciador del problema si solo hay un problema.
grid_align	entero	Si se debe habilitar la alineación de la cuadrícula. Valores posibles: 0 - deshabilitar la alineación de la cuadrícula; 1 - (predeterminado) habilitar la alineación de la cuadrícula.
grid_show	entero	Si se debe mostrar la cuadrícula en el mapa. Valores posibles: 0 - no mostrar la cuadrícula; 1 - (predeterminado) mostrar la cuadrícula.
grid_size	entero	Tamaño de la cuadrícula del mapa en píxeles. Valores admitidos: 20, 40, 50, 75 y 100. Predeterminado: 50.
highlight	entero	Si el resaltado de iconos está habilitado. Valores posibles: 0 - resaltado deshabilitado; 1 - (predeterminado) resaltado habilitado.
iconmapid	string	ID del mapa de iconos utilizado en el mapa.
label_format	entero	Si se deben habilitar etiquetas avanzadas. Valores posibles: 0 - (predeterminado) deshabilitar etiquetas avanzadas; 1 - habilitar etiquetas avanzadas.
label_location	entero	Ubicación de la etiqueta del elemento del mapa. Valores posibles: 0 - (predeterminado) abajo; 1 - izquierda; 2 - derecha;< br>3 - arriba.
label_string_host	string	Etiqueta personalizada para elementos de equipo. Requerido para mapas con tipo de etiqueta de equipo personalizado.
label_string_hostgroup	cadena	Etiqueta personalizada para elementos del grupo de equipos. Obligatoria para mapas con tipo de etiqueta de grupo de equipos personalizado.
label_string_image	cadena	Etiqueta personalizada para elementos de imagen. Obligatoria para mapas con tipo de etiqueta de imagen personalizada.
label_string_map	string	Etiqueta personalizada para elementos de mapa. Obligatoria para mapas con tipo de etiqueta de mapa personalizada.
label_string_trigger	cadena	Etiqueta personalizada para elementos de activación. Obligatoria para mapas con tipo de etiqueta de activación personalizada.
label_type	entero	Tipo de etiqueta del elemento del mapa. Valores posibles: 0 - etiqueta; 1 - dirección IP; 2 - (predeterminado) nombre del elemento;< br>3 - solo estado; 4 - nada.
label_type_host	entero	Tipo de etiqueta para elementos de equipo. Valores posibles: 0 - etiqueta; 1 - dirección IP; 2 - elemento (predeterminado) nombre; 3 - solo estado; 4 - nada; 5 - personalizado.
label_type_hostgroup	integer	Tipo de etiqueta para elementos del grupo de equipos. Valores posibles: 0 - etiqueta; 2 - (predeterminado) nombre del elemento; 3 - solo estado; 4 - nada; 5 - personalizado.
label_type_image	integer	Tipo de etiqueta para elementos del grupo de equipos. Valores posibles: 0 - etiqueta; 2 - (predeterminado) nombre del elemento; 4 - nada; 5 - personalizado.
label_type_map	integer	Tipo de etiqueta para elementos del mapa. Valores posibles: 0 - etiqueta; 2 - (predeterminado) nombre del elemento; 3 - estado solamente; 4 - nada; 5 - personalizado.
label_type_trigger	integer	Tipo de etiqueta para elementos de iniciador. Valores posibles: 0 - etiqueta; 2 - (predeterminado) nombre del elemento; 3 - estado solamente; 4 - nada; 5 - personalizado.
markelements	integer	Si se deben resaltar elementos del mapa que han cambiado recientemente su estado. Valores posibles: 0 - (predeterminado) no resaltar elementos; 1 - resaltar elementos.
severity_min	integer	Severidad mínima de los iniciadores que se mostrarán en el mapa. Consulte la propiedad "gravedad" del iniciador para obtener una lista de gravedades de activación admitidas.
show_unack	integer	Cómo se deben mostrar los problemas. Valores posibles: 0 - (predeterminado) muestra el recuento de todos los problemas; 1 - muestra solo el recuento de los no reconocidos problemas; 2: muestra el recuento de problemas reconocidos y no reconocidos por separado.
userid	cadena	ID de usuario del propietario del mapa.
private	entero	Tipo de mapa compartido. Valores posibles: 0 - mapa público; 1 - (predeterminado) mapa privado.
show_suppressed	integer	Si se muestran los problemas suprimidos. Valores posibles: 0 - (predeterminado) oculta los problemas suprimidos; 1 - muestra los problemas suprimidos.

Tenga en cuenta que para algunos métodos (actualizar, eliminar) la combinación de parámetros requeridos/opcionales es diferente.

Map element

The map element object defines an object displayed on a map. It has the following properties.

Property	Type	Description
selementid	string	(readonly) ID of the map element.
elements (required)	array	Element data object. Required for host, host group, trigger and map type elements.
elementtype (required)	integer	Type of map element. Possible values: 0 - host; 1 - map; 2 - trigger; 3 - host group; 4 - image.
iconid_off (required)	string	ID of the image used to display the element in default state.
areatype	integer	How separate host group hosts should be displayed. Possible values: 0 - (default) the host group element will take up the whole map; 1 - the host group element will have a fixed size.
elementsubtype	integer	How a host group element should be displayed on a map. Possible values: 0 - (default) display the host group as a single element; 1 - display each host in the group separately.
evaltype	integer	Map element tag filtering condition evaluation method. Possible values: 0 - (default) AND / OR; 2 - OR.
height	integer	Height of the fixed size host group element in pixels. Default: 200.
iconid_disabled	string	ID of the image used to display disabled map elements. Unused for image elements.
iconid_maintenance	string	ID of the image used to display map elements in maintenance. Unused for image elements.
iconid_on	string	ID of the image used to display map elements with problems. Unused for image elements.
label	string	Label of the element.
label_location	integer	Location of the map element label. Possible values: -1 - (default) default location; 0 - bottom; 1 - left; 2 - right; 3 - top.
permission	integer	Type of permission level. Possible values: -1 - none; 2 - read only; 3 - read-write.
sysmapid	string	(readonly) ID of the map that the element belongs to.
urls	array	Map element URLs. The map element URL object is described in detail below.
use_iconmap	integer	Whether icon mapping must be used for host elements. Possible values: 0 - do not use icon mapping; 1 - (default) use icon mapping.
viewtype	integer	Host group element placing algorithm. Possible values: 0 - (default) grid.
width	integer	Width of the fixed size host group element in pixels. Default: 200.
x	integer	X-coordinates of the element in pixels. Default: 0.
y	integer	Y-coordinates of the element in pixels. Default: 0.

Elemento de mapa de equipos

El objeto de elemento de mapa de equipos define un elemento equipo.

Propiedad	Tipo	Descripción
hostid	cadena	ID de equipo

Elemento de mapa grupo de equipos

El objeto de elemento de mapa de grupo de equipos define un elemento del grupo de equipos.

Propiedad	Tipo	Descripción
groupid	cadena	ID del grupo de equipos

Elemento de mapa Mapa

El objeto de elemento de mapa define un elemento de mapa.

Propiedad	Tipo	Descripción
sysmapid	cadena	ID de mapa

Elemento de mapa Iniciador

El objeto iniciador del elemento de mapa define uno o más elementos de iniciador.

Propiedad	Tipo	Descripción
triggerid	cadena	ID de iniciador

Map element tag

The map element tag object has the following properties.

Property	Type	Description
tag (required)	string	Map element tag name.
operator	string	Map element tag condition operator. Possible values: 0 - (default) Contains; 1 - Equals; 2 - Does not contain; 3 - Does not equal; 4 - Exists; 5 - Does not exist.
value	string	Map element tag value.

URL del elemento del mapa

El objeto URL del elemento del mapa define un enlace en el que se puede hacer clic y que estará disponible para un elemento de mapa específico. Tiene las siguientes propiedades:

Propiedad	Tipo	Descripción
sysmapelementurlid	string	(readonly) ID de la URL del elemento del mapa.
nombre (obligatorio)	cadena	Título del enlace.
url (obligatorio)	cadena	URL del enlace.
selementid	cadena	ID del elemento del mapa al que pertenece la URL.

Map link

The map link object defines a link between two map elements. It has the following properties.

Property	Type	Description
linkid	string	(readonly) ID of the map link.
selementid1 (required)	string	ID of the first map element linked on one end.
selementid2 (required)	string	ID of the first map element linked on the other end.
color	string	Line color as a hexadecimal color code. Default: `000000`.
drawtype	integer	Link line draw style. Possible values: 0 - (default) line; 2 - bold line; 3 - dotted line; 4 - dashed line.
label	string	Link label.
linktriggers	array	Map link triggers to use as link status indicators. The map link trigger object is described in detail below.
permission	integer	Type of permission level. Possible values: -1 - none; 2 - read only; 3 - read-write.
sysmapid	string	ID of the map the link belongs to.

Map link trigger

The map link trigger object defines a map link status indicator based on the state of a trigger. It has the following properties:

Property	Type	Description
linktriggerid	string	(readonly) ID of the map link trigger.
triggerid (reqiuired)	string	ID of the trigger used as a link indicator.
color	string	Indicator color as a hexadecimal color code. Default: `DD0000`.
drawtype	integer	Indicator draw style. Possible values: 0 - (default) line; 2 - bold line; 3 - dotted line; 4 - dashed line.
linkid	string	ID of the map link that the link trigger belongs to.

Map URL

The map URL object defines a clickable link that will be available for all elements of a specific type on the map. It has the following properties:

Property	Type	Description
sysmapurlid	string	(readonly) ID of the map URL.
name (required)	string	Link caption.
url (required)	string	Link URL.
elementtype	integer	Type of map element for which the URL will be available. Refer to the map element "type" property for a list of supported types. Default: 0.
sysmapid	string	ID of the map that the URL belongs to.

Usuario del mapa

Lista de permisos de mapas basados en usuarios. Tiene las siguientes propiedades:

Propiedad	Tipo	Descripción
sysmapuserid	cadena	(readonly) ID del usuario del mapa.
userid (obligatorio)	cadena	ID de usuario.
permission (obligatorio)	entero	Tipo de nivel de permiso. Valores posibles: 2 - solo lectura; 3 - lectura-escritura;

Map user group

List of map permissions based on user groups. It has the following properties:

Property	Type	Description
sysmapusrgrpid	string	(readonly) ID of the map user group.
usrgrpid (required)	string	User group ID.
permission (required)	integer	Type of permission level. Possible values: 2 - read only; 3 - read-write;

Map shapes

The map shape object defines an geometric shape (with or without text) displayed on a map. It has the following properties:

Property	Type	Description
sysmap_shapeid	string	(readonly) ID of the map shape element.
type (required)	integer	Type of map shape element. Possible values: 0 - rectangle; 1 - ellipse. Property is required when new shapes are created.
x	integer	X-coordinates of the shape in pixels. Default: 0.
y	integer	Y-coordinates of the shape in pixels. Default: 0.
width	integer	Width of the shape in pixels. Default: 200.
height	integer	Height of the shape in pixels. Default: 200.
text	string	Text of the shape.
font	integer	Font of the text within shape. Possible values: 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 Default: 9.
font_size	integer	Font size in pixels. Default: 11.
font_color	string	Font color. Default: '000000'.
text_halign	integer	Horizontal alignment of text. Possible values: 0 - center; 1 - left; 2 - right. Default: 0.
text_valign	integer	Vertical alignment of text. Possible values: 0 - middle; 1 - top; 2 - bottom. Default: 0.
border_type	integer	Type of the border. Possible values: 0 - none; 1 - `—————`; 2 - `·····`; 3 - `- - -`. Default: 0.
border_width	integer	Width of the border in pixels. Default: 0.
border_color	string	Border color. Default: '000000'.
background_color	string	Background color (fill color). Default: `(empty)`.
zindex	integer	Value used to order all shapes and lines (z-index). Default: 0.

Map lines

The map line object defines an line displayed on a map. It has the following properties:

Property	Type	Description
sysmap_shapeid	string	(readonly) ID of the map shape element.
x1	integer	X-coordinates of the line point 1 in pixels. Default: 0.
y1	integer	Y-coordinates of the line point 1 in pixels. Default: 0.
x2	integer	X-coordinates of the line point 2 in pixels. Default: 200.
y2	integer	Y-coordinates of the line point 2 in pixels. Default: 200.
line_type	integer	Type of the lines. Possible values: 0 - none; 1 - `—————`; 2 - `·····`; 3 - `- - -`. Default: 0.
line_width	integer	Width of the lines in pixels. Default: 0.
line_color	string	Line color. Default: '000000'.
zindex	integer	Value used to order all shapes and lines (z-index). Default: 0.

Documentation