templatedashboard.create

Beschreibung

object templatedashboard.create(object/array templateDashboards)

Mit dieser Methode können Sie neue Vorlagen-Dashboards erstellen.

Diese Methode ist nur für Benutzertypen vom Typ Admin und Super admin verfügbar. Die Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzer- rollen.

Parameter

(object/array) Zu erstellende Vorlagen-Dashboards.

Zusätzlich zu den Standard-Eigenschaften von Vorlagen-Dashboards akzeptiert die Methode die folgenden Parameter.

Parameter Type Beschreibung
pages array Zu erstellende Vorlagen-Dashboard-Seiten für das Dashboard. Die Dashboard-Seiten werden in derselben Reihenfolge angeordnet, wie sie angegeben sind.

Parameterverhalten:
- erforderlich

Rückgabewerte

(object) Gibt ein Objekt zurück, das die IDs der erstellten Vorlagen-Dashboards in der Eigenschaft dashboardids enthält. Die Reihenfolge der zurückgegebenen IDs entspricht der Reihenfolge der übergebenen Vorlagen-Dashboards.

Beispiele

Erstellen eines Vorlagen-Dashboards

Erstellen Sie ein Vorlagen-Dashboard mit dem Namen „Graphs“ mit einem Graph-Widget auf einer einzelnen Dashboard-Seite.

Anfrage:

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

            }
        ]
    },
    "id": 1
}

Antwort:

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

Siehe auch

Quelle

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