Documentation
Table of Contents
templatedashboard.update
説明
object templatedashboard.update(object/array templateDashboards)
このメソッドで、既存のテンプレート ダッシュボードを更新できます。
このメソッドはAdminおよびSuper adminユーザータイプでのみ使用できます。 メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。 詳細についてはユーザーの役割を参照してください。
パラメータ
(object/array) 更新するテンプレート ダッシュボード プロパティ
ダッシュボードごとにdashboardidプロパティを指定する必要があります。すべてのプロパティはオプションです。 指定したプロパティのみが更新されます。
このメソッドは標準のテンプレート ダッシュボード プロパティ に加えて、次のパラメーターを受け入れます。
| パラメータ | タイプ | 説明 |
|---|---|---|
| pages | array | 既存のダッシュボード ページを置き換えるテンプレート ダッシュボード ページ。 ダッシュボード ページは dashboard_pageid プロパティによって更新されます。 dashboard_pageid プロパティがないオブジェクトに対しては新しいダッシュボード ページが作成され、既存のダッシュボード ページが再利用されない場合は削除されます。 ダッシュボード ページは、指定した順序で並べられます。 ダッシュボード ページの指定されたプロパティのみが更新されます。 pages プロパティには少なくとも 1 つのダッシュボード ページ オブジェクトが必要です。 |
戻り値
(object) dashboardids プロパティの下で更新されたテンプレート ダッシュボードの ID を含むオブジェクトを返します。
例
テンプレートダッシュボードの名前変更
テンプレートダッシュボードの名前を"Performance graphs"に変更します
Request:
{ "jsonrpc": "2.0", "method": "templatedashboard.update", "params": { "dashboardid": "23", "name": "Performance graphs" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Response:
テンプレート ダッシュボード ページの更新
最初のダッシュボード ページの名前を変更し、2 番目のダッシュボード ページのウィジェットを置き換え、3 番目のページとして新しいページを追加します。 他のすべてのダッシュボード ページを削除します。
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:
参照
ソース
CTemplateDashboard::update() in ui/include/classes/api/services/CTemplateDashboard.php.