Sidebar

zh:manual:api:reference:valuemap:get

获取

说明

integer/array valuemap.get(object parameters)

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

参数

(object) 定义所需输出的参数。

该方法支持以下参数。

属性 类型 说明
valuemapids string/array 只返回具有给定ID的值映射。
selectMappings query 在“映射”属性中返回当前值映射的值映射。
sortfield string/array 按照给定的属性对结果进行排序。

可能的值为:valuemapidname
countOutput flag这些参数对于所有的“get”方法是常见的,在参考说明中有详细描述.
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) 返回:

  • 一个数组;
  • 如果使用了countOutput参数,则检索到的对象的计数。

示例

检索值映射

检索所有配置的值映射。

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
}

检索一个值映射及其映射。

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.