dashboard.create

Beschreibung

object dashboard.create(object/array dashboards)

Diese Methode ermöglicht es Ihnen, neue Dashboards zu erstellen.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigung zum Aufrufen der Methode kann in den Einstellungen der Benutzerrolle widerrufen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object/array) Zu erstellende Dashboards.

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

Parameter Type Beschreibung
pages array Für das Dashboard zu erstellende Dashboard-Seiten. Dashboard-Seiten werden in derselben Reihenfolge angeordnet, wie sie angegeben sind.

Parameterverhalten:
- erforderlich
users array Auf dem Dashboard zu erstellende Freigaben für Dashboard-Benutzer.
userGroups array Auf dem Dashboard zu erstellende Freigaben für Dashboard-Benutzergruppen.

Rückgabewerte

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

Beispiele

Erstellen eines Dashboards

Erstellen Sie ein Dashboard mit dem Namen „My dashboard“ mit einem Problems-Widget mit Tags und unter Verwendung von zwei Freigabetypen (Benutzergruppe und Benutzer) auf einer einzelnen Dashboard-Seite.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "problems",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 1,
                                "name": "tags.0.tag",
                                "value": "service"
                            },
                            {
                                "type": 0,
                                "name": "tags.0.operator",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "tags.0.value",
                                "value": "zabbix_server"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": "7",
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": "4",
                "permission": 3
            }
        ]
    },
    "id": 1
}

Antwort:

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

Siehe auch

Quelle

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