ReportingRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends

RestClientBase

Конструкторы

ReportingRestClient(IVssRestClientOptions)

Методы

getAlertSummaryForOrg(FilterCriteria)	Получение сводки оповещений по серьезности для организации
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Получение объединенных оповещений для организации
getEnablementSummaryForOrg(EnablementFilterCriteria)	Получение сводки по включению для организации
getUXComputedFilters()

Сведения о конструкторе

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

Сведения о методе

getAlertSummaryForOrg(FilterCriteria)

Получение сводки оповещений по серьезности для организации

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

Параметры

criteria

FilterCriteria

Варианты ограничения возвращаемых резюме

Возвращаемое значение

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Получение объединенных оповещений для организации

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

Параметры

criteria

CombinedAlertFilterCriteria

Опции фильтрации объединённых оповещений возвращённых

top

number

Максимальное количество возвращаемых оповещений

continuationToken

string

Если есть больше оповещений, чем может быть возвращено, маркер продолжения помещается в заголовок x-ms-continuationtoken. Используйте этот маркер здесь, чтобы получить следующую страницу оповещений

Возвращаемое значение

Promise<PagedList<DashboardAlert>>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Получение сводки по включению для организации

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

Параметры

criteria

EnablementFilterCriteria

Варианты ограничения возвращаемых резюме

Возвращаемое значение

Promise<OrgEnablementSummary>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Возвращаемое значение

Promise<ReportingUXComputedFilters>