Documentation
Table of Contents
templatedashboard.update
Beschrijving
object templatedashboard.update(object/array templateDashboards)
Met deze methode kunnen bestaande sjabloon-dashboards worden bijgewerkt.
Deze methode is alleen beschikbaar voor gebruikerstypen Admin en Super admin. Machtigingen om de methode te gebruiken kunnen worden ingetrokken in de gebruikersrolinstellingen. Zie Gebruikersrollen voor meer informatie.
Parameters
(object/array) Sjabloondashboardeigenschappen die moeten worden bijgewerkt.
De eigenschap dashboardid moet worden opgegeven voor elk dashboard, alles andere eigenschappen zijn optioneel. Alleen de opgegeven eigenschappen worden bijgewerkt.
Naast het standaard sjabloondashboard eigenschappen, accepteert de methode het volgende: parameters.
| Parameter | Type | Beschrijving |
|---|---|---|
| pages | array | Sjabloondashboard pages om de bestaande dashboardpagina's te vervangen. Dashboardpagina's worden bijgewerkt door de eigenschap dashboard_pageid. Er worden nieuwe dashboardpagina's gemaakt voor objecten zonder eigenschap 'dashboard_pageid' en de bestaande dashboardpagina's worden verwijderd als ze niet opnieuw worden gebruikt. Dashboardpagina's worden in dezelfde volgorde geordend als opgegeven. Alleen de opgegeven eigenschappen van de dashboardpagina's worden bijgewerkt. Er is ten minste één dashboardpagina-object vereist voor de eigenschap pages. |
Retourwaarden
(object) Retourneert een object dat de ID's van de bijgewerkte sjabloon bevat dashboards onder de eigenschap dashboardids.
Voorbeelden
Naam wijzigen van een sjabloon-dashboard
Wijzig de naam van een sjabloon-dashboard naar "Prestatiegrafieken".
{
"jsonrpc": "2.0",
"method": "templatedashboard.update",
"params": {
"dashboardid": "23",
"name": "Prestatiegrafieken"
},
"id": 1
}Reactie:
Bijwerken van sjabloon-dashboardpagina's
Hernoem de eerste dashboardpagina, vervang widgets op de tweede dashboardpagina en voeg een nieuwe pagina toe als de derde. Verwijder alle andere dashboardpagina's.
{
"jsonrpc": "2.0",
"method": "templatedashboard.update",
"params": {
"dashboardid": "2",
"pages": [
{
"dashboard_pageid": 1,
"name": "Hernoemde Pagina"
},
{
"dashboard_pageid": 2,
"widgets": [
{
"type": "klok",
"x": 0,
"y": 0,
"width": 4,
"height": 3
}
]
},
{
"display_period": 60
}
]
},
"id": 1
}Reactie:
Zie ook
Bron
CTemplateDashboard::update() in ui/include/classes/api/services/CTemplateDashboard.php.