DashboardRestClient class

new DashboardRestClient(options: IVssRestClientOptions)

Parâmetros

static RESOURCE_AREA_ID: string

Valor de Propriedade

Crie o dashboard fornecido.

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

Parâmetros

Devoluções

Crie um widget no dashboard especificado.

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

Parâmetros

Devoluções

Elimine um dashboard com o respetivo ID. Isto também elimina os widgets associados a este dashboard.

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

Parâmetros

Devoluções

Elimine o widget especificado.

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

Parâmetros

Devoluções

Obtenha um dashboard com o respetivo ID.

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

Parâmetros

Devoluções

Obtenha uma lista de dashboards num projeto.

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

Parâmetros

Devoluções

Obtenha o estado atual do widget especificado.

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

Parâmetros

Devoluções

Obtenha os metadados do widget que satisfazem o ID de contribuição especificado.

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

Parâmetros

Devoluções

Obtenha todos os metadados de widget disponíveis por ordem alfabética, incluindo widgets marcados com isVisibleFromCatalog == false.

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

Parâmetros

Devoluções

Substitua a configuração do dashboard especificado. Substitui a lista de Widget no Dashboard, apenas se a propriedade for fornecida.

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

Parâmetros

Devoluções

Atualize o nome e a posição dos dashboards no grupo fornecido e remova dashboards omitidos. Não modifica o conteúdo do dashboard.

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

Parâmetros

Devoluções

Substitua o estado do widget especificado.

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

Parâmetros

Devoluções

Efetue uma atualização parcial do widget especificado.

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

Parâmetros

Devoluções