templatedashboard.create

Beschrijving

object templatedashboard.create(object/array templateDashboards)

Met deze methode kunt u nieuwe sjabloon-dashboards maken.

Deze methode is alleen beschikbaar voor gebruikers van het type Admin en Super admin. Rechten om de methode te gebruiken kunnen worden ingetrokken in de gebruikersrol-instellingen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Template dashboards om te maken.

Naast de standaard eigenschappen van sjabloon-dashboard, accepteert de methode de volgende parameters.

Parameter Type Beschrijving
pages array Sjabloon-dashboard pagina's om te maken voor het dashboard. Dashboardpagina's worden in dezelfde volgorde besteld als gespecificeerd.

Parametergedrag:
- verplicht

Retourwaarden

(object) Retourneert een object dat de ID's van de gemaakte sjabloon bevat dashboards onder de eigenschap dashboardids. De volgorde van de geretourneerde ID's komen overeen met de volgorde van de doorgegeven sjabloondashboards.

Voorbeelden

Het maken van een sjabloon-dashboard

Maak een sjabloon-dashboard met de naam "Grafieken" met één Grafiek-widget op een enkele dashboardpagina.

Request:

{
           "jsonrpc": "2.0",
           "method": "templatedashboard.create",
           "params": {
               "templateid": "10318",
               "name": "Grafieken",
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "graph",
                               "x": 0,
                               "y": 0,
                               "width": 12,
                               "height": 5,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 6,
                                       "name": "graphid",
                                       "value": "1123"
                                   }
                               ]
                           }
                       ]
       
                   }
               ]
           },
           "id": 1
       }

Response:

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

Zie ook

Bron

CTemplateDashboard::create() in ui/include/classes/api/services/CTemplateDashboard.php.