Documentation
Table of Contents
iconmap.get
Description
integer/array iconmap.get(object parameters)
La méthode permet de récupérer des tables de correspondance d'icônes en fonction des paramètres donnés.
Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir Rôles Utilisateur pour plus d'informations.
Paramètres
(object) Paramètres définissant la sortie souhaitée.
La méthode prend en charge les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| iconmapids | string/array | Renvoie uniquement les correspondances d'icônes avec les identifiants donnés. |
| sysmapids | string/array | Renvoie uniquement les correspondances d'icônes utilisées dans les cartes données. |
| selectMappings | query | Renvoie une propriété mappings contenant les mappages d'icônes utilisés. |
| sortfield | string/array | Trie le résultat par les propriétés données. Les valeurs possibles sont : iconmapid et name. |
| countOutput | boolean | Ces paramètres, communs à toutes les méthodes get, sont décrits dans les commentaires de référence. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valeurs retournées
(integer/array) Retourne soit :
- un tableau d'objets ;
- le nombre d'objets récupérés, si le paramètre
countOutputa été utilisé.
Exemples
Récupération d'une carte d'icônes
Récupérez toutes les données sur la carte d'icônes "3".
Requête :
{
"jsonrpc": "2.0",
"method": "iconmap.get",
"params": {
"iconmapids": "3",
"output": "extend",
"selectMappings": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
{
"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
}Voir également
Source
CIconMap::get() dans ui/include/classes/api/services/CIconMap.php.