iconmap.get

Descrizione

integer/array iconmap.get(object parameters)

Il metodo consente di recuperare le mappe delle icone in base ai parametri specificati.

Questo metodo è disponibile per utenti di qualsiasi tipo. Le autorizzazioni per chiamare il metodo possono essere revocate nelle impostazioni dei ruoli utente. Vedere Ruoli utente per ulteriori informazioni.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parametro Tipo Descrizione
iconmapids ID/array Restituisce solo le mappe di icone con gli ID specificati.
sysmapids ID/array Restituisce solo le mappe di icone utilizzate nelle mappe specificate.
selectMappings query Restituisce una proprietà mappings con le associazioni di icone utilizzate.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: iconmapid, name.
countOutput boolean Questi parametri sono descritti nel commento di riferimento.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valori restituiti

(integer/array) Restituisce o:

  • una matrice di oggetti;
  • il conteggio degli oggetti recuperati, se il parametro countOutput è stato usato.

Esempi

Recuperare una mappa di icone

Recupera tutti i dati della mappa di icone "3".

Richiesta:

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

Risposta:

{
    "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": "Icone del tipo di host",
            "default_iconid": "2"
        }
    ],
    "id": 1
}

Vedi anche

Fonte

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