templatedashboard.update

説明

object templatedashboard.update(object/array templateDashboards)

このメソッドは、既存のテンプレートダッシュボードを更新するためのものです。

このメソッドは管理者およびスーパ管理者ユーザータイプのみが利用できます。メソッドの呼び出し権限はユーザーロール設定で取り消すことができます。詳細はユーザーロールを参照してください。

パラメータ

(object/array) 更新するテンプレートダッシュボードのプロパティ。

各ダッシュボードに対して dashboardid プロパティを指定する必要があり、その他の プロパティはすべて任意です。指定されたプロパティのみが 更新されます。

また、このメソッドは標準のテンプレートダッシュボードの プロパティに加えて、以下の パラメータを受け付けます。

パラメータ 型 説明
pages array 既存のダッシュボードページを置き換えるテンプレートダッシュボードページ。

ダッシュボードページは dashboard_pageid プロパティによって更新されます。dashboard_pageid プロパティを持たないオブジェクトについては新しいダッシュボードページが作成され、再利用されなかった既存のダッシュボードページは削除されます。ダッシュボードページは指定された順序と同じ順序で並べられます。ダッシュボードページの指定されたプロパティのみが更新されます。pages プロパティには少なくとも1つのダッシュボードページオブジェクトが必要です。

戻り値

(object) dashboardids プロパティの下で更新されたテンプレート ダッシュボードの ID を含むオブジェクトを返します。

例

テンプレートダッシュボードの名前変更

テンプレートダッシュボードの名前を「Performance graphs」に変更します。

リクエスト:

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

レスポンス:

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

テンプレートダッシュボードページの更新

最初のダッシュボードページの名前を変更し、2番目のダッシュボードページのウィジェットを置き換え、3番目のページとして新しいページを追加します。他のすべてのダッシュボードページを削除します。

リクエスト:

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

レスポンス:

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

関連項目

ソース

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