Class AdminDataHealthApi

AdminDataHealthApi - object-oriented interface

Hierarchy

BaseAPI
- AdminDataHealthApi

Index

Constructors

Properties

axios basePath configuration

Methods

getDatahealthMultipleUkrdcids getDatahealthMultipleUkrdcidsLastRun getRecordWorkitemCounts

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration

Methods

getDatahealthMultipleUkrdcids

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

getDatahealthMultipleUkrdcidsLastRun

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

getRecordWorkitemCounts

getRecordWorkitemCounts(
requestParameters?: AdminDataHealthApiGetRecordWorkitemCountsRequest,
options?: RawAxiosRequestConfig,
): 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: AdminDataHealthApiGetRecordWorkitemCountsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PageWorkItemGroup, any, {}>>
Throws
- Defined in api.ts:3850