iconmap.get

Leírás

integer/array iconmap.get(objektumparaméterek)

A módszer lehetővé teszi az ikontérképek lekérését a megadottak szerint paramétereket.

Ez a módszer bármilyen típusú felhasználó számára elérhető. Engedélyek A metódus meghívása a felhasználói szerepkör beállításaiban visszavonható. Lásd: User roles további információért.

Paraméterek

(object) A kívánt kimenetet meghatározó paraméterek.

A módszer a következő paramétereket támogatja.

Paraméter	Típus	Leírás
iconmapids	string/array	Csak a megadott azonosítókkal rendelkező ikontérképeket adja vissza.
sysmapids	string/array	Csak az adott térképekben használt ikontérképeket adja vissza.
selectMappings	query	Vissza vissza a mappings tulajdonságot a használt ikonleképezésekkel.
sortfield	string/array	Rendezd az eredményt a megadott tulajdonságok szerint. A lehetséges értékek: `iconmapid` és `name`.
countOutput	boolean	Ezek a paraméterek, amelyek minden `get` metódusnál közösek, a referenciakommentár részben találhatók.
szerkeszthető	logikai
excludeSearch	logikai
szűrő	objektum
korlát	egész szám
kimenet	lekérdezés
preservekeys	boolean
kereső	objektum
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	karakterlánc/tömb
startSearch	boolean

Visszatérési értékek

(integer/array) A következőket adja vissza:

objektumok tömbje;
a letöltött objektumok száma, ha a countOutput paraméter rendelkezik használtak.

Példák

Retrieve an icon map

Retrieve all data about icon map "3".

Request:

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

Response:

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

Lásd még

Ikonleképezés

Forrás

CIconMap::get() az ui/include/classes/api/services/CIconMap.php-ban.

Documentation