dashboard.update

Opis

object dashboard.update(object/array dashboards)

Ta metoda umożliwia aktualizację istniejących pulpitów.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania tej metody mogą zostać cofnięte w ustawieniach ról użytkowników. Więcej informacji można znaleźć w User roles.

Parametry

(object/array) Właściwości dashboardu do zaktualizowania.

Właściwość dashboardid musi być zdefiniowana dla każdego dashboardu, wszystkie pozostałe właściwości są opcjonalne. Zaktualizowane zostaną tylko przekazane właściwości, wszystkie pozostałe pozostaną bez zmian.

Oprócz standardowych właściwości dashboardu, metoda akceptuje następujące parametry.

Parametr Typ Opis
pages array Strony dashboardu, które zastąpią istniejące strony dashboardu.

Strony dashboardu są aktualizowane za pomocą właściwości dashboard_pageid. Nowe strony dashboardu zostaną utworzone dla obiektów bez właściwości dashboard_pageid, a istniejące strony dashboardu zostaną usunięte, jeśli nie zostaną ponownie użyte. Strony dashboardu zostaną uporządkowane w tej samej kolejności, w jakiej zostały podane. Zaktualizowane zostaną tylko określone właściwości stron dashboardu.
users array Udostępnienia użytkownikom dashboardu, które zastąpią istniejące elementy.
userGroups array Udostępnienia grupom użytkowników dashboardu, które zastąpią istniejące elementy.

Zwracane wartości

(object) Zwraca obiekt zawierający identyfikatory zaktualizowanych pulpitów pod właściwością dashboardids.

Przykłady

Zmienianie nazwy pulpitu

Zmień nazwę pulpitu na „SQL server status”.

Żądanie:

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

Odpowiedź:

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

Aktualizowanie stron pulpitu

Zmień nazwę pierwszej strony pulpitu, zastąp widgety na drugiej stronie pulpitu i dodaj nową stronę jako trzecią. Usuń wszystkie pozostałe strony pulpitu.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "dashboard.update",
    "params": {
        "dashboardid": "2",
        "pages": [
            {
                "dashboard_pageid": 1,
                "name": "Strona o zmienionej nazwie"
            },
            {
                "dashboard_pageid": 2,
                "widgets": [
                    {
                        "type": "clock",
                        "x": 0,
                        "y": 0,
                        "width": 12,
                        "height": 3
                    }
                ]
            },
            {
                "display_period": 60
            }
        ]
    },
    "id": 1
}

Odpowiedź:

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

Zmień właściciela pulpitu

Dostępne tylko dla administratorów i super administratorów.

Żądanie:

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

Odpowiedź:

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

Zobacz także

Źródło

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