iconmap.get

Beschreibung

integer/array iconmap.get(object parameters)

Mit dieser Methode können Sie Symbolzuordnungen entsprechend den angegebenen Parametern abrufen.

Diese Methode steht Benutzern jeden Typs zur Verfügung. Die Berechtigung zum Aufrufen der Methode kann in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
iconmapids ID/array Gibt nur Symbolzuordnungen mit den angegebenen IDs zurück.
sysmapids ID/array Gibt nur Symbolzuordnungen zurück, die in den angegebenen Karten verwendet werden.
selectMappings query Gibt eine Eigenschaft mappings mit den verwendeten Symbolzuordnungen zurück.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: iconmapid, name.
countOutput boolean Diese Parameter sind in der Referenzkommentierung beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Kann die folgenden Dinge zurück geben:

  • ein Array von Objekten;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Eine Symbolzuordnung abrufen

Rufen Sie alle Daten zur Symbolzuordnung „3“ ab.

Anfrage:

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

Antwort:

{
    "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-Typ-Symbole",
            "default_iconid": "2"
        }
    ],
    "id": 1
}

Siehe auch

Quelle

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