Documentation
Table of Contents
valuemap.get
Descripció
integer/array valuemap.get(object parameters)
El mètode permet recuperar mapes de valors segons els paràmetres proveïts.
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.
Paràmetres
(object) Paràmetres definint la sortida esperada.
Aquest mètode admet els paràmetres següents.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| valuemapids | ID/array | Retorna només taules de mapes de valors amb els identificadors donats. |
| selectMappings | query | Retorna les coincidències de valors actuals a la propietat mappings.Admet count. |
| sortfield | string/array | Ordena el resultat segons les propietats donades. Els valors possibles són: valuemapid, name. |
| countOutput | boolean | Aquests paràmetres es descriuen als comentaris 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 |
Valors de retorn
(integer/array) Retorna un d'entre:
- una taula d'objectes;
- el recompte d'objectes recuperats, si s'empra el paràmetre
countOutput.
Exemples
Recuperar mapes de valors
Recupera tots els mapes de valors configurats.
Resposta:
{ "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 valors amb els seus mapatges.
{ "jsonrpc": "2.0", "method": "valuemap.get", "params": { "output": "extend", "selectMappings": "extend", "valuemapids": ["4"] }, "id": 1 }Resposta:
{ "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 }Font
CValueMap::get() in ui/include/classes/api/services/CValueMap.php.