templatedashboard.update

Description

object templatedashboard.update(object/array templateDashboards)

Cette méthode permet de mettre à jour des tableaux de bord de modèle existants.

Cette méthode est disponible uniquement pour les types d’utilisateur Admin et Super admin. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir Rôles utilisateur pour plus d’informations.

Paramètres

(object/array) Propriétés du tableau de bord du modèle à mettre à jour.

La propriété dashboardid doit être spécifiée pour chaque tableau de bord, toutes les autres propriétés sont facultatives. Seules les propriétés spécifiées seront mises à jour.

En plus des propriétés standard du tableau de bord du modèle, la méthode accepte les paramètres suivants.

Paramètre Type Description
pages array Pages du tableau de bord du modèle pour remplacer les pages existantes du tableau de bord.

Les pages du tableau de bord sont mises à jour par la propriété dashboard_pageid. De nouvelles pages de tableau de bord seront créées pour les objets sans propriété dashboard_pageid et les pages existantes du tableau de bord seront supprimées si elles ne sont pas réutilisées. Les pages du tableau de bord seront ordonnées dans le même ordre que celui spécifié. Seules les propriétés spécifiées des pages du tableau de bord seront mises à jour. Au moins un objet de page de tableau de bord est requis pour la propriété pages.

Valeurs retournées

(object) Retourne un objet contenant les identifiants des modèles de tableaux de bord mis à jour dans la propriété dashboardids.

Exemples

Renommer un tableau de bord de modèle

Renommez un tableau de bord de modèle en « Performance graphs ».

Requête :

{
    "jsonrpc": "2.0",
    "method": "templatedashboard.update",
    "params": {
        "dashboardid": "23",
        "name": "Performance graphs"
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "23"
        ]
    },
    "id": 1
}

Mise à jour des pages du tableau de bord du modèle

Renommez la première page du tableau de bord, remplacez les widgets sur la deuxième page du tableau de bord et ajoutez une nouvelle page en troisième position. Supprimez toutes les autres pages du tableau de bord.

Requête:

{
    "jsonrpc": "2.0",
    "method": "templatedashboard.update",
    "params": {
        "dashboardid": "2",
        "pages": [
            {
                "dashboard_pageid": 1,
                "name": "Page renommée"
            },
            {
                "dashboard_pageid": 2,
                "widgets": [
                    {
                        "type": "clock",
                        "x": 0,
                        "y": 0,
                        "width": 12,
                        "height": 3
                    }
                ]
            },
            {
                "display_period": 60
            }
        ]
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "2"
        ]
    },
    "id": 1
}

Voir aussi

Source

CTemplateDashboard::update() dans ui/include/classes/api/services/CTemplateDashboard.php.