Class QualityApi

QualityApi - object-oriented interface

Export

Hierarchy

BaseAPI
- QualityApi

Index

Constructors

constructor

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

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

qualityCreateReport

qualityCreateReport(requestParameters?, options?): Promise<AxiosResponse<QualityReport, any>>
Parameters
- requestParameters: QualityApiQualityCreateReportRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<QualityReport, any>>

Summary
Creates a quality report asynchronously and allows to check request status

Throws

Memberof
QualityApi
- Defined in api-client/quality-api.ts:1156

qualityListConflicts

qualityListConflicts(requestParameters?, options?): Promise<AxiosResponse<PaginatedAnnotationConflictList, any>>
Parameters
- requestParameters: QualityApiQualityListConflictsRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedAnnotationConflictList, any>>

Summary
Method returns a paginated list of annotation conflicts

Throws

Memberof
QualityApi
- Defined in api-client/quality-api.ts:1168

qualityListReports

qualityListReports(requestParameters?, options?): Promise<AxiosResponse<PaginatedQualityReportList, any>>
Parameters
- requestParameters: QualityApiQualityListReportsRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedQualityReportList, any>>

Summary
Method returns a paginated list of quality reports

Throws

Memberof
QualityApi
- Defined in api-client/quality-api.ts:1180

qualityListSettings

qualityListSettings(requestParameters?, options?): Promise<AxiosResponse<PaginatedQualitySettingsList, any>>
Parameters
- requestParameters: QualityApiQualityListSettingsRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedQualitySettingsList, any>>

Summary
Method returns a paginated list of quality settings instances

Throws

Memberof
QualityApi
- Defined in api-client/quality-api.ts:1192

qualityPartialUpdateSettings

qualityPartialUpdateSettings(requestParameters, options?): Promise<AxiosResponse<QualitySettings, any>>
Parameters
- requestParameters: QualityApiQualityPartialUpdateSettingsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<QualitySettings, any>>

Summary
Methods does a partial update of chosen fields in the quality settings instance

Throws

Memberof
QualityApi
- Defined in api-client/quality-api.ts:1204

qualityRetrieveReport

qualityRetrieveReport(requestParameters, options?): Promise<AxiosResponse<QualityReport, any>>
Parameters
- requestParameters: QualityApiQualityRetrieveReportRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<QualityReport, any>>

Summary
Method returns details of a quality report

Throws

Memberof
QualityApi
- Defined in api-client/quality-api.ts:1216

qualityRetrieveReportData

qualityRetrieveReportData(requestParameters, options?): Promise<AxiosResponse<object, any>>
Parameters
- requestParameters: QualityApiQualityRetrieveReportDataRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<object, any>>

Summary
Retrieve full contents of the report in JSON format

Throws

Memberof
QualityApi
- Defined in api-client/quality-api.ts:1228

qualityRetrieveSettings

qualityRetrieveSettings(requestParameters, options?): Promise<AxiosResponse<QualitySettings, any>>
Parameters
- requestParameters: QualityApiQualityRetrieveSettingsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<QualitySettings, any>>

Summary
Method returns details of the quality settings instance

Throws

Memberof
QualityApi
- Defined in api-client/quality-api.ts:1240

Class QualityApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns QualityApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

qualityCreateReport

Parameters

requestParameters: QualityApiQualityCreateReportRequest = {}

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<QualityReport, any>>

Summary

Throws

Memberof

qualityListConflicts

Parameters

requestParameters: QualityApiQualityListConflictsRequest = {}

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<PaginatedAnnotationConflictList, any>>

Summary

Throws

Memberof

qualityListReports

Parameters

requestParameters: QualityApiQualityListReportsRequest = {}

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<PaginatedQualityReportList, any>>

Summary

Throws

Memberof

qualityListSettings

Parameters

requestParameters: QualityApiQualityListSettingsRequest = {}

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<PaginatedQualitySettingsList, any>>

Summary

Throws

Memberof

qualityPartialUpdateSettings

Parameters

requestParameters: QualityApiQualityPartialUpdateSettingsRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<QualitySettings, any>>

Summary

Throws

Memberof

qualityRetrieveReport

Parameters

requestParameters: QualityApiQualityRetrieveReportRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<QualityReport, any>>

Summary

Throws

Memberof

qualityRetrieveReportData

Parameters

requestParameters: QualityApiQualityRetrieveReportDataRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<object, any>>

Summary

Throws

Memberof

qualityRetrieveSettings

Parameters

requestParameters: QualityApiQualityRetrieveSettingsRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<QualitySettings, any>>

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>