Sidebar

获取

描述

integer/array iconmap.get(object parameters)

此方法允许根据给定参数来获取图标映射。

此方法仅允许超级管理员类型的用户使用。 调用此方法的权限可以在用户角色设置里撤销。更多信息请参见用户角色

参数

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

该方法支持如下参数。

参数 类型 描述
iconmapids string/array 只返回具有给定id的图标映射。
sysmapids string/array 只返回在给定映射中使用的图标映射。
selectMappings query Return a mappings property with the icon mappings used.
sortfield string/array 根据给定的属性对结果进行排序。

可选值: iconmapidname
countOutput boolean 这些参数对于所有的“get”方法都是通用的,详细描述请参见 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

返回值

(整数/数组) 返回任一:

  • 对象数组;
  • 检索到的对象的计数,如果countOutput计数输出 参数已经 被使用。

例如

检索图标映射

检索所有关于图标映射 "3"的数据。

请求:

{
           "jsonrpc": "2.0",
           "method": "iconmap.get",
           "params": {
               "iconmapids": "3",
               "output": "extend",
               "selectMappings": "extend"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "mappings": [
                       {
                           "iconmappingid": "3",
                           "iconmapid": "3",
                           "iconid": "6",
                           "inventory_link": "1",
                           "expression": "server",
                           "sortorder": "0"
                       },
                       {
                           "iconmappingid": "4",
                           "iconmapid": "3",
                           "iconid": "10",
                           "inventory_link": "1",
                           "expression": "switch",
                           "sortorder": "1"
                       }
                   ],
                   "iconmapid": "3",
                   "name": "Host type icons",
                   "default_iconid": "2"
               }
           ],
           "id": 1
       }

参见

来源

CIconMap::get() in ui/include/classes/api/services/CIconMap.php.