dashboard.update

Beschreibung

object dashboard.update(object/array dashboards)

Mit dieser Methode können vorhandene Dashboards aktualisiert werden.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object/array) Zu aktualisierende Dashboard-Eigenschaften.

Die Eigenschaft dashboardid muss für jedes Dashboard definiert sein, alle anderen Eigenschaften sind optional. Nur die übergebenen Eigenschaften werden aktualisiert, alle anderen bleiben unverändert.

Zusätzlich zu den Standard-Dashboard-Eigenschaften akzeptiert die Methode die folgenden Parameter.

Parameter Type Beschreibung
pages array 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 angegeben. Nur die angegebenen Eigenschaften der Dashboard-Seiten werden aktualisiert.
users array Dashboard-Benutzer Freigaben zum Ersetzen der vorhandenen Elemente.
userGroups array Dashboard-Benutzergruppen Freigaben zum Ersetzen der vorhandenen Elemente.

Rückgabewerte

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

Beispiele

Umbenennen eines Dashboards

Benennen Sie ein Dashboard in „SQL server status“ um.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "dashboard.update",
    "params": {
        "dashboardid": "2",
        "name": "SQL server status"
    },
    "id": 1
}

Antwort:

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

Dashboard-Seiten aktualisieren

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": "dashboard.update",
    "params": {
        "dashboardid": "2",
        "pages": [
            {
                "dashboard_pageid": 1,
                "name": "Umbenannte Seite"
            },
            {
                "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
}

Dashboard-Eigentümer ändern

Nur für Admins und Super-Admins verfügbar.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "dashboard.update",
    "params": {
        "dashboardid": "2",
        "userid": "1"
    },
    "id": 1
}

Antwort:

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

Siehe auch

Quelle

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