iconmap.get

Description

integer/array iconmap.get(object parameters)

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

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations permettant d’appeler cette méthode peuvent être révoquées dans les paramètres des rôles utilisateur. Consultez la page 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 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 avec les correspondances d’icônes utilisées.
sortfield string/array Trier le résultat selon les propriétés indiquées.

Valeurs possibles : iconmapid, name.
countOutput boolean Ces paramètres sont décrits dans le commentaire 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 countOutput a été utilisé.

Exemples

Récupérer une carte d’icônes

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

Requête:

{
    "jsonrpc": "2.0",
    "method": "iconmap.get",
    "params": {
        "iconmapids": "3",
        "output": "extend",
        "selectMappings": "extend"
    },
    "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 aussi

Source

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