Table of Contents
templatedashboard.update
Descrição
object templatedashboard.update(object/array templateDashboards)
Este método permite atualizar dashboards de template existentes.
Este método está disponível apenas para os tipos de usuário Admin e Super admin. As permissões para chamar o método podem ser revogadas nas configurações de função de usuário. Consulte Funções de usuário para obter mais informações.
Parâmetros
(object/array) Propriedades do dashboard do template a serem atualizadas.
A propriedade dashboardid deve ser especificada para cada dashboard, todas as outras propriedades são opcionais. Somente as propriedades especificadas serão atualizadas.
Além das propriedades padrão do dashboard do template, o método aceita os seguintes parâmetros.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| pages | array | Páginas do dashboard do template para substituir as páginas do dashboard existentes. 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 do dashboard existentes 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. Pelo menos um objeto de página do dashboard é necessário para a propriedade pages. |
Valores de retorno
(object) Retorna um objeto contendo os IDs dos dashboards de template atualizados na propriedade dashboardids.
Exemplos
Renomeando um dashboard de template
Renomeie um dashboard de template para "Performance graphs".
{
"jsonrpc": "2.0",
"method": "templatedashboard.update",
"params": {
"dashboardid": "23",
"name": "Performance graphs"
},
"id": 1
}Resposta:
Atualizando páginas do dashboard do template
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.
{
"jsonrpc": "2.0",
"method": "templatedashboard.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:
Veja também
Fonte
CTemplateDashboard::update() em ui/include/classes/api/services/CTemplateDashboard.php.