Documentation
Table of Contents
templatedashboard.update
Descripció
object templatedashboard.update(object/array templateDashboards)
Aquest mètode permet actualitzar taulers.
Tenim aquest mètode disponible només per als usuaris Admin i Super admin. Els permisos per cridar el mètode es poden revocar a la configuració dels rols d'usuari. Per a més informació, veieu Rols d'usuari.
Paràmetres
(object/array) Propietats del tauler a actualitzar.
La propietat dashboardid s'ha d'especificar per a cada tauler, totes les altres propietats són opcionals. Només s'actualitzaran les propietats especificades.
A més de les [propietats del tauler de plantilla] estàndard (object#template_dashboard), el mètode admet els paràmetres següents.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| pages | array | Pàgines del tauler de plantilla substituint les pàgines del tauler de control existents. Les pàgines del tauler de control s'actualitzen mitjançant la propietat dashboard_pageid. Es crearan pàgines de tauler noves per als objectes sense una propietat dashboard_pageid i les pàgines de tauler existents s'esborraran si no es reutilitzen. Les pàgines del tauler s'ordenaran en el mateix ordre especificat. Només s'actualitzaran les propietats especificades de les pàgines del tauler. Es requereix almenys un objecte de pàgina del tauler per a la propietat pages. |
Valors de retorn
(object) Torna un objecte que contingui els IDs de la plantilla de taulers actualitzada sota la propietat dashboardids.
Exemples
Reanomenar una plantilla de tauler
Reanomena una plantilla de tauler a "Gràfics de rendiment".
{
"jsonrpc": "2.0",
"method": "templatedashboard.update",
"params": {
"dashboardid": "23",
"name": "Gràfics de rendiment"
},
"id": 1
}Resposta:
Actualitzar les pàgines de tauler de plantilla
Reanomena la primera pàgina del tauler, reemplaça els ginys de la segona pàgina del tauler i afegeix una nova pàgina com a tercera. Esborra la resta de pàgines del tauler.
{
"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": 12,
"height": 3
}
]
},
{
"display_period": 60
}
]
},
"id": 1
}Resposta:
Veieu també
Font
CTemplateDashboard::update() in ui/include/classes/api/services/CTemplateDashboard.php.