templatescreenitem.get

Description

integer/array templatescreenitem.get(object parameters)

La méthode permet de récupérer des éléments d'écran de modèle 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 éléments d'écran de modèle appartenant aux écrans de modèles donnés.
screenitemids	string/array	Renvoie uniquement les éléments d'écran de modèle avec les identifiants donnés.
hostids	string/array	Renvoie une propriété `real_resourceid` supplémentaire pour chaque élément d'écran de modèle, qui appartient à un écran des hôtes ou modèles donnés. La propriété `real_resourceid` contient l'identifiant de l'objet affiché à l'écran.
sortfield	string/array	Trie le résultat en fonction des propriétés données. Valeurs possibles : `screenitemid` et `screenid`.
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 countOutput a été utilisé.

Exemples

Récupération des éléments d'écran de modèle pour un écran

Récupération de tous les éléments d'écran de modèle de l'écran "15".

Requête :

{
           "jsonrpc": "2.0",
           "method": "templatescreenitem.get",
           "params": {
               "output": "extend",
               "screenids": "15"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "screenitemid": "42",
                   "screenid": "15",
                   "resourcetype": "0",
                   "resourceid": "454",
                   "width": "500",
                   "height": "200",
                   "x": "0",
                   "y": "0",
                   "colspan": "1",
                   "rowspan": "1",
                   "elements": "0",
                   "valign": "1",
                   "halign": "0",
                   "style": "0",
                   "url": "",
                   "max_columns": "3"
               },
               {
                   "screenitemid": "43",
                   "screenid": "15",
                   "resourcetype": "0",
                   "resourceid": "455",
                   "width": "500",
                   "height": "270",
                   "x": "1",
                   "y": "0",
                   "colspan": "1",
                   "rowspan": "1",
                   "elements": "0",
                   "valign": "1",
                   "halign": "0",
                   "style": "0",
                   "url": "",
                   "max_columns": "3"
               }
           ],
           "id": 1
       }

Source

CTemplateScreenItem::get() dans frontends/php/include/classes/api/services/CTemplateScreenItem.php.

Documentation