screen.get

说明

integer/array screen.get(object parameters)

该方法允许根据给定的参数检索screen。

参数

(object) 定义所需输出的参数。该方法支持以下参数。

属性 类型 说明
screenids string/array 只返回具有给定ID的screen。
userids string/array 仅返回属于给定用户ID的screen
screenitemids string/array 只返回包含给定screen item的屏幕。
selectUsers query 返回用户在users属性中共享screen。
selectUserGroups query
  • 一组对象;
  • 如果已经使用“countOutput”参数，则检索到的对象的计数。

示例

按ID检索Screen

Retrieve all data about screen “26” and its screen items.

Request:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "screen.get",
  4.     "params": {
  5.         "output": "extend",
  6.         "selectScreenItems": "extend",
  7.         "selectUsers": "extend",
  8.         "selectUserGroups": "extend",
  9.         "screenids": "26"
  10.     },
  11.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  12.     "id": 1
  13. }

Response:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": [    
  4.         {
  5.             "screenitems": [
  6.                 {
  7.                     "screenitemid": "67",
  8.                     "screenid": "26",
  9.                     "resourcetype": "0",
  10.                     "resourceid": "612",
  11.                     "width": "320",
  12.                     "height": "200",
  13.                     "x": "0",
  14.                     "y": "0",
  15.                     "colspan": "0",
  16.                     "rowspan": "0",
  17.                     "elements": "25",
  18.                     "valign": "0",
  19.                     "halign": "0",
  20.                     "style": "0",
  21.                     "url": "",
  22.                     "dynamic": "0",
  23.                     "sort_triggers": "0"
  24.                 }
  25.             ],
  26.             "users": [
  27.                 {
  28.                     "sysmapuserid": "1",
  29.                     "userid": "2",
  30.                     "permission": "2"
  31.                 }
  32.             ],
  33.             "userGroups": [
  34.                 {
  35.                     "screenusrgrpid": "1",
  36.                     "usrgrpid": "7",
  37.                     "permission": "3"
  38.                 }
  39.             ],
  40.             "screenid": "26",
  41.             "name": "CPU Graphs",
  42.             "hsize": "3",
  43.             "vsize": "2",
  44.             "templateid": "0",
  45.             "userid": "1",
  46.             "private": "1"
  47.         }
  48.     ],
  49.     "id": 1
  50. }

参见

来源

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