DashboardRestClient class

new DashboardRestClient(options: IVssRestClientOptions)

Paramètres

static RESOURCE_AREA_ID: string

Valeur de propriété

Créez le tableau de bord fourni.

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

Paramètres

Retours

Créez un widget sur le tableau de bord spécifié.

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

Paramètres

Retours

Supprimer un tableau de bord en fonction de son ID. Cela supprime également les widgets associés à ce tableau de bord.

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

Paramètres

Retours

Supprimez le widget spécifié.

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

Paramètres

Retours

Obtenez un tableau de bord par son ID.

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

Paramètres

Retours

Obtenez la liste des tableaux de bord d’un projet.

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

Paramètres

Retours

Obtenez l’état actuel du widget spécifié.

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

Paramètres

Retours

Obtenez les métadonnées du widget qui satisfont à l’ID de contribution spécifié.

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

Paramètres

Retours

Obtenez toutes les métadonnées de widget disponibles dans l’ordre alphabétique, y compris les widgets marqués avec isVisibleFromCatalog == false.

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

Paramètres

Retours

Remplacez la configuration du tableau de bord spécifié. Remplace la liste de widgets dans le tableau de bord, uniquement si la propriété est fournie.

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

Paramètres

Retours

Mettez à jour le nom et la position des tableaux de bord dans le groupe fourni, et supprimez les tableaux de bord omis. Ne modifie pas le contenu du tableau de bord.

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

Paramètres

Retours

Remplacez l’état du widget spécifié.

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

Paramètres

Retours

Effectuez une mise à jour partielle du widget spécifié.

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

Paramètres

Retours