manual:api:reference:map:create

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
manual:api:reference:map:create [2017/04/21 11:55]
vjaceslavs added map shapes
manual:api:reference:map:create [2017/09/13 09:01]
miks.kronkalns [Create a host map]
Line 20: Line 20:
 | userGroups | array | Map user group shares to be created on the map. | | userGroups | array | Map user group shares to be created on the map. |
 | shapes | array | Map shapes to be created on the map. | | shapes | array | Map shapes to be created on the map. |
 +| lines | array | Map lines to be created on the map. |
  
 <note tip>To create map links you'll need to set a map elements ''​selementid''​ to an arbitrary value and then use this value to reference this element in the links ''​selementid1''​ or ''​selementid2''​ properties. When the element is created, this value will be replaced with the correct ID generated by Zabbix. [[create#​create_a_host_map|See example.]]</​note>​ <note tip>To create map links you'll need to set a map elements ''​selementid''​ to an arbitrary value and then use this value to reference this element in the links ''​selementid1''​ or ''​selementid2''​ properties. When the element is created, this value will be replaced with the correct ID generated by Zabbix. [[create#​create_a_host_map|See example.]]</​note>​
Line 75: Line 76:
         "​selements":​ [         "​selements":​ [
             {             {
-                "​elementid":​ "​1033",​ 
                 "​selementid":​ "​1",​                 "​selementid":​ "​1",​
 +                "​elements":​ [
 +                    {"​hostid":​ "​1033"​}
 +                ],
                 "​elementtype":​ 0,                 "​elementtype":​ 0,
                 "​iconid_off":​ "​2"​                 "​iconid_off":​ "​2"​
             },             },
 +
             {             {
-                "​elementid":​ "​1037",​ 
                 "​selementid":​ "​2",​                 "​selementid":​ "​2",​
 +                "​elements":​ [
 +                    {"​hostid":​ "​1037"​}
 +                ],
                 "​elementtype":​ 0,                 "​elementtype":​ 0,
                 "​iconid_off":​ "​2"​                 "​iconid_off":​ "​2"​
Line 106: Line 112:
         "​sysmapids":​ [         "​sysmapids":​ [
             "​9"​             "​9"​
 +        ]
 +    },
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +=== Create a trigger map ===
 +
 +Create a map with trigger element, which contains two triggers.
 +
 +Request:
 +<code js>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​map.create",​
 +    "​params":​ {
 +        "​name":​ "​Trigger map",
 +        "​width":​ 600,
 +        "​height":​ 600,
 +        "​selements":​ [
 +            {
 +                "​elements":​ [
 +                    {"​triggerid":​ "​12345"​},​
 +                    {"​triggerid":​ "​67890"​}
 +                ],
 +                "​elementtype":​ 2,
 +                "​iconid_off":​ "​2"​
 +            }
 +        ]
 +    },
 +    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Response:
 +<code js>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ {
 +        "​sysmapids":​ [
 +            "​10"​
         ]         ]
     },     },
Line 158: Line 206:
 === Map shapes === === Map shapes ===
  
-Create a map with with map name title.+Create a map with map name title.
  
 Request: Request:
Line 171: Line 219:
         "​shapes":​ [         "​shapes":​ [
             {             {
-                "​type":​ 0+                "​type":​ 0,
                 "​x":​ 0,                 "​x":​ 0,
                 "​y":​ 0,                 "​y":​ 0,
Line 192: Line 240:
         "​sysmapids":​ [         "​sysmapids":​ [
             "​10"​             "​10"​
 +        ]
 +    },
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +=== Map lines ===
 +
 +Create a map line.
 +
 +Request:
 +<code js>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​map.create",​
 +    "​params":​ {
 +        "​name":​ "Map API lines",​
 +        "​width":​ 500,
 +        "​height":​ 500,
 +        "​lines":​ [
 +            {
 +                "​x1":​ 30,
 +                "​y1":​ 10,
 +                "​x2":​ 100,
 +                "​y2":​ 50,
 +                "​line_type":​ 1,
 +                "​line_width":​ 10,
 +                "​line_color":​ "​009900"​
 +            }
 +        ]
 +    },
 +    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Response:
 +<code js>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ {
 +        "​sysmapids":​ [
 +            "​11"​
         ]         ]
     },     },
Line 206: Line 297:
   * [[object#​map_user_group|Map user group]]   * [[object#​map_user_group|Map user group]]
   * [[object#​map_shapes|Map shape]]   * [[object#​map_shapes|Map shape]]
 +  * [[object#​map_lines|Map line]]
  
 ==== Source ==== ==== Source ====
  
 CMap::​create() in //​frontends/​php/​include/​classes/​api/​services/​CMap.php//​. CMap::​create() in //​frontends/​php/​include/​classes/​api/​services/​CMap.php//​.