Documentation
Table of Contents
valuemap.get
Leírás
integer/array valuemap.get(objektumparaméterek)
A módszer lehetővé teszi az értéktérképek lekérését a megadottak szerint paramétereket.
Ez a módszer bármilyen típusú felhasználó számára elérhető. Engedélyek A metódus meghívása a felhasználói szerepkör beállításaiban visszavonható. Lásd: User roles további információért.
Paraméterek
(object) A kívánt kimenetet meghatározó paraméterek.
A módszer a következő paramétereket támogatja.
| Paraméter | Típus | Leírás |
|---|---|---|
| valuemapids | string/array | Csak a megadott azonosítókkal rendelkező értékleképezéseket adja vissza. |
| selectMappings | query | Az aktuális értékleképezés értékleképezését adja vissza a mappings tulajdonságban. Támogatja a count. |
| sortfield | string/array | Rendezd az eredményt a megadott tulajdonságok szerint. A lehetséges értékek: valuemapid, name. |
| countOutput | boolean | Ezek a paraméterek, amelyek minden get metódusnál közösek, a referenciakommentár részben találhatók. |
| szerkeszthető | logikai | |
| excludeSearch | logikai | |
| szűrő | objektum | |
| korlát | egész szám | |
| kimenet | lekérdezés | |
| preservekeys | boolean | |
| kereső | objektum | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | karakterlánc/tömb | |
| startSearch | boolean |
Visszatérési értékek
(integer/array) A következőket adja vissza:
- objektumok tömbje;
- a letöltött objektumok száma, ha a
countOutputparamétert használták.
Példák
Retrieving value maps
Retrieve all configured value maps.
Request:
{
"jsonrpc": "2.0",
"method": "valuemap.get",
"params": {
"output": "extend"
},
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}Response:
{
"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
}Retrieve one value map with its mappings.
Request:
{
"jsonrpc": "2.0",
"method": "valuemap.get",
"params": {
"output": "extend",
"selectMappings": "extend",
"valuemapids": ["4"]
},
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}Response:
{
"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
}Forrás
CValueMap::get() az ui/include/classes/api/services/CValueMap.php-ban.