integer/array iconmap.get(object parameters)
El método permite recuperar mapas de iconos según los parámetros dados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Ver Roles de usuario para más información.
(objeto)
Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
Parámetro | Tipo | Descripción |
---|---|---|
iconmapids | cadena/matriz | Devuelve solo mapas de iconos con los ID proporcionados. |
sysmapids | cadena/matriz | Devuelve sólo mapas de iconos que se utilizan en los mapas dados. |
selectMappings | query | Devuelve una propiedad mappings con las asignaciones de iconos utilizadas. |
sortfield | cadena/matriz | Ordena el resultado según las propiedades dadas. Valores posibles: iconmapid , name . |
countOutput | booleano | Estos parámetros, que son comunes para todos los métodos get , se describen en detalle en el comentario de referencia. |
editable | booleano | |
excludeSearch | booleano | |
filter | objeto | |
limit | entero | |
output | consulta | |
preservekeys | booleano | |
search | objeto | |
searchByAny | booleano | |
searchWildcardsEnabled | booleano | |
sortorder | cadena/matriz | |
startSearch | booleano |
(entero/matriz)
Devuelve:
countOutput
ha sido usado.Recupera todos los datos sobre el mapa de iconos "3".
{
"jsonrpc": "2.0",
"method": "iconmap.get",
"params": {
"iconmapids": "3",
"output": "extend",
"selectMappings": "extend"
},
"id": 1
}
Respuesta:
{
"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
}
CIconMap::get() en ui/include/classes/api/services/CIconMap.php.