Class ReportRunsApi

ReportRunsApi - object-oriented interface

Export

Hierarchy

BaseAPI
- ReportRunsApi

Index

Constructors

Properties

axios basePath configuration

Methods

createReportRun getReportRun listReportRuns

Constructors

constructor

new ReportRunsApi(configuration?, basePath?, axios?): ReportRunsApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ReportRunsApi
Inherited from BaseAPI.constructor
- Defined in base.ts:56

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

createReportRun

createReportRun(requestParameters, options?): Promise<AxiosResponse<ReportRun, any>>
Creates a Report Run.

Summary
Create a Report Run

Throws

Memberof
ReportRunsApi
Parameters
- requestParameters: ReportRunsApiCreateReportRunRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<ReportRun, any>>
- Defined in api/report-runs-api.ts:411

getReportRun

getReportRun(requestParameters, options?): Promise<AxiosResponse<ReportRun, any>>
Retrieves the details of an existing Report Run.

Summary
Get a Report Run

Throws

Memberof
ReportRunsApi
Parameters
- requestParameters: ReportRunsApiGetReportRunRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<ReportRun, any>>
- Defined in api/report-runs-api.ts:423

listReportRuns

listReportRuns(requestParameters, options?): Promise<AxiosResponse<ListReportRuns200Response, any>>
Returns a list of Report Runs. The Report Runs are sorted with the most recently created appearing first.

Summary
List all Report Runs

Throws

Memberof
ReportRunsApi
Parameters
- requestParameters: ReportRunsApiListReportRunsRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<ListReportRuns200Response, any>>
- Defined in api/report-runs-api.ts:435

Generated using TypeDoc