integer/array valuemap.get(object parameters)
The method allows to retrieve value maps according to the given 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 | flag | These parameters being common for all get methods are described in detail in the reference commentary. |
editable | boolean | |
excludeSearch | flag | |
filter | object | |
limit | integer | |
output | query | |
preservekeys | flag | |
search | object | |
searchByAny | boolean | |
searchWildcardsEnabled | boolean | |
sortorder | string/array | |
startSearch | flag |
(integer/array)
Returns either:
countOutput
parameter has been used.Retrieve all configured value maps.
Request:
{ "jsonrpc": "2.0", "method": "valuemap.get", "params": { "output": "extend" }, "auth": "57562fd409b3b3b9a4d916d45207bbcb", "id": 1 }
Response:
{ "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 }
Retrieve one value map with its mappings.
Request:
{ "jsonrpc": "2.0", "method": "valuemap.get", "params": { "output": "extend", "selectMappings": "extend", "valuemapids": ["4"] }, "auth": "57562fd409b3b3b9a4d916d45207bbcb", "id": 1 }
Response:
{ "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 }
CValueMap::get() in frontends/php/include/classes/api/services/CValueMap.php.