The map object has the following properties.

    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.
    elementid(required) string ID of the object that the map element represents. 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.
    application string Name of the application to display problems from. Used only for host and host group map elements.
    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.
    height integer Height of the fixed size host group element in pixels. Default: 200.
    iconiddisabled 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.
    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.

    Map element URL

    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: .
    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.
    sysmapid string ID of the map the link belongs to.

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

    Map URL

    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 for a list of supported types. Default: 0.
    sysmapid string ID of the map that the URL belongs to.

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

    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;