DashboardRestClient class

new DashboardRestClient(options: IVssRestClientOptions)

Parameters

static RESOURCE_AREA_ID: string

Property Value

Create the supplied dashboard.

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

Parameters

Returns

Create a widget on the specified dashboard.

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

Parameters

Returns

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

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

Parameters

Returns

Delete the specified widget.

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

Parameters

Returns

Get a dashboard by its ID.

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

Parameters

Returns

Get a list of dashboards under a project.

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

Parameters

Returns

Get the current state of the specified widget.

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

Parameters

Returns

Get the widget metadata satisfying the specified contribution ID.

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

Parameters

Returns

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

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

Parameters

Returns

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

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

Parameters

Returns

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

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

Parameters

Returns

Override the state of the specified widget.

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

Parameters

Returns

Perform a partial update of the specified widget.

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

Parameters

Returns