Zabbix Documentation 4.0

3.04.05.0 (current)| In development:5.2 (devel)| Unsupported:1.82.02.22.43.23.44.24.4Guidelines

User Tools

Site Tools


manual:api:reference:screen:get

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:api:reference:screen:get [2016/01/25 14:18]
oleg.egorov added userid and private fields
manual:api:reference:screen:get [2020/02/14 11:48] (current)
marinagen fixed screenitemids description
Line 16: Line 16:
 | screenids | string/​array | Return only screens with the given IDs. | | screenids | string/​array | Return only screens with the given IDs. |
 | userids| string/​array | Return only screens that belong to the given user IDs. | | userids| string/​array | Return only screens that belong to the given user IDs. |
-| screenitemids | string/​array | Return only screen ​that contain the given screen items. |+| screenitemids | string/​array | Return only screens ​that contain the given screen items. ​
 +^ |||
 | selectUsers| query | Returns users that the screen is shared with in ''​users''​ property. | | selectUsers| query | Returns users that the screen is shared with in ''​users''​ property. |
 | selectUserGroups| query | Returns user groups that the screen is shared with in ''​userGroups''​ property. | | selectUserGroups| query | Returns user groups that the screen is shared with in ''​userGroups''​ property. |
-^ ||| 
 | selectScreenItems | query | Return the screen items that are used in the screen. | | 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''​. ​ | | sortfield | string/​array | Sort the result by the given properties. \\ \\ Possible values are: ''​screenid''​ and ''​name''​. ​ |
-| countOutput |flag|These parameters being common for all ''​get''​ methods are described in detail in the [[manual:​api:​reference_commentary#​common_get_method_parameters|reference commentary]] page.  |+| countOutput |boolean|These parameters being common for all ''​get''​ methods are described in detail in the [[manual:​api:​reference_commentary#​common_get_method_parameters|reference commentary]] page.  |
 | editable |boolean|:::​| | editable |boolean|:::​|
-| excludeSearch |flag|:::|+| excludeSearch |boolean|:::|
 | filter | object |:::| | filter | object |:::|
 | limit |integer|:::​| | limit |integer|:::​|
 | output |query|:::| | output |query|:::|
-| preservekeys |flag|:::|+| preservekeys |boolean|:::|
 | search | object |:::| | search | object |:::|
 | searchByAny |boolean|:::​| | searchByAny |boolean|:::​|
 | searchWildcardsEnabled |boolean|:::​| | searchWildcardsEnabled |boolean|:::​|
 | sortorder | string/​array | ::: | | sortorder | string/​array | ::: |
-| startSearch |flag|:::|+| startSearch |boolean|:::|
 ==== Return values ==== ==== Return values ====
  
Line 48: Line 48:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 65: Line 65:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 109: Line 109:
             "​hsize":​ "​3",​             "​hsize":​ "​3",​
             "​vsize":​ "​2",​             "​vsize":​ "​2",​
-            "​templateid":​ "​0",​ 
             "​userid":​ "​1",​             "​userid":​ "​1",​
             "​private":​ "​1"​             "​private":​ "​1"​