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) Tauler a actualitzar.

La propietat dashboardid s'ha de definir per a cada tauler, totes les altres propietats són opcionals. Només s'actualitzaran les propietats facilitades.

A més de les [propietats del tauler de plantilla] estàndard (object#dashboard), el mètode admet els paràmetres següents.

Paràmetre Tipus Descripció
pages taula Pàgines del tauler 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.
users taula Usuari del tauler per substituir els elements existents.
userGroups taula Grup d'usuaris del tauler per substituir els elements existents.

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"
           },
           "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": 12,
                               "height": 3
                           }
                       ]
                   },
                   {
                       "display_period": 60
                   }
               ]
           },
           "id": 1
       }

Resposta:

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

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"
           },
           "id": 1
       }

Resposta:

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

Veieu tamé

Font

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