获取

Description 描述

integer/array screen.get(object parameters)

The method allows to retrieve screens according to the given parameters. 此方法允许搜索符合所给参数的聚合图形

Parameters 参数

(object) Parameters defining the desired output. (object) 定义所需输出的参数。

The method supports the following parameters. 此方法支持以下参数

Parameter	Type	Description
screenids	string/array	Return only screens with the given IDs. 返回所给IDs的聚合图形
userids	string/array	Return only screens that belong to the given user IDs. 返回所给用户IDs的聚合图形
screenitemids	string/array	Return only screen that contain the given screen items. 返回所给聚合图形项的的聚合图形
selectUsers	query	Returns users that the screen is shared with in `users` property. 返回`users`属性中与聚合图形共享的用户。
selectUserGroups	query	Returns user groups that the screen is shared with in `userGroups` property. 返回`userGroups`属性中与聚合图形共享的用户组。
selectScreenItems	query	Return the screen items that are used in the screen. 返回聚合图形上使用的聚合图形项。
sortfield	string/array	Sort the result by the given properties. Possible values are: `screenid` and `name`. 根据所给参数对结果进行排序可能的值：`screenid` 和 `name`
countOutput	boolean	These parameters being common for all `get` methods are described in detail in the reference commentary page. 这个参数通用与所有的`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

Return values 返回值

(integer/array) Returns either:

an array of objects;
the count of retrieved objects, if the countOutput parameter has been used.
一个数组对象
查看对象的个数，如果countOutput参数被使用

Examples 示例如下

Retrieving a screen by ID 通过ID查看一个聚合图形

Retrieve all data about screen "26" and its screen items. 搜索所有的数据关于聚合图形id是26和他的聚合图形项

Request:

{
           "jsonrpc": "2.0",
           "method": "screen.get",
           "params": {
               "output": "extend",
               "selectScreenItems": "extend",
               "selectUsers": "extend",
               "selectUserGroups": "extend",
               "screenids": "26"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [    
               {
                   "screenitems": [
                       {
                           "screenitemid": "67",
                           "screenid": "26",
                           "resourcetype": "0",
                           "resourceid": "612",
                           "width": "320",
                           "height": "200",
                           "x": "0",
                           "y": "0",
                           "colspan": "0",
                           "rowspan": "0",
                           "elements": "25",
                           "valign": "0",
                           "halign": "0",
                           "style": "0",
                           "url": "",
                           "dynamic": "0",
                           "sort_triggers": "0"
                       }
                   ],
                   "users": [
                       {
                           "sysmapuserid": "1",
                           "userid": "2",
                           "permission": "2"
                       }
                   ],
                   "userGroups": [
                       {
                           "screenusrgrpid": "1",
                           "usrgrpid": "7",
                           "permission": "3"
                       }
                   ],
                   "screenid": "26",
                   "name": "CPU Graphs",
                   "hsize": "3",
                   "vsize": "2",
                   "templateid": "0",
                   "userid": "1",
                   "private": "1"
               }
           ],
           "id": 1
       }

Source

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

Documentation

获取