Documentation
Table of Contents
screen.get
Description
integer/array screen.get(object parameters)
La méthode permet de récupérer des écrans en fonction des paramètres donnés.
Paramètres
(object) Paramètres définissant la sortie souhaitée.
La méthode prend en charge les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| screenids | string/array | Renvoie uniquement les écrans avec les identifiants donnés. |
| userids | string/array | Renvoie uniquement les écrans appartenant aux ID utilisateur donnés. |
| screenitemids | string/array | Renvoie uniquement les écrans contenant les éléments d’écran donnés. |
| selectUsers | query | Renvoie les utilisateurs avec lesquels l'écran est partagé dans la propriété users. |
| selectUserGroups | query | Renvoie les groupes d'utilisateur avec lesquels l'écran est partagé dans la propriété userGroups. |
| selectScreenItems | query | Renvoie les éléments d'écran utilisés dans l'écran. |
| sortfield | string/array | Trie le résultat en fonction des propriétés données. Valeurs possibles : screenid et name. |
| countOutput | boolean | Ces paramètres, communs à toutes les méthodes "get", sont décrits dans les commentaires de référence. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valeurs retournées
(integer/array) Retourne soit :
- un tableau d'objets ;
- le nombre d'objets récupérés, si le paramètre
countOutputa été utilisé.
Exemples
Récupération d'écran par ID
Récupérer toutes les données de l'écran "26" et ses éléments d'écran.
Requête :
{ "jsonrpc": "2.0", "method": "screen.get", "params": { "output": "extend", "selectScreenItems": "extend", "selectUsers": "extend", "selectUserGroups": "extend", "screenids": "26" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Réponse :
{ "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 }Voir également
Source
CScreen::get() in frontends/php/include/classes/api/services/CScreen.php.