This is a translation of the original English documentation page. Help us make it better.

Sidebar

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'appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir les rôles utilisateur 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.

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

Paramètre Type Description
pages array Pages de tableau de bord en remplacement des pages existantes.

Les pages de tableau de bord sont mises à jour par la propriété dashboard_pageid. Les nouvelles pages de tableau de bord seront créées pour les objets sans propriété dashboard_pageid et les pages de tableau de bord existantes seront supprimées si elles ne sont pas réutilisées. Les pages du tableau de bord seront classé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 dans la propriété pages.
users array Utilisateur de tableau de bord en remplacement de l'existant.
userGroups array Groupe d'utilisateurs de tableau de bord en remplacement de l'existant.

Valeurs retournées

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

Exemples

Renommage d'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
       }

Mise à jour des pages du tableau de bord

Renommer la première page du tableau de bord, remplacer les widgets sur la deuxième page du tableau de bord et ajouter une nouvelle page en tant que troisième page. Supprimer toutes les autres pages du tableau de bord.

Requête :

{
           "jsonrpc": "2.0",
           "method": "dashboard.update",
           "params": {
               "dashboardid": "2",
               "pages": [
                   {
                       "dashboard_pageid": 1,
                       "name": 'Renamed Page'
                   },
                   {
                       "dashboard_pageid": 2,
                       "widgets": [
                           {
                               "type": "clock",
                               "x": 0,
                               "y": 0,
                               "width": 4,
                               "height": 3
                           }
                       ]
                   },
                   {
                       "display_period": 60
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Réponse :

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

Changement de 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 également

Source

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