Documentation
Table of Contents
templatedashboard.update
Description
object templatedashboard.update(object/array templateDashboards)
Cette méthode permet de mettre à jour les modèles de tableaux de bord existants.
Cette méthode est disponible uniquement pour les types d'utilisateurs Admin et Super admin. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres de rôles 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 actualisées.
En plus des propriétés standard 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 en remplacement des pages de tableau de bord existantes. Les pages de 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 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 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 modèle de tableau de bord
Renommez un modèle de tableau de bord en "Performance graphs".
Requête :
{
"jsonrpc": "2.0",
"method": "templatedashboard.update",
"params": {
"dashboardid": "23",
"name": "Performance graphs"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
Mise à jour des pages de 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 tant que troisième. 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": '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 :
Voir également
Source
CTemplateDashboard::update() dans ui/include/classes/api/services/CTemplateDashboard.php.