ReportingRestClient class

Paquet:

azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS

Extends

RestClientBase

Constructeurs

ReportingRestClient(IVssRestClientOptions)

Méthodes

getAlertSummaryForOrg(FilterCriteria)	Obtenir un résumé des alertes par gravité pour l’organisation
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Obtenir des alertes combinées pour l’organisation
getEnablementSummaryForOrg(EnablementFilterCriteria)	Obtenir le résumé de l’activation pour l’organisation
getUXComputedFilters()

Détails du constructeur

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Paramètres

options

IVssRestClientOptions

Détails de la méthode

getAlertSummaryForOrg(FilterCriteria)

Obtenir un résumé des alertes par gravité pour l’organisation

function getAlertSummaryForOrg(criteria?: FilterCriteria): Promise<OrgAlertSummary>

Paramètres

criteria

FilterCriteria

Options pour limiter les résumés retournés

Retours

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Obtenir des alertes combinées pour l’organisation

function getCombinedAlertsForOrg(criteria?: CombinedAlertFilterCriteria, top?: number, continuationToken?: string): Promise<PagedList<DashboardAlert>>

Paramètres

criteria

CombinedAlertFilterCriteria

Options pour filtrer les alertes combinées renvoyées

top

number

Nombre maximal d’alertes à retourner

continuationToken

string

S’il existe plus d’alertes que possible, un jeton de continuation est placé dans l’en-tête « x-ms-continuationtoken ». Utilisez ce jeton ici pour obtenir la page suivante des alertes

Retours

Promise<PagedList<DashboardAlert>>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Obtenir le résumé de l’activation pour l’organisation

function getEnablementSummaryForOrg(criteria?: EnablementFilterCriteria): Promise<OrgEnablementSummary>

Paramètres

criteria

EnablementFilterCriteria

Options pour limiter les résumés retournés

Retours

Promise<OrgEnablementSummary>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Retours

Promise<ReportingUXComputedFilters>