Zabbix Documentation 4.4

3.04.04.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

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 [2014/09/30 12:54]
127.0.0.1 external edit
manual:api:reference:screen:get [2020/02/14 11:47] (current)
marinagen fixed screenitemids description
Line 15: Line 15:
 ^ Parameter ^ Type ^ Description ^ ^ Parameter ^ Type ^ Description ^
 | screenids | string/​array | Return only screens with the given IDs. | | screenids | string/​array | Return only screens with the given IDs. |
-| screenitemids | string/​array | Return only screen ​that contain the given screen items. |+| userids| string/​array | Return only screens that belong to the given user IDs. | 
 +| screenitemids | string/​array | Return only screens ​that contain the given screen items. |
 ^ ||| ^ |||
-| selectScreenItems | query | Return the screen items that are used in the screen. |+| selectScreenItems | query | Return ​a ''​[[:​manual/​api/​reference/​screenitem/​object#​screen_item|screenitems]]''​ property with the elements ​that are used in the screen. | 
 +| selectUsers| query | Return a ''​[[:​manual/​api/​reference/​screen/​object#​screen_user|users]]''​ property with users that the screen is shared with. | 
 +| selectUserGroups| query | Return a ''​[[:​manual/​api/​reference/​screen/​object#​screen_user_group|userGroups]]''​ property with user groups that the screen is shared with. |
 ^ ||| ^ |||
 | 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 45: Line 48:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 52: Line 55:
         "​output":​ "​extend",​         "​output":​ "​extend",​
         "​selectScreenItems":​ "​extend",​         "​selectScreenItems":​ "​extend",​
 +        "​selectUsers":​ "​extend",​
 +        "​selectUserGroups":​ "​extend",​
         "​screenids":​ "​26"​         "​screenids":​ "​26"​
     },     },
Line 60: Line 65:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 84: Line 89:
                     "​dynamic":​ "​0",​                     "​dynamic":​ "​0",​
                     "​sort_triggers":​ "​0"​                     "​sort_triggers":​ "​0"​
 +                }
 +            ],
 +            "​users":​ [
 +                {
 +                    "​sysmapuserid":​ "​1",​
 +                    "​userid":​ "​2",​
 +                    "​permission":​ "​2"​
 +                }
 +            ],
 +            "​userGroups":​ [
 +                {
 +                    "​screenusrgrpid":​ "​1",​
 +                    "​usrgrpid":​ "​7",​
 +                    "​permission":​ "​3"​
                 }                 }
             ],             ],
Line 90: Line 109:
             "​hsize":​ "​3",​             "​hsize":​ "​3",​
             "​vsize":​ "​2",​             "​vsize":​ "​2",​
-            "templateid": "0"+            "userid": "1", 
 +            "​private":​ "1"
         }         }
     ],     ],
Line 100: Line 120:
  
   * [[manual:​api:​reference:​screenitem:​object#​screen_item|Screen item]]   * [[manual:​api:​reference:​screenitem:​object#​screen_item|Screen item]]
 +  * [[object#​screen_user|Screen user]]
 +  * [[object#​screen_user_group|Screen user group]]
  
 ==== Source ==== ==== Source ====
  
-CScreen::​get() in //​frontends/​php/​api/​classes/​CScreen.php//​.+CScreen::​get() in //​frontends/​php/​include/classes/​api/​services/​CScreen.php//​.