[comment]: # aside: 5

[comment]: # ({66fb9690-66fb9690})
# dashboard.update (atualização de dashboard)

[comment]: # ({/66fb9690-66fb9690})

[comment]: # ({becba6de-f235159f})
### Descrição

`painel de objetos.update(painéis de objetos/matrizes)`

Este método permite atualizar os painéis existentes.

::: noteclassic
Este método está disponível para usuários de qualquer tipo. Permissões
para chamar o método pode ser revogado nas configurações de função do usuário. Veja [Usuário
funções](/manual/web_interface/frontend_sections/administration/user_roles)
Para maiores informações.
:::

[comment]: # ({/becba6de-f235159f})

[comment]: # ({bf54b1f0-62947aa0})
### Parâmetros

`(object/array)` Propriedades do dashboard a serem atualizadas.

A propriedade `dashboardid` deve ser definida para cada dashboard, todas as
outras propriedades são opcionais. Somente as propriedades passadas serão
atualizadas, todas as outras permanecerão inalteradas.

Além das [propriedades padrão do dashboard](object#dashboard),
o método aceita os seguintes parâmetros.

|Parâmetro|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|pages|array|[Páginas do dashboard](object#dashboard-page) para substituir as páginas existentes do dashboard.<br><br>As páginas do dashboard são atualizadas pela propriedade `dashboard_pageid`. Novas páginas do dashboard serão criadas para objetos sem a propriedade `dashboard_pageid` e as páginas existentes do dashboard serão excluídas se não forem reutilizadas. As páginas do dashboard serão ordenadas na mesma ordem especificada. Somente as propriedades especificadas das páginas do dashboard serão atualizadas.|
|users|array|[Compartilhamentos de usuários do dashboard](object#dashboard-user) para substituir os elementos existentes.|
|userGroups|array|[Compartilhamentos de grupos de usuários do dashboard](object#dashboard-user-group) para substituir os elementos existentes.|

[comment]: # ({/bf54b1f0-62947aa0})

[comment]: # ({28e89b38-28e89b38})
### Valores de retorno

`(object)` Retorna um objeto contendo os IDs do
painéis sob a propriedade `dashboardids`.

[comment]: # ({/28e89b38-28e89b38})

[comment]: # ({b41637d2-b41637d2})
#### Exemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({d0eb0276-7fcf7de4})
#### Renomeando um dashboard

Renomeie um dashboard para "SQL server status".

[Requisição](/manual/api#performing-requests):

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

Resposta:

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

[comment]: # ({/d0eb0276-7fcf7de4})

[comment]: # ({ed5d0499-b8348b8a})
#### Atualizando páginas do dashboard

Renomeie a primeira página do dashboard, substitua os widgets na segunda página do dashboard e adicione uma nova página como a terceira. Exclua todas as outras páginas do dashboard.

[Requisição](/manual/api#performing-requests):

```json
{
    "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:

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

[comment]: # ({/ed5d0499-b8348b8a})

[comment]: # ({6990c258-e4a57dd3})
#### Alterar o proprietário do dashboard

Disponível apenas para administradores e superadministradores.

[Requisição](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "dashboard.update",
    "params": {
        "dashboardid": "2",
        "userid": "1"
    },
    "id": 1
}
```

Resposta:

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

[comment]: # ({/6990c258-e4a57dd3})

[comment]: # ({9c4ba6ce-299ae089})
### Veja também

-   [Página do dashboard](object#dashboard-page)
-   [Widget do dashboard](object#dashboard-widget)
-   [Campo do widget do dashboard](object#dashboard-widget-field)
-   [Usuário do dashboard](object#dashboard-user)
-   [Grupo de usuários do dashboard](object#dashboard-user-group)

[comment]: # ({/9c4ba6ce-299ae089})

[comment]: # ({456ac32b-456ac32b})
### Fonte

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

[comment]: # ({/456ac32b-456ac32b})