[comment]: # translation:outdated

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

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

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

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

Cette méthode permet de récupérer des mappages d’icônes selon les paramètres donnés.

::: noteclassic
Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir [User
roles](/manual/web_interface/frontend_sections/users/user_roles)
pour plus d’informations.
:::

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

[comment]: # ({06564ccd-efcde208})
### Paramètres

`(object)` Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

|Paramètre|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|iconmapids|ID/array|Retourner uniquement les plans d’icônes avec les ID indiqués.|
|sysmapids|ID/array|Retourner uniquement les plans d’icônes utilisés dans les cartes indiquées.|
|selectMappings|query|Retourner une propriété [`mappings`](/manual/api/reference/iconmap/object#icon-mapping) avec les correspondances d’icônes utilisées.|
|sortfield|string/array|Trier le résultat selon les propriétés indiquées.<br><br>Valeurs possibles : `iconmapid`, `name`.|
|countOutput|boolean|Ces paramètres sont décrits dans le [commentaire de référence](/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})
### Valeurs retournées

`(integer/array)` Retourne soit :

-   un tableau d'objets ;
-   le nombre d'objets récupérés, si le paramètre `countOutput` a été utilisé.

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

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

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

[comment]: # ({a464c76b-016ff9fc})
#### Récupérer une carte d’icônes

Récupérez toutes les données de la carte d’icônes « 3 ».

[Requête](/manual/api#performing-requests):

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

Réponse :

```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})
### Voir aussi

-   [Mappage des icônes](object#icon-mapping)

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

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

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

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