iconmap.get

Opis

integer/array iconmap.get(object parameters)

Metoda pozwala na pobranie map ikon zgodnie z podanymi parametrami.

Metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania metody można wyłączyć w ustawieniach ról użytkowników. Zobacz Role użytkowników po więcej informacji.

Parametry

(object) Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
iconmapids string/array Zwraca tylko mapy ikon o podanych identyfikatorach.
sysmapids string/array Zwraca tylko mapy ikon używane w podanych mapach.
selectMappings query Zwraca właściwość mappings z wykorzystanymi mapowaniami ikon.
sortfield string/array Sortuje wynik według podanych właściwości. Możliwe wartości to: iconmapid i name.
countOutput boolean Te parametry, wspólne dla wszystkich metod get, są szczegółowo opisane w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Zwracane wartości

(integer/array) Zwraca jedną z opcji:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli parametr countOutput został wykorzystany.

Przykłady

Pobieranie mapy ikon

Pobierz wszystkie dane dotyczące mapy ikon "3".

Zapytanie:

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

Odpowiedź:

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

Zobacz także

Źródło

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