[comment]: # ({8e685c26-8e685c26})
# valuemap.get

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

[comment]: # ({e1899382-3833805e})
### Descrição

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

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

::: noteclassic
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](/manual/web_interface/frontend_sections/users/user_roles) para mais informações.
:::

[comment]: # ({/e1899382-3833805e})

[comment]: # ({a3b9345d-84c56f34})
### Parâmetros

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

O método suporta os seguintes parâmetros.

|Parâmetro|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|valuemapids|ID/array|Retorna apenas mapas de valores com os IDs fornecidos.|
|selectMappings|query|Retorna os mapeamentos de valores para o mapa de valores atual na propriedade [`mappings`](/manual/api/reference/valuemap/object#value-mappings).<br><br>Suporta `count`.|
|sortfield|string/array|Ordena o resultado pelas propriedades fornecidas.<br><br>Valores possíveis: `valuemapid`, `name`.|
|countOutput|boolean|Esses parâmetros são descritos no [comentário de referência](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/a3b9345d-84c56f34})

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

`(integer/array)` Retorna:

-   um array 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]: # ({7f0a282d-864692f6})
#### Recuperando mapas de valores

Recupera todos os mapas de valores configurados.

[Requisição](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "valuemap.get",
    "params": {
        "output": "extend"
    },
    "id": 1
}
```

Resposta:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "valuemapid": "4",
            "name": "APC Battery Replacement Status"
        },
        {
            "valuemapid": "5",
            "name": "APC Battery Status"
        },
        {
            "valuemapid": "7",
            "name": "Dell Open Manage System Status"
        }
    ],
    "id": 1
}
```

Recupera um mapa de valores com seus mapeamentos.

[Requisição](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "valuemap.get",
    "params": {
        "output": "extend",
        "selectMappings": "extend",
        "valuemapids": ["4"]
    },
    "id": 1
}
```

Resposta:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "valuemapid": "4",
            "name": "APC Battery Replacement Status",
            "mappings": [
                {
                    "type": "0",
                    "value": "1",
                    "newvalue": "unknown"
                },
                {
                    "type": "0",
                    "value": "2",
                    "newvalue": "notInstalled"
                },
                {
                    "type": "0",
                    "value": "3",
                    "newvalue": "ok"
                },
                {
                    "type": "0",
                    "value": "4",
                    "newvalue": "failed"
                },
                {
                    "type": "0",
                    "value": "5",
                    "newvalue": "highTemperature"
                },
                {
                    "type": "0",
                    "value": "6",
                    "newvalue": "replaceImmediately"
                },
                {
                    "type": "0",
                    "value": "7",
                    "newvalue": "lowCapacity"
                }
            ]
        }
    ],
    "id": 1
}
```

[comment]: # ({/7f0a282d-864692f6})

[comment]: # ({fb99bef1-fb99bef1})
### Fonte

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

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