Sidebar
fr:manual:api:reference:screen:update
Table of Contents
screen.update
Description
object screen.update(object/array screens)
Cette méthode permet de mettre à jour les écran existants.
Paramètres
(object/array) Propriétés d'écran à mettre à jour.
La propriété screenid doit être définie pour chaque écran, toutes les autres propriétés sont facultatives. Seules les propriétés transmises seront mises à jour, toutes les autres resteront inchangées.
En plus des propriétés de l'objet écran standard, la méthode accepte les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| screenitems | array | Éléments d'écran qui remplaceront les éléments d'écran existants. Les éléments d'écran sont mis à jour par les coordonnées, de sorte que chaque propriété d'écran doit avoir les propriétés x et y définies. |
| users | array | Utilisateurs d'écran en remplacement des éléments existants. |
| userGroups | array | Groupes d'utilisateurs d'écran en remplacement des éléments existants. |
Valeurs retournées
(object) Retourne un objet contenant les identifiants des déclencheurs créés sous la propriété screenids.
Exemples
Renommer un écran
Renommer un écran en “CPU Graphs”.
Requête :
{ "jsonrpc": "2.0", "method": "screen.update", "params": { "screenid": "26", "name": "CPU Graphs" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Réponse :
{ "jsonrpc": "2.0", "result": { "screenids": [ "26" ] }, "id": 1 }
Modification du propriétaire de l'écran
Disponible uniquement pour les administrateurs et super administrateurs.
Requête :
{ "jsonrpc": "2.0", "method": "screen.update", "params": { "screenid": "83", "userid": "1" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 2 }
Réponse :
{ "jsonrpc": "2.0", "result": { "screenids": [ "83" ] }, "id": 2 }
Voir également
Source
CScreen::update() dans frontends/php/include/classes/api/services/CScreen.php.