templatedashboard.update

Leírás

object templatedashboard.update(object/array templateDashboards)

Ez a módszer lehetővé teszi a meglévő sablon-irányítópultok frissítését.

Ez a módszer csak az Admin és a Kiemelt rendszergazda számára érhető el felhasználói típusok. A metódus meghívására vonatkozó engedélyek felhasználói szerepkörben visszavonhatók beállítások. Lásd: User roles további információért.

Paraméterek

`(objektum/tömb) A sablon irányítópult tulajdonságait frissíteni kell.

A "dashboardid" tulajdonságot minden egyes irányítópulthoz meg kell adni a többi tulajdonság nem kötelező. Csak a megadott tulajdonságok lesznek frissítve.

A standard template dashboard property, a metódus elfogadja a következőket paramétereket.

Paraméter Típus Leírás
pages array Sablon irányítópult pages a meglévő irányítópult-oldalak lecseréléséhez.

Az irányítópult oldalait a dashboard_pageid tulajdonság frissíti. Új irányítópult-oldalak jönnek létre a „dashboard_pageid” tulajdonság nélküli objektumokhoz, és a meglévő irányítópult-oldalak törlődnek, ha nem használják őket újra. Az irányítópult oldalai a megadott sorrendben lesznek rendezve. Csak az irányítópult-oldalak megadott tulajdonságai frissülnek. Legalább egy irányítópult-oldalobjektum szükséges a pages tulajdonsághoz.

Visszatérési értékek

(object) A frissített sablon azonosítóit tartalmazó objektumot ad vissza irányítópultok a "dashboardids" tulajdonság alatt.

Példák

Renaming a template dashboard

Rename a template dashboard to "Performance graphs".

Request:

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

Response:

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

Updating template dashboard pages

Rename the first dashboard page, replace widgets on the second dashboard page and add a new page as the third one. Delete all other dashboard pages.

Request:

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

Response:

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

Lásd még

Forrás

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