templatedashboard.update

Opis

object templatedashboard.update(object/array templateDashboards)

Metoda umożliwia aktualizację istniejących pulpitów szablonów.

Ta metoda jest dostępna tylko dla użytkowników typu Admin i Super admin.Uprawnienia do wywołania tej metody mogą zostać odebrane w ustawieniach roli użytkownika.Zobacz Role użytkowników aby uzyskać więcej informacji.

Parametry

(object/array) Właściwości pulpitów szablonów do zaktualizowania.

Właściwość dashboardid musi być określona dla każdego pulpitu, wszystkie inne właściwości są opcjonalne. Tylko określone właściwości zostaną zaktualizowane.

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

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

Aktualizowane są strony pulpitu za pomocą właściwości dashboard_pageid. Nowe strony pulpitu zostaną utworzone dla obiektów bez właściwości dashboard_pageid, a istniejące strony pulpitu zostaną usunięte, jeśli nie zostaną ponownie użyte. Strony pulpitu będą uporządkowane w takiej samej kolejności, jak określono. Tylko określone właściwości stron pulpitu zostaną zaktualizowane. Co najmniej jeden obiekt strony pulpitu jest wymagany dla właściwości pages.

Zwracane wartości

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

Przykłady

Zmiana nazwy pulpitu szablonu

Zmień nazwę pulpitu szablonu na "Performance graphs".

Zapytanie:

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

Odpowiedź:

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

Aktualizacja stron pulpitu szablonu

Zmień nazwę pierwszej strony pulpitu, zamień widżety na drugiej stronie pulpitu i dodaj nową stronę jako trzecią. Usuń wszystkie inne strony pulpitu.

Zapytanie:

{
    "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": 4,
                        "height": 3
                    }
                ]
            },
            {
                "display_period": 60
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Odpowiedź:

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

Zobacz także

Źródło

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