Sidebar
fr:manual:api:reference:screenitem:get
Table of Contents
screenitem.get
Description
integer/array screenitem.get(object parameters)
La méthode permet de récupérer des éléments d'écran 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 |
|---|---|---|
| screenitemids | string/array | Renvoie uniquement les éléments d'écran avec les identifiants donnés. |
| screenids | string/array | Renvoie uniquement les éléments d'écran appartenant à l'écran donné. |
| sortfield | string/array | Trie le résultat en fonction des propriétés données. Valeurs possibles : screenitemid etscreenid. |
| 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 des éléments d'écran de l'écran
Récupérer tous les éléments d'écran d'un écran donné.
Requête :
{ "jsonrpc": "2.0", "method": "screenitem.get", "params": { "output": "extend", "screenids": "3" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Réponse :
{ "jsonrpc": "2.0", "result": [ { "screenitemid": "20", "screenid": "3", "resourcetype": "0", "resourceid": "433", "width": "500", "height": "120", "x": "0", "y": "0", "colspan": "1", "rowspan": "1", "elements": "0", "valign": "1", "halign": "0", "style": "0", "url": "", "dynamic": "0", "sort_triggers": "0", "application": "", "max_columns": "3" }, { "screenitemid": "21", "screenid": "3", "resourcetype": "0", "resourceid": "387", "width": "500", "height": "100", "x": "0", "y": "1", "colspan": "1", "rowspan": "1", "elements": "0", "valign": "1", "halign": "0", "style": "0", "url": "", "dynamic": "0", "sort_triggers": "0", "application": "", "max_columns": "3" }, { "screenitemid": "22", "screenid": "3", "resourcetype": "1", "resourceid": "10013", "width": "500", "height": "148", "x": "1", "y": "0", "colspan": "1", "rowspan": "1", "elements": "0", "valign": "1", "halign": "0", "style": "0", "url": "", "dynamic": "0", "sort_triggers": "0", "application": "", "max_columns": "3" }, { "screenitemid": "23", "screenid": "3", "resourcetype": "1", "resourceid": "22181", "width": "500", "height": "184", "x": "1", "y": "1", "colspan": "1", "rowspan": "1", "elements": "0", "valign": "1", "halign": "0", "style": "0", "url": "", "dynamic": "0", "sort_triggers": "0", "application": "", "max_columns": "3" } ], "id": 1 }
Source
CScreenItem::get() dans frontends/php/include/classes/api/services/CScreenItem.php.