Table of Contents
map.getobjects
Description
array map.getobjects(object filter)
This method allows to retrieve maps that match the given filter criteria.
Parameters
(object) Criteria to search by.
Additionally to the standard standard map properties the following parameters are supported as search criteria.
| Parameter | Type | Description |
|---|---|---|
| node | string | Name of the node the maps must belong to. This will override the nodeids parameter. |
| nodeids | string/array | IDs of the nodes the maps must belong to. |
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 network"
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"urls": [],
"sysmapid": "3",
"name": "Local network",
"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"
}
],
"id": 1
}See also
Source
CMap::getObject() in frontends/php/api/classes/CMap.php.