ReportingRestClient class

Paquete:

azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends

RestClientBase

Constructores

ReportingRestClient(IVssRestClientOptions)

Métodos

getAlertSummaryForOrg(FilterCriteria)	Obtención del resumen de alertas por gravedad para la organización
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Obtener alertas combinadas para la organización
getEnablementSummaryForOrg(EnablementFilterCriteria)	Obtener el resumen de habilitación de la organización
getUXComputedFilters()

Detalles del constructor

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Parámetros

options

IVssRestClientOptions

Detalles del método

getAlertSummaryForOrg(FilterCriteria)

Obtención del resumen de alertas por gravedad para la organización

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

Parámetros

criteria

FilterCriteria

Opciones para limitar los resúmenes devueltos

Devoluciones

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Obtener alertas combinadas para la organización

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

Parámetros

criteria

CombinedAlertFilterCriteria

Se devolvieron las opciones para filtrar las alertas combinadas

top

number

Número máximo de alertas que se van a devolver

continuationToken

string

Si hay más alertas de las que se pueden devolver, se coloca un token de continuación en el encabezado "x-ms-continuationtoken". Use ese token aquí para obtener la siguiente página de alertas.

Devoluciones

Promise<PagedList<DashboardAlert>>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Obtener el resumen de habilitación de la organización

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

Parámetros

criteria

EnablementFilterCriteria

Opciones para limitar los resúmenes devueltos

Devoluciones

Promise<OrgEnablementSummary>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Devoluciones

Promise<ReportingUXComputedFilters>