Sidebar

fr:manual:api:reference:templatescreen:update

templatescreen.update

Description

object templatescreen.update(object/array templateScreens)

Cette méthode permet de mettre à jour les écrans de modèle.

Paramètres

(object/array) Propriétés des écrans de modèle à mettre à jour.

La propriété screenid doit être définie pour chaque écran de modèle. 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 d'écran de modèle standard, la méthode accepte les paramètres suivants.

Paramètre Type Description
screenitems array Éléments d'écran qui remplacent les éléments d'écran existants.

Les éléments d'écran sont mis à jour par coordonnées. Par conséquent, les propriétés x et y doivent être définies pour chaque élément d'écran.

Valeurs retournées

(object) Retourne un objet contenant les identifiants des écrans de modèle mis à jour sous la propriété screenids.

Exemples

Renommage d'un écran de modèle

Renommage d'un écran de modèle en “Performance graphs”.

Requête :

{
    "jsonrpc": "2.0",
    "method": "templatescreen.update",
    "params": {
        "screenid": "3",
        "name": "Performance graphs"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": {
        "screenids": [
            "3"
        ]
    },
    "id": 1
}

Source

CTemplateScreen::update() dans frontends/php/include/classes/api/services/CTemplateScreen.php.