ReportingRestClient class

Paket:

azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:er

Sträcker sig

RestClientBase

Konstruktörer

ReportingRestClient(IVssRestClientOptions)

Metoder

getAlertSummaryForOrg(FilterCriteria)	Hämta aviseringssammanfattning efter allvarlighetsgrad för organisationen
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Få kombinerade varningar för organisationen
getEnablementSummaryForOrg(EnablementFilterCriteria)	Få sammanfattning av aktivering för organisationen
getUXComputedFilters()

Konstruktördetaljer

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Metoddetaljer

getAlertSummaryForOrg(FilterCriteria)

Hämta aviseringssammanfattning efter allvarlighetsgrad för organisationen

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

Parametrar

criteria

FilterCriteria

Alternativ för att begränsa de återkommande sammanfattningarna

Returnerar

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Få kombinerade varningar för organisationen

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

Parametrar

criteria

CombinedAlertFilterCriteria

Alternativ för att filtrera de kombinerade varningarna returnerades

top

number

Det maximala antalet aviseringar som ska returneras

continuationToken

string

Om det finns fler aviseringar än vad som kan returneras placeras en fortsättningstoken i rubriken "x-ms-continuationtoken". Använd den token här för att hämta nästa sida med aviseringar

Returnerar

Promise<PagedList<DashboardAlert>>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Få sammanfattning av aktivering för organisationen

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

Parametrar

criteria

EnablementFilterCriteria

Alternativ för att begränsa de återkommande sammanfattningarna

Returnerar

Promise<OrgEnablementSummary>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Returnerar

Promise<ReportingUXComputedFilters>