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

    Parameters

    (object) Parameters defining the desired output.

    The method supports the following parameters.

    Returns either:

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

    Examples

    Retrieve a map

    Retrieve all data about map “3”.

    Request:

    Response:

    1. {
    2.     "jsonrpc": "2.0",
    3.     "result": [
    4.         {
    5.             "selements": [
    6.                 {
    7.                     "selementid": "10",
    8.                     "sysmapid": "3",
    9.                     "elementid": "0",
    10.                     "elementtype": "4",
    11.                     "iconid_off": "1",
    12.                     "iconid_on": "0",
    13.                     "label": "Zabbix server",
    14.                     "label_location": "3",
    15.                     "x": "11",
    16.                     "y": "141",
    17.                     "iconid_disabled": "0",
    18.                     "iconid_maintenance": "0",
    19.                     "elementsubtype": "0",
    20.                     "areatype": "0",
    21.                     "width": "200",
    22.                     "height": "200",
    23.                     "viewtype": "0",
    24.                     "use_iconmap": "1",
    25.                     "application": "",
    26.                     "urls": []
    27.                 },
    28.                 {
    29.                     "selementid": "11",
    30.                     "sysmapid": "3",
    31.                     "elementid": "0",
    32.                     "elementtype": "4",
    33.                     "iconid_on": "0",
    34.                     "label": "Web server",
    35.                     "label_location": "3",
    36.                     "x": "211",
    37.                     "y": "191",
    38.                     "iconid_disabled": "0",
    39.                     "iconid_maintenance": "0",
    40.                     "elementsubtype": "0",
    41.                     "areatype": "0",
    42.                     "width": "200",
    43.                     "height": "200",
    44.                     "viewtype": "0",
    45.                     "use_iconmap": "1",
    46.                     "application": "",
    47.                     "urls": []
    48.                 }
    49.             ],
    50.             "links": [
    51.                 {
    52.                     "linkid": "23",
    53.                     "sysmapid": "3",
    54.                     "selementid1": "10",
    55.                     "selementid2": "11",
    56.                     "drawtype": "0",
    57.                     "color": "00CC00",
    58.                     "label": "",
    59.                     "linktriggers": []
    60.                 }
    61.             ],
    62.             "users": [
    63.                 {
    64.                     "sysmapuserid": "1",
    65.                     "userid": "2",
    66.                     "permission": "2"
    67.                 }
    68.             ],
    69.             "userGroups": [
    70.                 {
    71.                     "sysmapusrgrpid": "1",
    72.                     "usrgrpid": "7",
    73.                     "permission": "2"
    74.             ],
    75.             "sysmapid": "3",
    76.             "name": "Local nerwork",
    77.             "width": "400",
    78.             "height": "400",
    79.             "backgroundid": "0",
    80.             "label_type": "2",
    81.             "label_location": "3",
    82.             "highlight": "1",
    83.             "expandproblem": "1",
    84.             "markelements": "0",
    85.             "show_unack": "0",
    86.             "grid_size": "50",
    87.             "grid_show": "1",
    88.             "grid_align": "1",
    89.             "label_format": "0",
    90.             "label_type_host": "2",
    91.             "label_type_hostgroup": "2",
    92.             "label_type_trigger": "2",
    93.             "label_type_map": "2",
    94.             "label_type_image": "2",
    95.             "label_string_host": "",
    96.             "label_string_hostgroup": "",
    97.             "label_string_trigger": "",
    98.             "label_string_map": "",
    99.             "label_string_image": "",
    100.             "iconmapid": "0",
    101.             "expand_macros": "0",
    102.             "severity_min": "0",
    103.             "userid": "1",
    104.             "private": "1"
    105.         }
    106.     ],
    107.     "id": 1
    108. }

    Source

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