manual:api:reference:valuemap:get

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
manual:api:reference:valuemap:get [2017/07/26 08:27]
sasha dropped support of non-boolean values for countOutput, excludeSearch, preservekeys and startSearch flags
manual:api:reference:valuemap:get [2019/01/28 14:50]
sasha <code js> => <code java>
Line 1: Line 1:
-===== valuemap.get ===== 
  
-==== Description ==== 
- 
-''​integer/​array valuemap.get(object **parameters**)''​ 
- 
-The method allows to retrieve value maps according to the given parameters. 
- 
-==== Parameters ==== 
- 
-''​(object)''​ Parameters defining the desired output. 
- 
-The method supports the following parameters. 
- 
-^ Parameter ^ Type ^ Description ^ 
-| 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. | 
-^ ||| 
-| sortfield | string/​array | Sort the result by the given properties. \\ \\ Possible values are: ''​valuemapid'',​ ''​name''​. ​ | 
-| 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|:::​| 
-| excludeSearch |boolean|:::​| 
-| filter | object |:::| 
-| limit |integer|:::​| 
-| output |query|:::| 
-| preservekeys |boolean|:::​| 
-| search | object |:::| 
-| searchByAny |boolean|:::​| 
-| searchWildcardsEnabled |boolean|:::​| 
-| sortorder | string/​array | ::: | 
-| startSearch |boolean|:::​| 
-==== Return values ==== 
- 
-''​(integer/​array)''​ Returns either: 
-  * an array of objects; 
-  * the count of retrieved objects, if the ''​countOutput''​ parameter has been used. 
- 
-==== Examples ==== 
- 
-=== Retrieving value maps === 
- 
-Retrieve all configured value maps. 
- 
-Request: 
-<code js> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​method":​ "​valuemap.get",​ 
-    "​params":​ { 
-        "​output":​ "​extend"​ 
-    }, 
-    "​auth":​ "​57562fd409b3b3b9a4d916d45207bbcb",​ 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-Response: 
-<code js> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​result":​ [ 
-        { 
-            "​valuemapid":​ "​4",​ 
-            "​name":​ "APC Battery Replacement Status"​ 
-        }, 
-        { 
-            "​valuemapid":​ "​5",​ 
-            "​name":​ "APC Battery Status"​ 
-        }, 
-        { 
-            "​valuemapid":​ "​7",​ 
-            "​name":​ "Dell Open Manage System Status"​ 
-        } 
-    ], 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-Retrieve one value map with its mappings. 
- 
-Request: 
-<code js> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​method":​ "​valuemap.get",​ 
-    "​params":​ { 
-        "​output":​ "​extend",​ 
-        "​selectMappings":​ "​extend",​ 
-        "​valuemapids":​ ["​4"​] 
-    }, 
-    "​auth":​ "​57562fd409b3b3b9a4d916d45207bbcb",​ 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-Response: 
-<code js> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​result":​ [ 
-        { 
-            "​valuemapid":​ "​4",​ 
-            "​name":​ "APC Battery Replacement Status",​ 
-            "​mappings":​ [ 
-                { 
-                    "​value":​ "​1",​ 
-                    "​newvalue":​ "​unknown"​ 
-                }, 
-                { 
-                    "​value":​ "​2",​ 
-                    "​newvalue":​ "​notInstalled"​ 
-                }, 
-                { 
-                    "​value":​ "​3",​ 
-                    "​newvalue":​ "​ok"​ 
-                }, 
-                { 
-                    "​value":​ "​4",​ 
-                    "​newvalue":​ "​failed"​ 
-                }, 
-                { 
-                    "​value":​ "​5",​ 
-                    "​newvalue":​ "​highTemperature"​ 
-                }, 
-                { 
-                    "​value":​ "​6",​ 
-                    "​newvalue":​ "​replaceImmediately"​ 
-                }, 
-                { 
-                    "​value":​ "​7",​ 
-                    "​newvalue":​ "​lowCapacity"​ 
-                } 
-            ] 
-        } 
-    ], 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-==== Source ==== 
- 
-CValueMap::​get() in //​frontends/​php/​include/​classes/​api/​services/​CValueMap.php//​.