[comment]: # translation:outdated

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

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

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

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

La méthode permet de récupérer les correspondances de valeurs selon les paramètres donnés.

::: noteclassic
Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres des rôles utilisateur. Voir [User
roles](/manual/web_interface/frontend_sections/users/user_roles)
pour plus d’informations.
:::

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

[comment]: # ({a3b9345d-84c56f34})
### Paramètres

`(object)` Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

|Paramètre|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|valuemapids|ID/array|Retourner uniquement les correspondances de valeurs avec les ID donnés.|
|selectMappings|query|Retourner les correspondances de valeurs pour la correspondance de valeurs actuelle dans la propriété [`mappings`](/manual/api/reference/valuemap/object#value-mappings).<br><br>Prend en charge `count`.|
|sortfield|string/array|Trier le résultat selon les propriétés données.<br><br>Valeurs possibles : `valuemapid`, `name`.|
|countOutput|boolean|Ces paramètres sont décrits dans le [commentaire de référence](/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})
### Valeurs retournées

`(integer/array)` Retourne soit :

-   un tableau d'objets ;
-   le nombre d'objets récupérés, si le paramètre `countOutput` a été utilisé.

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

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

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

[comment]: # ({7f0a282d-864692f6})
#### Récupération des correspondances de valeurs

Récupérez toutes les correspondances de valeurs configurées.

[Requête](/manual/api#performing-requests):

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

Réponse :

```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
}
```

Récupérez une correspondance de valeurs avec ses mappages.

[Requête](/manual/api#performing-requests):

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

Réponse :

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

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

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