dashboard.update

Description

object dashboard.update(object/array dashboards)

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

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.

Outre les propriétés standards de tableau de bord, la méthode accepte les paramètres suivants.

Paramètre Type Description
widgets tableau Widget de tableau de bord pour remplacer les widgets de tableau de bord existants.

Les widgets de tableau de bord sont mis à jour par la propriété widgetid. Les widgets sans propriété widgetid seront créés.
users tableau Utilisateur de tableau de bord pour remplacer les éléments existants.
userGroups tableau Groupe d'utilisateurs de tableau de bord pour remplacer les éléments existants.

Valeurs de retour

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

Exemples

Renommer un tableau de bord

Renomme un tableau de bord en "Etat du serveur SQL".

Requête :

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

Réponse :

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

Changer le propriétaire d'un tableau de bord

Disponible uniquement pour les administrateurs et les super-administrateurs.

Requête :

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

Réponse :

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

Voir aussi

Source

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