This is the documentation page for an unsupported version of Zabbix.
Is this not what you were looking for? Switch to the current version or choose one from the drop-down menu.

map.get

Description

integer/array map.get(object parameters)

The method allows to retrieve maps according to the given parameters.

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

Parameter Type Description
sysmapids string/array Return only maps with the given IDs.
userids string/array Return only maps that belong to the given user IDs.
expandUrls flag Adds global map URLs to the corresponding map elements and expands macros in all map element URLs.
selectIconMap query Returns the icon map used on the map in the iconmap property.
selectLinks query Returns map links between elements in the links property.
selectSelements query Returns the map elements from the map in the selements property.
selectUrls query Returns the map URLs in the urls property.
selectUsers query Returns users that the map is shared with in users property.
selectUserGroups query Returns user groups that the map is shared with in userGroups property.
selectShapes query Returns the map shapes from the map in the shapes property.
selectLines query Returns the map lines from the map in the lines property.
sortfield string/array Sort the result by the given properties.

Possible values are: name, width and height.
countOutput boolean These parameters being common for all get methods are described in detail in the reference commentary.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Return values

(integer/array) Returns either:

  • an array of objects;
  • the count of retrieved objects, if the countOutput parameter has been used.

Examples

Retrieve a map

Retrieve all data about map "3".

Request:

{
           "jsonrpc": "2.0",
           "method": "map.get",
           "params": {
               "output": "extend",
               "selectSelements": "extend",
               "selectLinks": "extend",
               "selectUsers": "extend",
               "selectUserGroups": "extend",
               "selectShapes": "extend",
               "selectLines": "extend",
               "sysmapids": "3"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "selements": [
                       {
                           "selementid": "10",
                           "sysmapid": "3",
                           "elementtype": "4",
                           "iconid_off": "1",
                           "iconid_on": "0",
                           "label": "Zabbix server",
                           "label_location": "3",
                           "x": "11",
                           "y": "141",
                           "iconid_disabled": "0",
                           "iconid_maintenance": "0",
                           "elementsubtype": "0",
                           "areatype": "0",
                           "width": "200",
                           "height": "200",
                           "viewtype": "0",
                           "use_iconmap": "1",
                           "application": "",
                           "urls": [],
                           "elements": []
                       },
                       {
                           "selementid": "11",
                           "sysmapid": "3",
                           "elementtype": "4",
                           "iconid_off": "1",
                           "iconid_on": "0",
                           "label": "Web server",
                           "label_location": "3",
                           "x": "211",
                           "y": "191",
                           "iconid_disabled": "0",
                           "iconid_maintenance": "0",
                           "elementsubtype": "0",
                           "areatype": "0",
                           "width": "200",
                           "height": "200",
                           "viewtype": "0",
                           "use_iconmap": "1",
                           "application": "",
                           "urls": [],
                           "elements": []
                       },
       {
                           "selementid": "12",
                           "sysmapid": "3",
                           "elementtype": "0",
                           "iconid_off": "185",
                           "iconid_on": "0",
                           "label": "{HOST.NAME}\r\n{HOST.CONN}",
                           "label_location": "0",
                           "x": "111",
                           "y": "61",
                           "iconid_disabled": "0",
                           "iconid_maintenance": "0",
                           "elementsubtype": "0",
                           "areatype": "0",
                           "width": "200",
                           "height": "200",
                           "viewtype": "0",
                           "use_iconmap": "0",
                           "application": "",
                           "urls": [],
                           "elements": [
                               {
                                   "hostid": "10084"
                               }
                           ]
                       }
                   ],
                   "links": [
                       {
                           "linkid": "23",
                           "sysmapid": "3",
                           "selementid1": "10",
                           "selementid2": "11",
                           "drawtype": "0",
                           "color": "00CC00",
                           "label": "",
                           "linktriggers": []
                       }
                   ],
                   "users": [
                       {
                           "sysmapuserid": "1",
                           "userid": "2",
                           "permission": "2"
                       }
                   ],
                   "userGroups": [
                       {
                           "sysmapusrgrpid": "1",
                           "usrgrpid": "7",
                           "permission": "2"
                       }
                   ],
                   "shapes":[  
                       {  
                           "sysmap_shapeid":"1",
                           "type":"0",
                           "x":"0",
                           "y":"0",
                           "width":"680",
                           "height":"15",
                           "text":"{MAP.NAME}",
                           "font":"9",
                           "font_size":"11",
                           "font_color":"000000",
                           "text_halign":"0",
                           "text_valign":"0",
                           "border_type":"0",
                           "border_width":"0",
                           "border_color":"000000",
                           "background_color":"",
                           "zindex":"0"
                       }
                   ],
                   "lines":[
                       {
                           "sysmap_shapeid":"2",
                           "x1": 30,
                           "y1": 10,
                           "x2": 100,
                           "y2": 50,
                           "line_type": 1,
                           "line_width": 10,
                           "line_color": "009900",
                           "zindex":"1"
                       }
                   ],
                   "sysmapid": "3",
                   "name": "Local nerwork",
                   "width": "400",
                   "height": "400",
                   "backgroundid": "0",
                   "label_type": "2",
                   "label_location": "3",
                   "highlight": "1",
                   "expandproblem": "1",
                   "markelements": "0",
                   "show_unack": "0",
                   "grid_size": "50",
                   "grid_show": "1",
                   "grid_align": "1",
                   "label_format": "0",
                   "label_type_host": "2",
                   "label_type_hostgroup": "2",
                   "label_type_trigger": "2",
                   "label_type_map": "2",
                   "label_type_image": "2",
                   "label_string_host": "",
                   "label_string_hostgroup": "",
                   "label_string_trigger": "",
                   "label_string_map": "",
                   "label_string_image": "",
                   "iconmapid": "0",
                   "expand_macros": "0",
                   "severity_min": "0",
                   "userid": "1",
                   "private": "1"
               }
           ],
           "id": 1
       }

See also

Source

CMap::get() in frontends/php/include/classes/api/services/CMap.php.