templatedashboard.update

Beschreibung

object templatedashboard.update(object/array templateDashboards)

Mit dieser Methode können vorhandene Vorlagen-Dashboards aktualisiert werden.

Diese Methode ist nur für die Benutzertypen Admin und Super admin verfügbar. Die Berechtigungen zum Aufrufen der Methode können in den Benutzerrolleneinstellungen entzogen werden. Weitere Informationen finden Sie unter User roles.

Parameter

(object/array) Zu aktualisierende Eigenschaften der Vorlagen-Dashboards.

Die Eigenschaft dashboardid muss für jedes Dashboard angegeben werden, alle anderen Eigenschaften sind optional. Nur die angegebenen Eigenschaften werden aktualisiert.

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

Parameter Type Beschreibung
pages array Vorlagen-Dashboard-Seiten zum Ersetzen der vorhandenen Dashboard-Seiten.

Dashboard-Seiten werden über die Eigenschaft dashboard_pageid aktualisiert. Neue Dashboard-Seiten werden für Objekte ohne die Eigenschaft dashboard_pageid erstellt, und vorhandene Dashboard-Seiten werden gelöscht, wenn sie nicht wiederverwendet werden. Dashboard-Seiten werden in derselben Reihenfolge angeordnet, wie sie angegeben sind. Nur die angegebenen Eigenschaften der Dashboard-Seiten werden aktualisiert. Für die Eigenschaft pages ist mindestens ein Dashboard-Seitenobjekt erforderlich.

Rückgabewerte

(object) Gibt ein Objekt zurück, das die IDs der aktualisierten Vorlage-Dashboards unter der Eigenschaft dashboardids enthält.

Beispiele

Umbenennen eines Vorlagen-Dashboards

Benennen Sie ein Vorlagen-Dashboard in „Performance graphs“ um.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "templatedashboard.update",
    "params": {
        "dashboardid": "23",
        "name": "Performance graphs"
    },
    "id": 1
}

Antwort:

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

Aktualisieren von Vorlagen-Dashboard-Seiten

Benennen Sie die erste Dashboard-Seite um, ersetzen Sie die Widgets auf der zweiten Dashboard-Seite und fügen Sie als dritte eine neue Seite hinzu. Löschen Sie alle anderen Dashboard-Seiten.

Anfrage:

{
    "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
}

Antwort:

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

Siehe auch

Quelle

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