valuemap.get

描述

integer/array valuemap.get(object parameters)

该方法允许根据给定的参数检索值映射。

此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参见 User roles。

参数

(object) 用于定义期望输出的参数。

该方法支持以下参数。

参数 数据类型 描述
valuemapids ID/array 仅返回具有指定ID的值映射。
selectMappings query 在 [mappings](/manual/api/reference/valuemap/object#value_mappings) 属性中返回当前值映射的值映射。

支持 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"
    },
    "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"]
    },
    "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 中。