iconmap.get

Descripció

integer/array iconmap.get(object parameters)

El mètode permet recuperar mapes d'icones els paràmetres proveïts.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres que defineixen la sortida esperada.

el mètode admet els paràmetres següents.

Paràmetre Tipus Descripció
iconmapids string/array Torna només els mapes d'icones amb els identificadors donats.
sysmapids string/array Torna només els mapes d'icones emprats als mapes donats.
selectMappings query Torna una propietat mappings amb els mapes d'icones emprats.
sortfield string/array Ordena el resultat segons les propietats de les dades.

Els valors admesos són: iconmapid i name.
countOutput boolean Aquests paràmetres es descriuen als comentaris de referència.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valors de retorn

(integer/array) Retorna un d'entre:

  • una taula d'objectes;
  • el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar un mapa d'icones

Recupera tota la informació del mapa d'icones "3".

Petició:

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

Resposta:

{
    "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
}

Veieu també

Font

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