ReportingRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST API služby VSS

Extends

RestClientBase

Konstruktory

ReportingRestClient(IVssRestClientOptions)

Metody

getAlertSummaryForOrg(FilterCriteria)	Získání souhrnu výstrah podle závažnosti pro organizaci
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Získání kombinovaných upozornění pro organizaci
getEnablementSummaryForOrg(EnablementFilterCriteria)	Získání souhrnu povolení pro organizaci
getUXComputedFilters()

Podrobnosti konstruktoru

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti metody

getAlertSummaryForOrg(FilterCriteria)

Získání souhrnu výstrah podle závažnosti pro organizaci

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

Parametry

criteria

FilterCriteria

Možnosti omezení počtu vrácených souhrnů

Návraty

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Získání kombinovaných upozornění pro organizaci

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

Parametry

criteria

CombinedAlertFilterCriteria

Možnosti filtrování kombinovaných vrácených upozornění

top

number

Maximální počet výstrah, které se mají vrátit

continuationToken

string

Pokud existuje více výstrah, než je možné vrátit, token pro pokračování se umístí do hlavičky x-ms-continuationtoken. Pomocí tohoto tokenu zde získáte další stránku upozornění.

Návraty

Promise<PagedList<DashboardAlert>>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Získání souhrnu povolení pro organizaci

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

Parametry

criteria

EnablementFilterCriteria

Možnosti omezení počtu vrácených souhrnů

Návraty

Promise<OrgEnablementSummary>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Návraty

Promise<ReportingUXComputedFilters>