dashboard.update

Description

object dashboard.update(object/array dashboards)

This method allows to update existing dashboards.

This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object/array) Dashboard 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 dashboard properties, the method accepts the following parameters.

ParameterTypeDescription
pagesarrayDashboard pages to replace the existing dashboard pages.

Dashboard pages are updated by the dashboard_pageid property. New dashboard pages will be created for objects without dashboard_pageid property and the existing dashboard pages will be deleted if not reused. Dashboard pages will be ordered in the same order as specified. Only the specified properties of the dashboard pages will be updated.
usersarrayDashboard user shares to replace the existing elements.
userGroupsarrayDashboard user group shares to replace the existing elements.

Return values

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

Examples

Renaming a dashboard

Rename a dashboard to “SQL server status”.

Request:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "dashboard.update",
  4.            "params": {
  5.                "dashboardid": "2",
  6.                "name": "SQL server status"
  7.            },
  8.            "id": 1
  9.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "dashboardids": [
  5.                    "2"
  6.                ]
  7.            },
  8.            "id": 1
  9.        }

Updating dashboard pages

Rename the first dashboard page, replace widgets on the second dashboard page and add a new page as the third one. Delete all other dashboard pages.

Request:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "dashboard.update",
  4.            "params": {
  5.                "dashboardid": "2",
  6.                "pages": [
  7.                    {
  8.                        "dashboard_pageid": 1,
  9.                        "name": "Renamed Page"
  10.                    },
  11.                    {
  12.                        "dashboard_pageid": 2,
  13.                        "widgets": [
  14.                            {
  15.                                "type": "clock",
  16.                                "x": 0,
  17.                                "y": 0,
  18.                                "width": 4,
  19.                                "height": 3
  20.                            }
  21.                        ]
  22.                    },
  23.                    {
  24.                        "display_period": 60
  25.                    }
  26.                ]
  27.            },
  28.            "id": 1
  29.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "dashboardids": [
  5.                    "2"
  6.                ]
  7.            },
  8.            "id": 1
  9.        }

Change dashboard owner

Available only for admins and super admins.

Request:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "dashboard.update",
  4.            "params": {
  5.                "dashboardid": "2",
  6.                "userid": "1"
  7.            },
  8.            "id": 1
  9.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "dashboardids": [
  5.                    "2"
  6.                ]
  7.            },
  8.            "id": 1
  9.        }

See also

Source

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