dashboard.update

Descrição

object dashboard.update(object/array dashboards)

Este método permite atualizar dashboards existentes.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.

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, o método aceita os seguintes parâmetros.

Parâmetro Tipo Descrição
pages array Páginas do dashboard para substituir as páginas existentes do dashboard.

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 para substituir os elementos existentes.
userGroups array Compartilhamentos de grupos de usuários do dashboard para substituir os elementos existentes.

Valores de retorno

(object) Retorna um objeto contendo os IDs dos dashboards atualizados na propriedade dashboardids.

Exemplos

Renomeando um dashboard

Renomeie um dashboard para "SQL server status".

Requisição:

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

Resposta:

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

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:

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

Alterar proprietário do dashboard

Disponível apenas para administradores e superadministradores.

Requisição:

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

Resposta:

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

Veja também

Fonte

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