Documentation
Table of Contents
iconmap.get
Beschrijving
integer/array iconmap.get(object parameters)
Deze methode maakt het mogelijk om icoonkaarten op te halen op basis van de opgegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Toestemmingen om de methode te gebruiken kunnen worden ingetrokken in de gebruikersrolinstellingen. Zie Gebruikersrollen voor meer informatie.
Parameters
(object) Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
| Parameter | Type | Beschrijving |
|---|---|---|
| iconmapids | string/array | Alleen icoonkaarten met de opgegeven IDs retourneren. |
| sysmapids | string/array | Alleen icoonkaarten retourneren die worden gebruikt in de opgegeven kaarten. |
| selectMappings | query | Een mappings eigenschap retourneren met de gebruikte icoonafbeeldingen. |
| sortfield | string/array | De resultaten sorteren op basis van de opgegeven eigenschappen. Mogelijke waarden: iconmapid, name. |
| countOutput | boolean | Deze parameters, die gemeenschappelijk zijn voor alle get-methoden, worden in detail beschreven in het referentiecommentaar. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de
countOutputparameter heeft gebruikt.
Voorbeelden
Icoonkaart ophalen
Alle gegevens over icoonkaart "3" ophalen.
{
"jsonrpc": "2.0",
"method": "iconmap.get",
"params": {
"iconmapids": "3",
"output": "extend",
"selectMappings": "extend"
},
"id": 1
}Reactie:
{
"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
}Zie ook
Bron
CIconMap::get() in ui/include/classes/api/services/CIconMap.php.