ReportingRestClient class

Pakket:

azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen naar VSS REST API's

Uitbreiding

RestClientBase

Constructors

ReportingRestClient(IVssRestClientOptions)

Methoden

getAlertSummaryForOrg(FilterCriteria)	Waarschuwingsoverzicht ophalen op ernst voor de organisatie
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Ontvang gecombineerde meldingen voor de organisatie
getEnablementSummaryForOrg(EnablementFilterCriteria)	Krijg een samenvatting van Enablement voor de organisatie
getUXComputedFilters()

Constructordetails

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Methodedetails

getAlertSummaryForOrg(FilterCriteria)

Waarschuwingsoverzicht ophalen op ernst voor de organisatie

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

Parameters

criteria

FilterCriteria

Opties om het aantal teruggestuurde samenvattingen te beperken

Retouren

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Ontvang gecombineerde meldingen voor de organisatie

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

Parameters

criteria

CombinedAlertFilterCriteria

Opties om de gecombineerde meldingen te filteren

top

number

Het maximum aantal waarschuwingen dat moet worden geretourneerd

continuationToken

string

Als er meer waarschuwingen zijn dan kan worden geretourneerd, wordt een vervolgtoken in de header x-ms-continuationtoken geplaatst. Gebruik dit token hier om de volgende pagina met waarschuwingen op te halen

Retouren

Promise<PagedList<DashboardAlert>>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Krijg een samenvatting van Enablement voor de organisatie

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

Parameters

criteria

EnablementFilterCriteria

Opties om het aantal teruggestuurde samenvattingen te beperken

Retouren

Promise<OrgEnablementSummary>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Retouren

Promise<ReportingUXComputedFilters>