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

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

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

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

このメソッドは、指定された
パラメータに従ってアイコンマップを取得できます。

::: noteclassic
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーロールの設定で取り消すことができます。詳細は、[ユーザーロール](/manual/web_interface/frontend_sections/users/user_roles)
を参照してください。
:::

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

[comment]: # ({06564ccd-efcde208})
### パラメータ

`(object)` 必要な出力を定義するパラメータ。

このメソッドは以下のパラメータをサポートしています。

|パラメータ|[Type](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|iconmapids|ID/array|指定したIDのアイコンマップのみを返します。|
|sysmapids|ID/array|指定したマップで使用されているアイコンマップのみを返します。|
|selectMappings|query|使用されているアイコンマッピングを含む [`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)` 次のいずれかを返します:

-   オブジェクトの配列
-   `countOutput`パラメータが使用されている場合、取得されたオブジェクトの数

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

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

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

[comment]: # ({a464c76b-016ff9fc})
#### アイコンマップの取得

アイコンマップ「3」に関するすべてのデータを取得します。

[リクエスト](/manual/api#performing-requests):

```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": "ホストタイプのアイコン",
            "default_iconid": "2"
        }
    ],
    "id": 1
}
```

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

[comment]: # ({ab16f1c6-8df05cf6})
### 関連項目

-   [アイコンマッピング](object#icon-mapping)

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

[comment]: # ({2420d0f0-2420d0f0})
### ソース

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

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