[comment]: # ({8e76cf8c-8e76cf8c})
# iconmap.get

[comment]: # ({/8e76cf8c-8e76cf8c})

[comment]: # ({587ef10e-04265e54})
### 描述

`integer/array iconmap.get(object parameters)`

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

::: noteclassic
此方法适用于任何类型的用户。可以在用户角色设置中撤销调用该方法的权限。更多信息请参见 [User
roles](/manual/web_interface/frontend_sections/users/user_roles)。
:::

[comment]: # ({/587ef10e-04265e54})

[comment]: # ({06564ccd-efcde208})
### 参数

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

该方法支持以下参数。

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|iconmapids|ID/array|仅返回具有给定 ID 的 icon map。|
|sysmapids|ID/array|仅返回在给定地图中使用的 icon map。|
|selectMappings|query|返回一个包含所用 icon 映射的 [`mappings`](/manual/api/reference/iconmap/object#icon-mapping) 属性。|
|sortfield|string/array|按给定属性对结果排序。<br><br>可能的值：`iconmapid`、`name`。|
|countOutput|boolean|这些参数在[参考说明](/manual/api/reference_commentary#common-get-method-parameters)中有描述。|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/06564ccd-efcde208})

[comment]: # ({7223bab1-7223bab1})
### 返回值

`(integer/array)` 返回以下之一：

-   array 的 objects；
-   如果使用了 `countOutput` 参数，则为检索到的 objects 的数量。

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### 示例

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({a464c76b-016ff9fc})
#### 获取图标映射

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

[执行请求](/manual/api#执行请求):


```json
{
    "jsonrpc": "2.0",
    "method": "iconmap.get",
    "params": {
        "iconmapids": "3",
        "output": "extend",
        "selectMappings": "extend"
    },
    "id": 1
}
```
响应：


```json
{
    "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
}
```

[comment]: # ({/a464c76b-016ff9fc})

[comment]: # ({ab16f1c6-8df05cf6})
### 另请参见

-   [图标映射](object#icon-mapping)

[comment]: # ({/ab16f1c6-8df05cf6})

[comment]: # ({2420d0f0-2420d0f0})
### 来源

CIconMap::get() 在 *ui/include/classes/api/services/CIconMap.php* 中。

[comment]: # ({/2420d0f0-2420d0f0})