Documentation
Table of Contents
templatedashboard.update
Descrição
object templatedashboard.update(object/array templateDashboards)
Este método permite atualizar templates de dashboards já existentes.
Disponível somente para os perfis Admin e Super admin. Permissões para utilizar o método podem ser revogadas nas propriedades do usuário. Veja User roles para mas informações.
Parâmetros
(object/array) Propriedades do painel do modelo a serem atualizadas.
A propriedade dashboardid deve ser especificada para cada painel, todas as outras propriedades são opcionais. Somente as propriedades especificadas serão atualizadas.
Além das propriedades do painel de modelo padrão, o método aceita os seguintes parâmetros.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| páginas | array | páginas de painel de modelo para substituir as páginas de 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. |
Retorno de valores
(object) Retorna um objeto contendo os IDs dos templates de dashboards atualizados na propriedade dashboardids.
Exemplos
Renomeando um template de dashboard
Renomeia um template de dashboard para "Performance graphs".
Requisição:
{
"jsonrpc": "2.0",
"method": "templatedashboard.update",
"params": {
"dashboardid": "23",
"name": "Performance graphs"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
Atualizando páginas de templates de dashboard
Renomeia a primeira página de dashboard, substituí widgets na segunda página de dashboard e adiciona uma terceira nova página. Deleta todos as outras páginas de dashboard.
Requisição:
{
"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": 4,
"height": 3
}
]
},
{
"display_period": 60
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
Veja também
Source
CTemplateDashboard::update() in ui/include/classes/api/services/CTemplateDashboard.php.