Home       Trees       Indices       Help   
Package cm_api :: Package endpoints :: Module dashboards
[hide private]
[frames] | no frames]

Module dashboards

source code

Classes [hide private]
  ApiDashboard
Functions [hide private]
 
_get_dashboard_path(dashboard_name) source code
 
create_dashboards(resource_root, dashboard_list)
Creates the list of dashboards.		 source code
 
get_dashboards(resource_root)
Returns the list of all dashboards.		 source code
 
get_dashboard(resource_root, dashboard_name)
Returns a dashboard definition for the specified name.		 source code
 
delete_dashboard(resource_root, dashboard_name)
Deletes a dashboard.		 source code
Variables [hide private]
  DASHBOARDS_PATH = '/timeseries/dashboards'
  __package__ = 'cm_api.endpoints'
Function Details [hide private]

create_dashboards(resource_root, dashboard_list)

source code 

Creates the list of dashboards. If any of the dashboards already exist this whole command will fail and no dashboards will be created.

Returns:
The list of dashboards created.

Since: API v6

get_dashboards(resource_root)

source code 

Returns the list of all dashboards.

Returns:
A list of API dashboard objects.

Since: API v6

get_dashboard(resource_root, dashboard_name)

source code 

Returns a dashboard definition for the specified name. This dashboard can be imported with the createDashboards API.

Returns:
An API dasbhboard object.

Since: API v6

delete_dashboard(resource_root, dashboard_name)

source code 

Deletes a dashboard.

Returns:
The deleted dashboard.

Since: API v6


   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Tue Jan 31 10:52:17 2017 http://epydoc.sourceforge.net