Zabbix Documentation 1.8

3.04.05.0 (current)| In development:5.2 (devel)| Unsupported:1.82.02.22.43.23.44.24.4Guidelines

User Tools

Site Tools


api:map:update

Differences

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

Link to this comparison view

api:map:update [2020/05/05 11:33]
api:map:update [2019/01/28 14:45] (current)
sasha <code js> => <code java>
Line 1: Line 1:
 +===== update() =====
 +Available since version: **1.8**\\
 +The method is used to control all map attributes.
  
 +==== Parameters ====
 +^Parameter^Type^Optional^Description^Details^
 +|**sysmapid**|//​string//​| ​ |Map ID. | |
 +|**map attribute**|//​any//​| Yes |New value for a map attribute. ​ | |
 +
 +==== Returns =====
 +^Parameter^Description^
 +|**result**|Operation successful. Result will contain array of updated Map IDs.|
 +|**error**|In case of any errors|
 +
 +==== Example =====
 +
 +Set map name to "New Name":
 +
 +<code java>
 +  {
 +   "​jsonrpc":"​2.0",​
 +   "​method":"​map.update",​
 +   "​params":​{
 +      "​sysmapid":​ "​100100000010092",​
 +      "​name":​ "New Name"
 +   },
 +   "​auth":"​700ca65537074ec963db7efabda78259",​
 +   "​id":​2
 +  }
 +</​code>​
 +
 +Retrieved updated map IDs:
 +
 +<code java>
 +  {
 +   "​jsonrpc":"​2.0",​
 +   "​result":​ {
 +       "​sysmapids":​["​100100000010092"​]
 +   },
 +   "​id":​2
 +  }
 +</​code>​