Documentation
Table of Contents
mapadeicono.obtener
Descripción
integer/array iconmap.get(object parameters)
El método permite recuperar las acciones de acuerdo a los parámetros aportados.
Este método está disponible para los usuarios de cualquier tipo. Los permisos para activar el método pueden ser revocados en los ajustes de rol de usuario. Ver User roles para más información.
Parámetros
(object) 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 IDs proporcionados. |
| sysmapids | cadena/matriz | Devuelve sólo mapas de iconos que se utilizan en los mapas dados. |
| selectMappings | consulta | Devuelve una propiedad mappings con los mapeos de iconos utilizados. |
| sortfield | cadena/matriz | Ordena el resultado según las propiedades dadas. Los valores posibles son: iconmapid y name. |
| countOutput | booleano | Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en el reference commentary. |
| editable | booleano | |
| excluirBuscar | booleano | |
| filtro | objeto | |
| límite | número entero | |
| salida | consulta | |
| preservekeys | booleano | |
| buscar | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| clasificación | cadena/matriz | |
| iniciarBuscar | booleano |
Valores de retorno
(integer/array) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro
countOutputha sido usado.
Ejemplos
Recuperar una mapa de iconos
Recupere todos los datos sobre el mapa de iconos "3".
Solicitud:
{
"jsonrpc": "2.0",
"method": "iconmap.get",
"params": {
"iconmapids": "3",
"output": "extend",
"selectMappings": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"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
}Ver también
Fuente
CIconMap::get() en ui/include/classes/api/services/CIconMap.php.