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

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

[comment]: # ({e1899382-3833805e})
### Descripción

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

El método permite recuperar mapas de valores según los
parámetros dados.

::: noteclassic
Este método está disponible para usuarios de cualquier tipo. Los permisos
para llamar al método se puede revocar en la configuración de roles de usuario. Ver [Roles de
usuario](/manual/web_interface/frontend_sections/users/user_roles)
para obtener más información.
:::

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

[comment]: # ({ebae84c0-84c56f34})
### Parámetros

`(objeto)` Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

|Parámetro|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|valuemapids|cadena/matriz|Devuelve solo mapas de valores con los ID proporcionados.|
|selectMappings|consulta|Devuelve las asignaciones de valores para el mapa de valores actual en la propiedad [mappings](/manual/api/reference/valuemap/object#value_mappings).<br><br>Admite `count`.|
|sortfield|cadena/matriz|Ordena el resultado según las propiedades dadas.<br><br>Valores posibles: `valuemapid`, `name`.|
|countOutput|booleano|Estos parámetros, que son comunes para todos los métodos `get`, se describen en detalle en el [comentario de referencia](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|booleano|^|
|excludeSearch|booleano|^|
|filter|objeto|^|
|limit|entero|^|
|output|consulta|^|
|preservekeys|booleano|^|
|search|objeto|^|
|searchByAny|booleano|^|
|searchWildcardsEnabled|booleano|^|
|sortorder|cadena/matriz|^|
|startSearch|booleano|^|

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

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

`(entero/matriz)` Devuelve:

- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro `countOutput` 
    ha sido usado.

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

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

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

[comment]: # ({7f0a282d-864692f6})
#### Recuperando mapas de valores

Recupera todos los mapas de valores configurados.

[Solicitud](/manual/api#performing-requests):

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

Respuesta:

```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 un mapa de valores con sus asignaciones.

[Consulta](/manual/api#performing-requests):

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

Respuesta:

```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})
### Fuente

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

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