dashboard.update

Description

object dashboard.update(object/array dashboards)

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

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appeler la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir User roles pour plus d’informations.

Paramètres

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

La propriété dashboardid doit être définie pour chaque tableau de bord, 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 standard du tableau de bord, la méthode accepte les paramètres suivants.

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

Les pages du tableau de bord sont mises à jour à l’aide de la propriété dashboard_pageid. De nouvelles pages du tableau de bord seront créées pour les objets ne possédant pas la 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.
users array Partages des utilisateurs du tableau de bord pour remplacer les éléments existants.
userGroups array Partages des groupes d’utilisateurs du tableau de bord pour remplacer les éléments existants.

Valeurs retournées

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

Exemples

Renommer un tableau de bord

Renommez un tableau de bord en « SQL server status ».

Requête:

{
    "jsonrpc": "2.0",
    "method": "dashboard.update",
    "params": {
        "dashboardid": "2",
        "name": "SQL server status"
    },
    "id": 1
}

Réponse :

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

Mise à jour des pages du tableau de bord

Renommez la première page du tableau de bord, remplacez les widgets de 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": "dashboard.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
}

Changer le propriétaire du tableau de bord

Disponible uniquement pour les admins et les super admins.

Requête :

{
    "jsonrpc": "2.0",
    "method": "dashboard.update",
    "params": {
        "dashboardid": "2",
        "userid": "1"
    },
    "id": 1
}

Réponse :

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

Voir également

Source

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