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.getobjects

Description

array map.getobjects(object filter)

This method allows to retrieve maps that match the given filter criteria.

This method is deprecated and will be removed in the future. Please use map.get instead.

Parameters

(object) Map properties to search by.

Return values

(array) Returns an array of objects with all properties.

Examples

Retrieve a map by name

Retrieve a map called "Local network".

Request:

{
           "jsonrpc": "2.0",
           "method": "map.getobjects",
           "params": {
               "name": "Local nerwork"
           },
           "auth": "3a57200802b24cda67c4e4010b50c065",
           "id": 1
       }
Copy
✔ Copied

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "urls": [],
                   "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"
               }
           ],
           "id": 1
       }
Copy
✔ Copied

See also

Source

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

To toggle search highlight, press Ctrl+Alt+H
Have an improvement suggestion for this page? Select the text that could be improved and press Ctrl+Enter to send it to the editors.