templatedashboard.update

Opis

object templatedashboard.update(object/array templateDashboards)

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

Ta metoda jest dostępna tylko dla typów użytkowników Admin i Super admin. Uprawnienia do wywoływania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.

Parametry

(object/array) Właściwości pulpitu nawigacyjnego szablonu do zaktualizowania.

Właściwość dashboardid musi być określona dla każdego pulpitu nawigacyjnego, wszystkie pozostałe właściwości są opcjonalne. Zaktualizowane zostaną tylko określone właściwości.

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

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

Strony pulpitu nawigacyjnego są aktualizowane za pomocą właściwości dashboard_pageid. Nowe strony pulpitu nawigacyjnego zostaną utworzone dla obiektów bez właściwości dashboard_pageid, a istniejące strony pulpitu nawigacyjnego zostaną usunięte, jeśli nie zostaną ponownie użyte. Strony pulpitu nawigacyjnego zostaną uporządkowane w tej samej kolejności, w jakiej zostały określone. Zaktualizowane zostaną tylko określone właściwości stron pulpitu nawigacyjnego. Dla właściwości pages wymagany jest co najmniej jeden obiekt strony pulpitu nawigacyjnego.

Wartości zwracane

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

Przykłady

Zmiana nazwy dashboardu szablonu

Zmień nazwę dashboardu szablonu na „Performance graphs”.

Żądanie:

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

Odpowiedź:

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

Aktualizowanie stron pulpitu nawigacyjnego szablonu

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

Żądanie:

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

Odpowiedź:

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

Zobacz także

Źródło

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