Zabbix Documentation 5.0

3.04.04.45.0 (current)| In development:5.2 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


manual:api:reference:valuemap:get

Differences

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

Link to this comparison view

Next revision
Previous revision
manual:api:reference:valuemap:get [2015/10/20 10:33]
iivs created valuemap.get method page
manual:api:reference:valuemap:get [2020/05/05 10:02] (current)
martins-v frontends/php -> ui (ZBX-17667)
Line 16: Line 16:
 | valuemapids | string/​array | Return only value maps with the given IDs. | | valuemapids | string/​array | Return only value maps with the given IDs. |
 ^ ||| ^ |||
-| selectMappings | query | Return the value mappings for current value map in the ''​mappings''​ property. |+| selectMappings | query | Return the value mappings for current value map in the ''​[[:​manual/​api/​reference/​valuemap/​object#​value_mappings|mappings]]''​ property. \\ \\ Supports ''​count''​. |
 ^ ||| ^ |||
 | sortfield | string/​array | Sort the result by the given properties. \\ \\ Possible values are: ''​valuemapid'',​ ''​name''​. ​ | | sortfield | string/​array | Sort the result by the given properties. \\ \\ Possible values are: ''​valuemapid'',​ ''​name''​. ​ |
-| countOutput |flag|These parameters being common for all ''​get''​ methods are described in detail in the [[manual:​api:​reference_commentary#​common_get_method_parameters|reference commentary]]. ​ |+| countOutput |boolean|These parameters being common for all ''​get''​ methods are described in detail in the [[manual:​api:​reference_commentary#​common_get_method_parameters|reference commentary]]. ​ |
 | editable |boolean|:::​| | editable |boolean|:::​|
-| excludeSearch |flag|:::|+| excludeSearch |boolean|:::|
 | filter | object |:::| | filter | object |:::|
 | limit |integer|:::​| | limit |integer|:::​|
 | output |query|:::| | output |query|:::|
-| preservekeys |flag|:::|+| preservekeys |boolean|:::|
 | search | object |:::| | search | object |:::|
 | searchByAny |boolean|:::​| | searchByAny |boolean|:::​|
 | searchWildcardsEnabled |boolean|:::​| | searchWildcardsEnabled |boolean|:::​|
 | sortorder | string/​array | ::: | | sortorder | string/​array | ::: |
-| startSearch |flag|:::|+| startSearch |boolean|:::|
 ==== Return values ==== ==== Return values ====
  
Line 44: Line 44:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 57: Line 57:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 81: Line 81:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 96: Line 96:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 141: Line 141:
 ==== Source ==== ==== Source ====
  
-CValueMap::​get() in //frontends/​php/​include/​classes/​api/​services/​CValueMap.php//​.+CValueMap::​get() in //ui/​include/​classes/​api/​services/​CValueMap.php//​.