Nesta página
iconmap.get
Descrição
integer/array iconmap.get(object parameters)
O método permite recuperar mapas de ícones de acordo com o dado parâmetros.
Este método está disponível para usuários de qualquer tipo. Permissões para chamar o método pode ser revogado nas configurações de função do usuário. Veja Usuário funções Para maiores informações.
Parâmetros
(object) Parâmetros que definem a saída desejada.
O método oferece suporte aos parâmetros a seguir.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| iconmapids | string/array | Retorna apenas mapas de ícones com os IDs fornecidos. |
| sysmapids | string/array | Retorna apenas mapas de ícones que são usados nos mapas fornecidos. |
| selectMappings | query | Retorne uma propriedade mappings com os mapeamentos de ícone usados. |
| sortfield | string/array | Ordenar o resultado pelas propriedades fornecidas. Os valores possíveis são: iconmapid e name. |
| countOutput | boolean | Estes parâmetros sendo comuns para todos os métodos get são descritos em detalhes no comentário de referência. |
| editável | booleano | |
| excludePesquisa | boolean | |
| filtro | objeto | |
| limite | inteiro | |
| saída | consulta | |
| preservekeys | boolean | |
| pesquisar | objeto | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| ordem de classificação | cadeia/matriz | |
| startSearch | boolean |
Valores de retorno
(integer/array) Retorna:
- uma matriz de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputtiver sido usado.
Exemplos
Recuperar um mapa de ícones
Recupere todos os dados sobre o mapa de ícones "3".
Solicitação:
{
"jsonrpc": "2.0",
"método": "iconmap.get",
"parâmetros": {
"iconmapids": "3",
"saída": "estender",
"selectMappings": "estender"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
Resposta:
{
"jsonrpc": "2.0",
"resultado": [
{
"mapeamentos": [
{
"iconmappingid": "3",
"iconmapid": "3",
"iconid": "6",
"link_inventário": "1",
"expressão": "servidor",
"ordem de classificação": "0"
},
{
"iconmappingid": "4",
"iconmapid": "3",
"iconid": "10",
"link_inventário": "1",
"expressão": "interruptor",
"ordem de classificação": "1"
}
],
"iconmapid": "3",
"name": "Ícones de tipo de host",
"default_iconid": "2"
}
],
"id": 1
}
Veja também
Fonte
CIconMap::get() em ui/include/classes/api/services/CIconMap.php.