Documentation
Table of Contents
iconmap.get
Опис
integer/array iconmap.get(object parameters)
Метод омогућава да се дохвате мапе икона према датим параметрима.
Овај метод је доступан корисницима било које врсте. Дозволе за позивање методе могу се опозвати у подешавањима улоге корисника. Погледајте Userroles за више информација.
Параметри
(object) Параметри који дефинишу жељени излаз.
Метод подржава следеће параметре.
| Parameter | Type | Опис |
|---|---|---|
| iconmapids | ID/array | Врати само мапе икона са датим ID-ијевимаselectMappings. |
| sysmapids | ID/array | Врати само мапе икона које се користе у датим мапама. |
| selectMappings | query | Врати својство mappings са коришћеним мапирањем икона. |
| sortfield | string/array | Сортирај резултат према датом својства. Могуће вредности: iconmapid, name. |
| countOutput | boolean | Ови параметри који су заједнички за све методе get су детаљно описани у reference commentary. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Повратне вредности
(integer/array) Враћа било:
- низ објеката;
- број преузетих објеката, ако је параметар
countOutputкоришћен.
Примери
Преузми мапу икона
Преузми све податке о мапи икона "3".
Преузми мапу икона
Преузми све податке о мапи икона "3".
{
"jsonrpc": "2.0",
"method": "iconmap.get",
"params": {
"iconmapids": "3",
"output": "extend",
"selectMappings": "extend"
},
"id": 1
}Одговор:
{
"jsonrpc": "2.0",
"result": [
{
"mappings": [
{
"iconmappingid": "3",
"iconmapid": "3",
"iconid": "6",
"inventory_link": "1",
"expression": "server",
"sortorder": "0"
},
{
"iconmappingid": "4",
"iconmapid": "3",
"iconid": "10",
"inventory_link": "1",
"expression": "switch",
"sortorder": "1"
}
],
"iconmapid": "3",
"name": "Host type icons",
"default_iconid": "2"
}
],
"id": 1
}Такође погледајте
Извор
CIconMap::get() in ui/include/classes/api/services/CIconMap.php.