system.kanoa.dashboard.updateDashboard

This function is part of the kanoaCore module

Description

Updates a dashboard.

Syntax

updateDashboard(dashboardInfo, userId)

Parameters

dashboardInfo (dict)

- dashboardId (int)

- dashboardName (string): The name of the dashboard. This must be unique within the folder.

- dashboardDescription (string): Some information about the dashboard.

- folderId (int): The id of the folder this dashboard is going into. Use None if the dashboard is going onto the root.

- private (boolean): Indicates if the dashboard is private or public. True for private, False for public

- iconPath (string): The path to the icon for this dashboard.

- iconColor (string): The color of the icon for this dashboard.

- roles ([string]): An array of roles that are able to view this dashboard.

- showOnMobile (boolean): Indicates if the dashboard should be shown on mobile devices.

- enabled (boolean)

- sortOrder (int): Determines where within the folder the dashboard is placed relative to other dashboards. If the same as another dashboard, then sorted by name.

int userId - User ID

Returns

int number of records modified

str msg - error message, None if successful

Code Examples

# Example usage
dashboardInfo = {
  "dashboardId": 4,
  "dashboardDescription": "Downtime By Asset",
  "dashboardName": "Asset Downtime",
  "enabled": True,
  "folderId": 1,
  "iconColor": "#AC5F00",
  "iconPath": "kanoa/maintenance",
  "private": False,
  "roles": None,
  "showOnMobile": false,
  "sortOrder": None
}
userId = 123
retVal, msg = system.kanoa.dashboard.updateDashboard(dashboard, userId)
if msg: system.perspective.sendMessage('showFailerToast', msg)
else: system.perspective.sendMessage('showSuccessfulToast', 'Dashboard has been updated')