Class AdminApi

AdminApi - object-oriented interface

Export

AdminApi

Hierarchy

BaseAPI
- AdminApi

Index

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration

Methods

getAdminCounts

getAdminCounts(
options?: AxiosRequestConfig,
): Promise<AxiosResponse<AdminCountsSchema, any>>
Retreive basic counts across the UKRDC
Parameters
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AdminCountsSchema, any>>
Throws
Memberof
AdminApi
- Defined in api.ts:6881

getDatahealthMultipleUkrdcids

getDatahealthMultipleUkrdcids(
requestParameters?: AdminApiGetDatahealthMultipleUkrdcidsRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<PageMultipleUKRDCIDGroup, any>>
Retreive list of patients with multiple UKRDC IDs
Parameters
- requestParameters: AdminApiGetDatahealthMultipleUkrdcidsRequest = {}
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PageMultipleUKRDCIDGroup, any>>
Throws
Memberof
AdminApi
- Defined in api.ts:6893

getDatahealthMultipleUkrdcidsLastRun

getDatahealthMultipleUkrdcidsLastRun(
options?: AxiosRequestConfig,
): Promise<AxiosResponse<LastRunTime, any>>
Retreive the datetime the multiple_ukrdcid table was fully refreshed
Parameters
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LastRunTime, any>>
Throws
Memberof
AdminApi
- Defined in api.ts:6904

getFullErrorsHistory

getFullErrorsHistory(
requestParameters?: AdminApiGetFullErrorsHistoryRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<HistoryPoint[], any>>
Retreive basic statistics about recent records
Parameters
- requestParameters: AdminApiGetFullErrorsHistoryRequest = {}
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<HistoryPoint[], any>>
Throws
Memberof
AdminApi
- Defined in api.ts:6916

getFullWorkitemHistory

getFullWorkitemHistory(
requestParameters?: AdminApiGetFullWorkitemHistoryRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<HistoryPoint[], any>>
Retreive basic statistics about recent records
Parameters
- requestParameters: AdminApiGetFullWorkitemHistoryRequest = {}
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<HistoryPoint[], any>>
Throws
Memberof
AdminApi
- Defined in api.ts:6928

getRecordWorkitemCounts

getRecordWorkitemCounts(
requestParameters?: AdminApiGetRecordWorkitemCountsRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<PageWorkItemGroup, any>>
Retreive a list of all master records with open work items, and the number of work items on each. Most useful when sorted by descending work item count, to identify records most in need of work item resolution.
Parameters
- requestParameters: AdminApiGetRecordWorkitemCountsRequest = {}
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PageWorkItemGroup, any>>
Throws
Memberof
AdminApi
- Defined in api.ts:6940

Class AdminApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AdminApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getAdminCounts

Parameters

Returns Promise<AxiosResponse<AdminCountsSchema, any>>

Throws

Memberof

getDatahealthMultipleUkrdcids

Parameters

Returns Promise<AxiosResponse<PageMultipleUKRDCIDGroup, any>>

Throws

Memberof

getDatahealthMultipleUkrdcidsLastRun

Parameters

Returns Promise<AxiosResponse<LastRunTime, any>>

Throws

Memberof

getFullErrorsHistory

Parameters

Returns Promise<AxiosResponse<HistoryPoint[], any>>

Throws

Memberof

getFullWorkitemHistory

Parameters

Returns Promise<AxiosResponse<HistoryPoint[], any>>

Throws

Memberof

getRecordWorkitemCounts

Parameters

Returns Promise<AxiosResponse<PageWorkItemGroup, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration