聚合图形监控项获取

描述

integer/array screenitem.get(object **parameters**)

该方法允许根据给定的参数检索聚合图形监控项。

参数

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

该方法支持以下参数。

ParameterTypeDescription
screenitemidsstring/array只返回具有给定id的聚合图形监控项。
screenidsstring/array只返回属于给定聚合图形的聚合图形监控项。
sortfieldstring/array根据给定的属性对结果排序.

可能值: screenitemidscreenid.
countOutputboolean对于所有“get”方法,这些参数都是通用的,在 reference commentary page 页面。
editableboolean
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

返回值

(integer/array) Returns either:

  • 一个对象数组;

  • 检索对象的计数, 如果使用了“countOutput”参数。

例子

从聚合图形中查寻聚合图形监控项

查询聚合图形监控项的所有聚合图形。

Request:

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "screenitem.get",
  4. "params": {
  5. "output": "extend",
  6. "screenids": "3"
  7. },
  8. "auth": "038e1d7b1735c6a5436ee9eae095879e",
  9. "id": 1
  10. }

Response:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": [
  4. {
  5. "screenitemid": "20",
  6. "screenid": "3",
  7. "resourcetype": "0",
  8. "resourceid": "433",
  9. "width": "500",
  10. "height": "120",
  11. "x": "0",
  12. "y": "0",
  13. "colspan": "1",
  14. "rowspan": "1",
  15. "elements": "0",
  16. "valign": "1",
  17. "halign": "0",
  18. "style": "0",
  19. "url": "",
  20. "dynamic": "0",
  21. "sort_triggers": "0",
  22. "application": "",
  23. "max_columns": "3"
  24. },
  25. {
  26. "screenitemid": "21",
  27. "screenid": "3",
  28. "resourcetype": "0",
  29. "resourceid": "387",
  30. "width": "500",
  31. "height": "100",
  32. "x": "0",
  33. "y": "1",
  34. "colspan": "1",
  35. "rowspan": "1",
  36. "elements": "0",
  37. "valign": "1",
  38. "halign": "0",
  39. "style": "0",
  40. "url": "",
  41. "dynamic": "0",
  42. "sort_triggers": "0",
  43. "application": "",
  44. "max_columns": "3"
  45. },
  46. {
  47. "screenitemid": "22",
  48. "screenid": "3",
  49. "resourcetype": "1",
  50. "resourceid": "10013",
  51. "width": "500",
  52. "height": "148",
  53. "x": "1",
  54. "y": "0",
  55. "colspan": "1",
  56. "rowspan": "1",
  57. "elements": "0",
  58. "valign": "1",
  59. "halign": "0",
  60. "style": "0",
  61. "url": "",
  62. "dynamic": "0",
  63. "sort_triggers": "0",
  64. "application": "",
  65. "max_columns": "3"
  66. },
  67. {
  68. "screenitemid": "23",
  69. "screenid": "3",
  70. "resourcetype": "1",
  71. "resourceid": "22181",
  72. "width": "500",
  73. "height": "184",
  74. "x": "1",
  75. "y": "1",
  76. "colspan": "1",
  77. "rowspan": "1",
  78. "elements": "0",
  79. "valign": "1",
  80. "halign": "0",
  81. "style": "0",
  82. "url": "",
  83. "dynamic": "0",
  84. "sort_triggers": "0",
  85. "application": "",
  86. "max_columns": "3"
  87. }
  88. ],
  89. "id": 1
  90. }

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