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