Table of Contents
iconmap.get
Beschrijving
integer/array iconmap.get(objectparameters)
De methode maakt het mogelijk om pictogramkaarten op te halen volgens de gegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.
Parameters
(object) Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
| Parameter | Type | Beschrijving |
|---|---|---|
| iconmapids | string/array | Retourneer alleen pictogramkaarten met de opgegeven ID's. |
| sysmapids | string/array | Retourneer alleen pictogramkaarten die in de gegeven kaarten worden gebruikt. |
| selectMappings | query | Retourneer een eigenschap mappings met de gebruikte pictogramtoewijzingen. |
| sortfield | string/array | Sorteer het resultaat op de gegeven eigenschappen. Mogelijke waarden zijn: iconmapid en name. |
| countOutput | boolean | Deze parameters gelden voor alle get-methoden en worden in detail beschreven in de referentiecommentaar. |
| editable | booleaans | |
| excludeSearch | boolean | |
| filter | object | |
| limiet | geheel getal | |
| uitvoer | query | |
| preservekeys | boolean | |
| zoeken | object | |
| searchByAny | boolean | |
| searchWildcardsIngeschakeld | boolean | |
| sortorde | string/array | |
| startZoeken | booleaans |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de
countOutputparameter heeft gebruikt.
Voorbeelden
Een pictogrammap ophalen
Haal alle gegevens op over pictogramkaart "3".
Verzoek:
{
"jsonrpc": "2.0",
"method": "iconmap.get",
"params": {
"iconmapids": "3",
"output": "extend",
"selectMappings": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"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.