templatedashboard.update

Description

object templatedashboard.update(object/array templateDashboards)

This method allows to update existing template dashboards.

This method is only available to Admin and Super admin user types. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object/array) Template dashbaord properties to be updated.

The dashboardid property must be defined for each dashboard, all other properties are optional. Only the passed properties will be updated, all others will remain unchanged.

Additionally to the standard template dashboard properties, the method accepts the following parameters.

Parameter	Type	Description
widgets	object/array	Template dashboard widgets to replace existing widgets. Widgets are updated by `widgetid` property. Widgets without `widgetid` property will be created.

Return values

(object) Returns an object containing the IDs of the updated template dashboards under the dashboardids property.

Examples

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
       }

Source

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

Documentation