Class DashboardApi

constructor

• new DashboardApi(
      baseUrl: string,
      handlers: IRequestHandler[],
      options?: IRequestOptions,
  ): DashboardApi

  Parameters

  • baseUrl: string
  • handlers: IRequestHandler[]
  • Optionaloptions: IRequestOptions

  Returns DashboardApi

Static ReadonlyRESOURCE_AREA_ID

createDashboard

• createDashboard(
      dashboard: Dashboard,
      teamContext: TeamContext,
  ): Promise<Dashboard>

  Create the supplied dashboard.

  Parameters

  • dashboard: Dashboard

    The initial state of the dashboard
  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<Dashboard>

createWidget

• createWidget(
      widget: Widget,
      teamContext: TeamContext,
      dashboardId: string,
  ): Promise<Widget>

  Create a widget on the specified dashboard.

  Parameters

  • widget: Widget

    State of the widget to add
  • teamContext: TeamContext

    The team context for the operation
  • dashboardId: string

    ID of dashboard the widget will be added to.

  Returns Promise<Widget>

deleteDashboard

• deleteDashboard(teamContext: TeamContext, dashboardId: string): Promise<void>

  Delete a dashboard given its ID. This also deletes the widgets associated with this dashboard.

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • dashboardId: string

    ID of the dashboard to delete.

  Returns Promise<void>

deleteWidget

• deleteWidget(
      teamContext: TeamContext,
      dashboardId: string,
      widgetId: string,
  ): Promise<Dashboard>

  Delete the specified widget.

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • dashboardId: string

    ID of the dashboard containing the widget.
  • widgetId: string

    ID of the widget to update.

  Returns Promise<Dashboard>

getDashboard

• getDashboard(teamContext: TeamContext, dashboardId: string): Promise<Dashboard>

  Get a dashboard by its ID.

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • dashboardId: string

  Returns Promise<Dashboard>

getDashboardsByProject

• getDashboardsByProject(teamContext: TeamContext): Promise<Dashboard[]>

  Get a list of dashboards under a project.

  Parameters

  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<Dashboard[]>

getWidget

• getWidget(
      teamContext: TeamContext,
      dashboardId: string,
      widgetId: string,
  ): Promise<Widget>

  Get the current state of the specified widget.

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • dashboardId: string

    ID of the dashboard containing the widget.
  • widgetId: string

    ID of the widget to read.

  Returns Promise<Widget>

getWidgetMetadata

• getWidgetMetadata(
      contributionId: string,
      project?: string,
  ): Promise<WidgetMetadataResponse>

  Get the widget metadata satisfying the specified contribution ID.

  Parameters

  • contributionId: string

    The ID of Contribution for the Widget
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WidgetMetadataResponse>

getWidgetTypes

• getWidgetTypes(
      scope: WidgetScope,
      project?: string,
  ): Promise<WidgetTypesResponse>

  Get all available widget metadata in alphabetical order, including widgets marked with isVisibleFromCatalog == false.

  Parameters

  • scope: WidgetScope
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WidgetTypesResponse>

replaceDashboard

• replaceDashboard(
      dashboard: Dashboard,
      teamContext: TeamContext,
      dashboardId: string,
  ): Promise<Dashboard>

  Replace configuration for the specified dashboard. Replaces Widget list on Dashboard, only if property is supplied.

  Parameters

  • dashboard: Dashboard

    The Configuration of the dashboard to replace.
  • teamContext: TeamContext

    The team context for the operation
  • dashboardId: string

    ID of the dashboard to replace.

  Returns Promise<Dashboard>

replaceDashboards

• replaceDashboards(
      group: DashboardGroup,
      teamContext: TeamContext,
  ): Promise<DashboardGroup>

  Update the name and position of dashboards in the supplied group, and remove omitted dashboards. Does not modify dashboard content.

  Parameters

  • group: DashboardGroup
  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<DashboardGroup>

replaceWidget

• replaceWidget(
      widget: Widget,
      teamContext: TeamContext,
      dashboardId: string,
      widgetId: string,
  ): Promise<Widget>

  Override the state of the specified widget.

  Parameters

  • widget: Widget

    State to be written for the widget.
  • teamContext: TeamContext

    The team context for the operation
  • dashboardId: string

    ID of the dashboard containing the widget.
  • widgetId: string

    ID of the widget to update.

  Returns Promise<Widget>

updateWidget

• updateWidget(
      widget: Widget,
      teamContext: TeamContext,
      dashboardId: string,
      widgetId: string,
  ): Promise<Widget>

  Perform a partial update of the specified widget.

  Parameters

  • widget: Widget

    Description of the widget changes to apply. All non-null fields will be replaced.
  • teamContext: TeamContext

    The team context for the operation
  • dashboardId: string

    ID of the dashboard containing the widget.
  • widgetId: string

    ID of the widget to update.

  Returns Promise<Widget>