[comment]: # ({6d5ea9cd-6d5ea9cd})
# templatedashboard.update

[comment]: # ({/6d5ea9cd-6d5ea9cd})

[comment]: # ({e82cca7f-3db870df})
### 説明

`object templatedashboard.update(object/array templateDashboards)`

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

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

[comment]: # ({/e82cca7f-3db870df})

[comment]: # ({d6006aad-051bc982})
### パラメータ

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

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

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

|パラメータ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|pages|array|既存のダッシュボードページを置き換える[テンプレートダッシュボードページ](object#template-dashboard-page)。<br><br>ダッシュボードページは `dashboard_pageid` プロパティによって更新されます。`dashboard_pageid` プロパティを持たないオブジェクトについては新しいダッシュボードページが作成され、再利用されなかった既存のダッシュボードページは削除されます。ダッシュボードページは指定された順序と同じ順序で並べられます。ダッシュボードページの指定されたプロパティのみが更新されます。`pages` プロパティには少なくとも1つのダッシュボードページオブジェクトが必要です。|

[comment]: # ({/d6006aad-051bc982})

[comment]: # ({d8b2cba8-d8b2cba8})
### 戻り値

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

[comment]: # ({/d8b2cba8-d8b2cba8})

[comment]: # ({b41637d2-b41637d2})
### 例

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({7e85dec3-7b6290ef})
#### テンプレートダッシュボードの名前変更

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

[リクエスト](/manual/api#performing-requests):

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

レスポンス:

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

[comment]: # ({/7e85dec3-7b6290ef})

[comment]: # ({12c7c5a0-cf0dcd1e})
#### テンプレートダッシュボードページの更新

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

[リクエスト](/manual/api#performing-requests):

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

レスポンス:

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

[comment]: # ({/12c7c5a0-cf0dcd1e})

[comment]: # ({7b2285ce-24de180a})
### 関連項目

-   [テンプレートダッシュボードウィジェット](object#template-dashboard-widget)
-   [テンプレートダッシュボードウィジェット
    フィールド](object#template-dashboard-widget-field)

[comment]: # ({/7b2285ce-24de180a})

[comment]: # ({fb185432-fb185432})
### ソース

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

[comment]: # ({/fb185432-fb185432})