ReportingRestClient class
Base class that should be used (derived from) to make requests to VSS REST apis
- Extends
Constructors
| Reporting |
Methods
| get |
Get Alert summary by severity for the org |
| get |
Get Combined Alerts for the org |
| get |
Get Enablement summary for the org |
| get |
Constructor Details
ReportingRestClient(IVssRestClientOptions)
Method Details
getAlertSummaryForOrg(FilterCriteria)
Get Alert summary by severity for the org
function getAlertSummaryForOrg(criteria?: FilterCriteria): Promise<OrgAlertSummary>Parameters
- criteria
- FilterCriteria
Options to limit the summaries returned
Returns
Promise<OrgAlertSummary>
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)
Get Combined Alerts for the org
function getCombinedAlertsForOrg(criteria?: CombinedAlertFilterCriteria, top?: number, continuationToken?: string): Promise<PagedList<DashboardAlert>>Parameters
- criteria
- CombinedAlertFilterCriteria
Options to filter the combined alerts returned
- top
-
number
The maximum number of alerts to return
- continuationToken
-
string
If there are more alerts than can be returned, a continuation token is placed in the "x-ms-continuationtoken" header. Use that token here to get the next page of alerts
Returns
Promise<PagedList<DashboardAlert>>
getEnablementSummaryForOrg(EnablementFilterCriteria)
Get Enablement summary for the org
function getEnablementSummaryForOrg(criteria?: EnablementFilterCriteria): Promise<OrgEnablementSummary>Parameters
- criteria
- EnablementFilterCriteria
Options to limit the summaries returned
Returns
Promise<OrgEnablementSummary>
getUXComputedFilters()
function getUXComputedFilters(): Promise<ReportingUXComputedFilters>Returns
Promise<ReportingUXComputedFilters>