iconmap.get

Descrição

integer/array iconmap.get(object parameters)

O método permite recuperar mapas de ícones de acordo com os parâmetros fornecidos.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

Parâmetro	Tipo	Descrição
iconmapids	ID/array	Retorna apenas mapas de ícones com os IDs fornecidos.
sysmapids	ID/array	Retorna apenas mapas de ícones que são usados nos mapas fornecidos.
selectMappings	query	Retorna uma propriedade `mappings` com os mapeamentos de ícones usados.
sortfield	string/array	Ordena o resultado pelas propriedades fornecidas. Valores possíveis: `iconmapid`, `name`.
countOutput	boolean	Esses parâmetros são descritos no comentário de referência.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valores de retorno

(integer/array) Retorna:

uma matriz de objetos;
a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperar um mapa de ícones

Recupere todos os dados sobre o mapa de ícones "3".

Requisição:

{  "jsonrpc": "2.0",  "method": "iconmap.get",  "params": {  "iconmapids": "3",  "output": "extend",  "selectMappings": "extend"  },  "id": 1 }

Resposta:

{  "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 }

Veja também

Mapeamento de ícones

Fonte

CIconMap::get() em ui/include/classes/api/services/CIconMap.php.

Documentation