[comment]: # translation:outdated

[comment]: # ({8e76cf8c-8e76cf8c})
# iconmap.get

[comment]: # ({/8e76cf8c-8e76cf8c})

[comment]: # ({5d666bfe-04265e54})
### Descrição

`integer/array iconmap.get(object parameters)`

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

::: noteclassic
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](/manual/web_interface/frontend_sections/administration/user_roles)
Para maiores informações.
:::

[comment]: # ({/5d666bfe-04265e54})

[comment]: # ({e520ee19-efcde208})
### Parâmetros

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

O método oferece suporte aos parâmetros a seguir.

|Parâmetro|[Tipo](/manual/api/reference_commentary#data_types)|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](/manual/api/reference/iconmap/object#icon_mapping) com os mapeamentos de ícone usados.|
|sortfield|string/array|Ordenar o resultado pelas propriedades fornecidas.<br><br>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](/manual/api/reference_commentary#common_get_method_parameters).|
|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|^|

[comment]: # ({/e520ee19-efcde208})

[comment]: # ({7223bab1-7223bab1})
### Valores de retorno

`(integer/array)` Retorna:

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

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Exemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({54ee46ed-016ff9fc})
#### Recuperar um mapa de ícones

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

Solicitação:

``` {.java}
{
    "jsonrpc": "2.0",
    "método": "iconmap.get",
    "parâmetros": {
        "iconmapids": "3",
        "saída": "estender",
        "selectMappings": "estender"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Resposta:

``` {.java}
{
    "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
}
```

[comment]: # ({/54ee46ed-016ff9fc})

[comment]: # ({8df05cf6-8df05cf6})
### Veja também

- [Mapeamento de ícones](object#icon_mapping)

[comment]: # ({/8df05cf6-8df05cf6})

[comment]: # ({2420d0f0-2420d0f0})
### Fonte

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

[comment]: # ({/2420d0f0-2420d0f0})