获取

描述

integer/array dashboard.get(object parameters)

这个方法允许根据给定的参数检索仪表板

参数

(object) 定义需要输出的参数。

这个方法支持以下参数。

参数 类描述
dashboardids字符串/数组 只返回拥给定 ID 的仪表板。
selectWidgets查询 返widgets 属性,并在仪表板中使用的小部件。
selectUsers查询 返users 属性中共享仪表板的用户。
selectUserGroups查询 返userGroups 属性中共享仪表板的用户组。
sortfield字符串/数组 根据给定属性对结果进行排序。

可能的值有:dashboardid
countOutput布尔值 在用评论中详细描述了所有 get 方法的常见参数。
editable布尔值 ::
excludeSearch布尔值 ::
filter对象 ::
limit整数 ::
output查询 ::
preservekeys布尔值 ::
search对象 ::
searchByAny布尔值 ::
searchWildcardsEnabled布尔值 ::
sortorder字符串/数组 :::
startSearch布尔值 ::

返回值

(integer/array) 返回:

  • 一个对象数组;
  • 如果使用了 countOutput 参数,被检索的对象的数量。

示例

通过 ID 检索一个仪表板

检索仪表板 “1” 和 “2” 的所有数据。

请求:

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "dashboard.get",
  4. "params": {
  5. "output": "extend",
  6. "selectWidgets": "extend",
  7. "selectUsers": "extend",
  8. "selectUserGroups": "extend",
  9. "dashboardids": [
  10. "1",
  11. "2"
  12. ]
  13. },
  14. "auth": "038e1d7b1735c6a5436ee9eae095879e",
  15. "id": 1
  16. }

响应:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": [
  4. {
  5. "dashboardid": "1",
  6. "name": "Dashboard",
  7. "userid": "1",
  8. "private": "0",
  9. "users": [],
  10. "userGroups": [],
  11. "widgets": [
  12. {
  13. "widgetid": "9",
  14. "type": "systeminfo",
  15. "name": "",
  16. "x": "6",
  17. "y": "8",
  18. "width": "6",
  19. "height": "5",
  20. "fields": []
  21. },
  22. {
  23. "widgetid": "8",
  24. "type": "problemsbysv",
  25. "name": "",
  26. "x": "6",
  27. "y": "4",
  28. "width": "6",
  29. "height": "4",
  30. "fields": []
  31. },
  32. {
  33. "widgetid": "7",
  34. "type": "problemhosts",
  35. "name": "",
  36. "x": "6",
  37. "y": "0",
  38. "width": "6",
  39. "height": "4",
  40. "fields": []
  41. },
  42. {
  43. "widgetid": "6",
  44. "type": "discovery",
  45. "name": "",
  46. "x": "3",
  47. "y": "9",
  48. "width": "3",
  49. "height": "4",
  50. "fields": []
  51. },
  52. {
  53. "widgetid": "5",
  54. "type": "web",
  55. "name": "",
  56. "x": "0",
  57. "y": "9",
  58. "width": "3",
  59. "height": "4",
  60. "fields": []
  61. },
  62. {
  63. "widgetid": "4",
  64. "type": "problems",
  65. "name": "",
  66. "x": "0",
  67. "y": "3",
  68. "width": "6",
  69. "height": "6",
  70. "fields": []
  71. },
  72. {
  73. "widgetid": "3",
  74. "type": "favmaps",
  75. "name": "",
  76. "x": "4",
  77. "y": "0",
  78. "width": "2",
  79. "height": "3",
  80. "fields": []
  81. },
  82. {
  83. "widgetid": "2",
  84. "type": "favscreens",
  85. "name": "",
  86. "x": "2",
  87. "y": "0",
  88. "width": "2",
  89. "height": "3",
  90. "fields": []
  91. },
  92. {
  93. "widgetid": "1",
  94. "type": "favgraphs",
  95. "name": "",
  96. "x": "0",
  97. "y": "0",
  98. "width": "2",
  99. "height": "3",
  100. "fields": []
  101. }
  102. ]
  103. },
  104. {
  105. "dashboardid": "2",
  106. "name": "My dashboard",
  107. "userid": "1",
  108. "private": "1",
  109. "users": [
  110. {
  111. "userid": "4",
  112. "permission": "3"
  113. }
  114. ],
  115. "userGroups": [
  116. {
  117. "usrgrpid": "7",
  118. "permission": "2"
  119. }
  120. ],
  121. "widgets": [
  122. {
  123. "widgetid": "10",
  124. "type": "problems",
  125. "name": "",
  126. "x": "0",
  127. "y": "0",
  128. "width": "6",
  129. "height": "5",
  130. "fields": [
  131. {
  132. "type": "2",
  133. "name": "groupids",
  134. "value": "4"
  135. }
  136. ]
  137. }
  138. ]
  139. }
  140. ],
  141. "id": 1
  142. }

参见

来源

CDashboard::get() in frontends/php/include/classes/api/services/CDashboard.php.