Documentation
Table of Contents
valuemap.get
Описание
целое число/массив valuemap.get(объект параметры)
Этот метод позволяет получать преобразования значений и глобальные макросы в соответствии с заданными параметрами.
Параметры
(объект) Параметры задают желаемый вывод.
Этот метод поддерживает следующие параметры.
| Параметр | Тип | Описание |
|---|---|---|
| valuemapids | строка/массив | Возврат преобразований значений только с заданными ID. |
| selectMappings | запрос | Возврат соответствий значения для текущего преобразования значений в свойстве mappings.Поддерживается count. |
| sortfield | строка/массив | Сортировка результата в соответствии с заданными свойствами. Возможные значения: valuemapid, name. |
| countOutput | логический | Эти параметры являются общими для всех методов get и они описаны в справочных комментариях. |
| editable | логический | |
| excludeSearch | логический | |
| filter | объект | |
| limit | целое число | |
| output | запрос | |
| preservekeys | логический | |
| search | объект | |
| searchByAny | логический | |
| searchWildcardsEnabled | логический | |
| sortorder | строка/массив | |
| startSearch | логический |
Возвращаемые значения
(целое число/массив) Возвращает либо:
- массив объектов;
- количество найденных объектов, если используется параметр
countOutput.
Примеры
Получение преобразований значений
Получение всех добавленных преобразований значений.
Запрос:
{
"jsonrpc": "2.0",
"method": "valuemap.get",
"params": {
"output": "extend"
},
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}Ответ:
{
"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
}Получение одного преобразования значений с его соответствиями значений.
Запрос:
{
"jsonrpc": "2.0",
"method": "valuemap.get",
"params": {
"output": "extend",
"selectMappings": "extend",
"valuemapids": ["4"]
},
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}Ответ:
{
"jsonrpc": "2.0",
"result": [
{
"valuemapid": "4",
"name": "APC Battery Replacement Status",
"mappings": [
{
"value": "1",
"newvalue": "unknown"
},
{
"value": "2",
"newvalue": "notInstalled"
},
{
"value": "3",
"newvalue": "ok"
},
{
"value": "4",
"newvalue": "failed"
},
{
"value": "5",
"newvalue": "highTemperature"
},
{
"value": "6",
"newvalue": "replaceImmediately"
},
{
"value": "7",
"newvalue": "lowCapacity"
}
]
}
],
"id": 1
}Исходный код
CValueMap::get() в frontends/php/include/classes/api/services/CValueMap.php.