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.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
(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.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | 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.