Documentation
Table of Contents
valuemap.get
Opis
integer/array valuemap.get(object parameters)
Metoda pozwala na pobranie map wartości według zadanych parametrów.
Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania metody można odwołać w ustawieniach roli użytkownika. Zobacz Role użytkownika po więcej informacji.
Parametry
(object) Parametry określające pożądane wyjście.
Metoda obsługuje następujące parametry.
| Parametr | Typ | Opis |
|---|---|---|
| valuemapids | string/array | Zwraca tylko mapy wartości z podanymi identyfikatorami. |
| selectMappings | query | Zwraca mapowania wartości dla bieżącej mapy wartości we właściwości mappings. Obsługuje count. |
| sortfield | string/array | Sortuj wynik według podanych właściwości. Możliwe wartości to: valuemapid, name. |
| countOutput | boolean | Parametry te są wspólne dla wszystkich metod get i są szczegółowo opisane w komentarz referencyjny. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Zwracane wartości
(integer/array) Zwraca jedną z opcji:
- tablicę obiektów;
- liczbę pobranych obiektów, jeśli parametr
countOutputzostał wykorzystany.
Przykłady
Pobieranie map wartości
Pobierz wszystkie skonfigurowane mapy wartości.
Żądanie:
{ "jsonrpc": "2.0", "method": "valuemap.get", "params": { "output": "extend" }, "auth": "57562fd409b3b3b9a4d916d45207bbcb", "id": 1 }Odpowiedź:
{ "jsonrpc": "2.0", "result": [ { "valuemapid": "4", "name": "Stan wymiany baterii APC" }, { "valuemapid": "5", "name": "Stan baterii APC Battery" }, { "valuemapid": "7", "name": "Status systemu Dell Open Manage" } ], "id": 1 }Pobierz jedną mapę wartości z jej mapowaniami.
Żądanie:
{ "jsonrpc": "2.0", "method": "valuemap.get", "params": { "output": "extend", "selectMappings": "extend", "valuemapids": ["4"] }, "auth": "57562fd409b3b3b9a4d916d45207bbcb", "id": 1 }Odpowiedź:
{ "jsonrpc": "2.0", "result": [ { "valuemapid": "4", "name": "Status wymiany baterii APC", "mappings": [ { "type": "0", "value": "1", "newvalue": "nieznany" }, { "type": "0", "value": "2", "newvalue": "niezainstalowany" }, { "type": "0", "value": "3", "newvalue": "ok" }, { "type": "0", "value": "4", "newvalue": "niepowodzenie" }, { "type": "0", "value": "5", "newvalue": "wysokaTemperatura" }, { "type": "0", "value": "6", "newvalue": "wymieńNatychmiast" }, { "type": "0", "value": "7", "newvalue": "niskaPojemność" } ] } ], "id": 1 }Źródło
CValueMap::get() in ui/include/classes/api/services/CValueMap.php.