Function AdminApiFp

Returns {
    getAdminCounts(
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AdminCountsSchema>,
    >;
    getDatahealthMultipleUkrdcids(
        page?: number,
        size?: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMultipleUKRDCIDGroup>,
    >;
    getDatahealthMultipleUkrdcidsLastRun(
        options?: AxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<LastRunTime>,
    >;
    getFullErrorsHistory(
        since?: string,
        until?: string,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<HistoryPoint[]>,
    >;
    getFullWorkitemHistory(
        since?: string,
        until?: string,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<HistoryPoint[]>,
    >;
    getRecordWorkitemCounts(
        sortBy?: WorkItemGroupSorterEnum,
        orderBy?: OrderBy,
        page?: number,
        size?: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageWorkItemGroup>,
    >;
}

• getAdminCounts: function

  • getAdminCounts(
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AdminCountsSchema>,
    >

    Retreive basic counts across the UKRDC

    Parameters

    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AdminCountsSchema>,
    >

    Throws

• getDatahealthMultipleUkrdcids: function

  • getDatahealthMultipleUkrdcids(
        page?: number,
        size?: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMultipleUKRDCIDGroup>,
    >

    Retreive list of patients with multiple UKRDC IDs

    Parameters

    • Optionalpage: number
    • Optionalsize: number
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMultipleUKRDCIDGroup>,
    >

    Throws

• getDatahealthMultipleUkrdcidsLastRun: function

  • getDatahealthMultipleUkrdcidsLastRun(
        options?: AxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<LastRunTime>,
    >

    Retreive the datetime the multiple_ukrdcid table was fully refreshed

    Parameters

    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LastRunTime>>

    Throws

• getFullErrorsHistory: function

  • getFullErrorsHistory(
        since?: string,
        until?: string,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<HistoryPoint[]>,
    >

    Retreive basic statistics about recent records

    Parameters

    • Optionalsince: string
    • Optionaluntil: string
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<HistoryPoint[]>,
    >

    Throws

• getFullWorkitemHistory: function

  • getFullWorkitemHistory(
        since?: string,
        until?: string,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<HistoryPoint[]>,
    >

    Retreive basic statistics about recent records

    Parameters

    • Optionalsince: string
    • Optionaluntil: string
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<HistoryPoint[]>,
    >

    Throws

• getRecordWorkitemCounts: function

  • getRecordWorkitemCounts(
        sortBy?: WorkItemGroupSorterEnum,
        orderBy?: OrderBy,
        page?: number,
        size?: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageWorkItemGroup>,
    >

    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

    • OptionalsortBy: WorkItemGroupSorterEnum
    • OptionalorderBy: OrderBy
    • Optionalpage: number
    • Optionalsize: number
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageWorkItemGroup>,
    >

    Throws