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
manual:api:reference:map:create [2017/04/21 11:55]
vjaceslavs added map shapes
manual:api:reference:map:create [2020/08/25 10:57]
Line 1: Line 1:
-===== map.create ===== 
  
-==== Description ==== 
- 
-''​object map.create(object/​array **maps**)''​ 
- 
-This method allows to create new maps. 
- 
-==== Parameters ==== 
- 
-''​(object/​array)''​ Maps to create. 
- 
-Additionally to the [[object#​map|standard map properties]],​ the method accepts the following parameters. 
- 
-^ Parameter ^ Type ^ Description ^ 
-| links | array | Map links to be created on the map. | 
-| selements | array | Map elements to be created on the map. | 
-| urls | array | Map URLs to be created on the map. | 
-| users | array | Map user 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. | 
- 
-<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>​ 
-==== Return values ==== 
- 
-''​(object)''​ Returns an object containing the IDs of the created maps under the ''​sysmapids''​ property. The order of the returned IDs matches the order of the passed maps. 
- 
-==== Examples ==== 
- 
-=== Create an empty map === 
- 
-Create a map with no elements. 
- 
-Request: 
-<code js> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​method":​ "​map.create",​ 
-    "​params":​ { 
-        "​name":​ "​Map",​ 
-        "​width":​ 600, 
-        "​height":​ 600 
-    }, 
-    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​ 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-Response: 
-<code js> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​result":​ { 
-        "​sysmapids":​ [ 
-            "​8"​ 
-        ] 
-    }, 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-=== Create a host map === 
- 
-Create a map with two host elements and a link between them. Note the use of temporary "​selementid1"​ and "​selementid2"​ values in the map link object to refer to map elements. 
- 
-Request: 
-<code js> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​method":​ "​map.create",​ 
-    "​params":​ { 
-        "​name":​ "Host map", 
-        "​width":​ 600, 
-        "​height":​ 600, 
-        "​selements":​ [ 
-            { 
-                "​elementid":​ "​1033",​ 
-                "​selementid":​ "​1",​ 
-                "​elementtype":​ 0, 
-                "​iconid_off":​ "​2"​ 
-            }, 
-            { 
-                "​elementid":​ "​1037",​ 
-                "​selementid":​ "​2",​ 
-                "​elementtype":​ 0, 
-                "​iconid_off":​ "​2"​ 
-            } 
-        ], 
-        "​links":​ [ 
-            { 
-                "​selementid1":​ "​1",​ 
-                "​selementid2":​ "​2"​ 
-            } 
-        ] 
-    }, 
-    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​ 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-Response: 
-<code js> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​result":​ { 
-        "​sysmapids":​ [ 
-            "​9"​ 
-        ] 
-    }, 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-=== Map sharing === 
- 
-Create a map with two types of sharing (user and user group). 
- 
-Request: 
-<code js> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​method":​ "​map.create",​ 
-    "​params":​ { 
-        "​name":​ "Map sharing",​ 
-        "​width":​ 600, 
-        "​height":​ 600, 
-        "​users":​ [ 
-            { 
-                "​userid":​ "​4",​ 
-                "​permission":​ "​3"​ 
-            } 
-        ], 
-        "​userGroups":​ [ 
-            { 
-                "​usrgrpid":​ "​7",​ 
-                "​permission":​ "​2"​ 
-            } 
-        ] 
-    }, 
-    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​ 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-Response: 
-<code js> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​result":​ { 
-        "​sysmapids":​ [ 
-            "​9"​ 
-        ] 
-    }, 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-=== Map shapes === 
- 
-Create a map with with map name title. 
- 
-Request: 
-<code js> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​method":​ "​map.create",​ 
-    "​params":​ { 
-        "​name":​ "Host map", 
-        "​width":​ 600, 
-        "​height":​ 600, 
-        "​shapes":​ [ 
-            { 
-                "​type":​ 0 
-                "​x":​ 0, 
-                "​y":​ 0, 
-                "​width":​ 600, 
-                "​height":​ 11, 
-                "​text":​ "​{MAP.NAME}"​ 
-            } 
-        ] 
-    }, 
-    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​ 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-Response: 
-<code js> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​result":​ { 
-        "​sysmapids":​ [ 
-            "​10"​ 
-        ] 
-    }, 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-==== See also ==== 
- 
-  * [[object#​map_element|Map element]] 
-  * [[object#​map_link|Map link]] 
-  * [[object#​map_url|Map URL]] 
-  * [[object#​map_user|Map user]] 
-  * [[object#​map_user_group|Map user group]] 
-  * [[object#​map_shapes|Map shape]] 
- 
-==== Source ==== 
- 
-CMap::​create() in //​frontends/​php/​include/​classes/​api/​services/​CMap.php//​.