system.kanoa.dashboard.getFolders

Description

Gets dashboard folders based on the passed in parameters

Syntax

getFolders(paramsDict)

Parameters:

paramsDict (dict)

Returns:

dataset

Dictionary

Parameter	Type	Required	Notes
userId	int		returns folders that are public or private for a specific user.
dashboardId	int
folderId	int
parentId	int		id of the folder that is the parent folder
folderName	string
folderPath	string
enabled	boolean

Code Examples

# Example usage
folders = system.kanoa.dashboard.getFolders({'folderName': "Jason's Dashboards"})
print system.kanoa.utilities.convertDatasetRowToJSON(folders, 0)
> {
    'folderDescription': None, 
    'roles': None, 
    'icon': None, 
    'folderId': 4, 
    'parentId': None, '
    folderPath': u"Jason's Dashboards", 
    'path': u"Jason's Dashboards", '
    changedDate': None, 
    'createdDate': Sun Jul 14 23:44:01 UTC 2024, 
    'createdBy': 5, 
    'changedBy': None, 
    'sortOrder': None, 
    'iconColor': None, 
    'folderName': u"Jason's Dashboards"
  }