valuemap.get
描述
integer/array valuemap.get(object parameters)
该方法允许根据给定参数检索值映射。
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅User roles。
参数
(object) 定义输出结果的参数。
该方法支持以下参数。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| valuemapids | string/array | 仅返回指定ID的值映射。 |
| selectMappings | query | 在值映射属性中返回当前值映射的映射关系。 支持 count。 |
| sortfield | string/array | 按指定属性排序结果。 可选值为： valuemapid、name。 |
| countOutput | boolean | 这些参数在通用get方法参数中有详细说明。 |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
返回值
(integer/array) 返回以下两种结果之一：
- 一个包含objects的array；
- 若使用了
countOutput参数，则返回检索到的objects数量。
示例
获取值映射
获取所有已配置的值映射。
请求：
{
"jsonrpc": "2.0",
"method": "valuemap.get",
"params": {
"output": "extend"
},
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}响应：
{
"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
}获取单个值映射及其映射关系。
请求：
{
"jsonrpc": "2.0",
"method": "valuemap.get",
"params": {
"output": "extend",
"selectMappings": "extend",
"valuemapids": ["4"]
},
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}响应：
{
"jsonrpc": "2.0",
"result": [
{
"valuemapid": "4",
"name": "APC Battery Replacement Status",
"mappings": [
{
"type": "0",
"value": "1",
"newvalue": "unknown"
},
{
"type": "0",
"value": "2",
"newvalue": "notInstalled"
},
{
"type": "0",
"value": "3",
"newvalue": "ok"
},
{
"type": "0",
"value": "4",
"newvalue": "failed"
},
{
"type": "0",
"value": "5",
"newvalue": "highTemperature"
},
{
"type": "0",
"value": "6",
"newvalue": "replaceImmediately"
},
{
"type": "0",
"value": "7",
"newvalue": "lowCapacity"
}
]
}
],
"id": 1
}来源
CValueMap::get() 位于 ui/include/classes/api/services/CValueMap.php 文件中。