dashboard.update

Descripció

object dashboard.update(object/array dashboards)

Aquest mètode permet actualitzar taulers ja existents.

Aquest mètode és disponible per a qualsevol mena d'usuaris. Els permisos per cridar al mètode es poden revocar a la configuració de rols d'usuaris. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object/array) Propietats del tauler a actualitzar.

La propietat dashboardid s'ha de definir per tot tauler; totes les altres propietats són opcionals. Només s'actualitzaran les propietats aprovades, totes les altres romandran sense canvis.

A més de les propietats estàndard del tauler de control, el mètode accepta els paràmetres següents.

Paràmetre Tipus Descripció
pages array Pages del tauler enlloc de les pàgines existents.

Les pàgines del tauler són actualitzades per la propietat dashboard_pageid. Les noves pàgines del tauler es crearan per els objectes sense la propietat dashboard_pageid i les pàgines del tauler existents s'esborraran si no es reutilitzen pas. Les pàgines del tauler es classifiquen en el mateix ordre que l'especificat. Només les propietats especificades de les pàgines del tauler s'actualitzaran. Com a mínim cal un objecte de pàgina de tauler a la propietat pages.
users array Usuari del tauler enlloc de l'existent.
userGroups array Grup d'usuaris del tauler enlloc de l'existent.

Valors de retorn

(object) Torna un objecte que contingui els IDs dels taulers actualitzats sota la propietat dashboardids.

Exemples

Reanomenant un tauler

Reanomenar el tauler com a "Estat del servidor SQL".

Petició:

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

Resposta:

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

Actualitzar les pàgines del tauler

Reanomenar la primera pàgina del tauler, reemplaçar els ginys a la segona pàgina i afegir una nova pàgina com a tercera del tauler. Esborrar la resta de pàgines del tauler.

Petició:

{
           "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
       }

Resposta:

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

Canviar el propietari del tauler

Disponible només per a admins i super admins.

Petició:

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

Resposta:

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

Veieu tamé

Font

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