dashboard.update (atualização de dashboard)

Descrição

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

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

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 Para maiores informações.

Parâmetros

(object/array) Propriedades do painel a serem atualizadas.

A propriedade dashboardid deve ser especificada para cada painel, todos outras propriedades são opcionais. Somente as propriedades especificadas serão Atualizada.

Além das propriedades padrão do painel, o método aceita os seguintes parâmetros.

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

As páginas do painel são atualizadas pela propriedade dashboard_pageid. Novas páginas de painel serão criadas para objetos sem a propriedade dashboard_pageid e as páginas de painel existentes serão excluídas se não forem reutilizadas. As páginas do painel serão ordenadas na mesma ordem especificada. Somente as propriedades especificadas das páginas do painel serão atualizadas. Pelo menos um objeto de página do painel é necessário para a propriedade pages.
users array Dashboard user compartilha para substituir os elementos existentes.
userGroups array Dashboard grupo de usuários compartilha para substituir os elementos existentes.

Valores de retorno

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

Exemplos

Renomeando um painel

Renomeie um painel para "status do servidor SQL".

Solicitação:

{
    "jsonrpc": "2.0",
    "método": "dashboard.update",
    "parâmetros": {
        "dashboardid": "2",
        "name": "status do servidor SQL"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Resposta:

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

Atualizando páginas do painel

Renomeie a primeira página do painel, substitua os widgets no segundo painel página e adicione uma nova página como a terceira. Excluir todos os outros painéis Páginas.

Solicitação:

{
    "jsonrpc": "2.0",
    "método": "dashboard.update",
    "parâmetros": {
        "dashboardid": "2",
        "Páginas": [
            {
                "dashboard_pageid": 1,
                "name": 'Página renomeada'
            },
            {
                "dashboard_pageid": 2,
                "widgets": [
                    {
                        "tipo": "relógio",
                        "x": 0,
                        "y": 0,
                        "largura": 4,
                        "altura": 3
                    }
                ]
            },
            {
                "display_period": 60
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Resposta:

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

Alterar o proprietário do painel

Disponível apenas para administradores e superadministradores.

Solicitação:

{
    "jsonrpc": "2.0",
    "método": "dashboard.update",
    "parâmetros": {
        "dashboardid": "2",
        "userid": "1"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 2
}

Resposta:

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

Veja também

Fonte

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