map.exists

Description

boolean map.exists(object filter)

This method checks if at least one map that matches the given filter criteria exists.

Parameters

(object) Criteria to search by.

The following parameters are supported as search criteria.

Parameter	Type	Description
name	string/array	Names of the maps.
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.
sysmapid	string/array	IDs of the maps.

Return values

(boolean) Returns true if at least one map that matches the given filter criteria exists.

Examples

Check a map by name

Check if map "Local network" exists.

Request:

{
           "jsonrpc": "2.0",
           "method": "map.exists",
           "params": {
               "name": "Local network"
           },
           "auth": "3a57200802b24cda67c4e4010b50c065",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": true,
           "id": 1
       }

Source

CMap::exists() in frontends/php/api/classes/CMap.php.

Documentation