Function WorkItemsApiFp

Returns {
    getWorkitem(
        workitemId: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WorkItemExtendedSchema>,
    >;
    getWorkitemCollection(
        workitemId: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WorkItemSchema[]>,
    >;
    getWorkitemMessages(
        workitemId: number,
        facility?: string,
        since?: string,
        until?: string,
        status?: string[],
        page?: number,
        size?: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMessageSchema>,
    >;
    getWorkitemRelated(
        workitemId: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WorkItemSchema[]>,
    >;
    getWorkitems(
        since?: string,
        until?: string,
        status?: number[],
        facility?: string,
        sortBy?: WorkItemEnum,
        orderBy?: OrderBy,
        page?: number,
        size?: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageWorkItemSchema>,
    >;
    postWorkitemClose(
        workitemId: number,
        closeWorkItemRequest: CloseWorkItemRequest,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MirthMessageResponseSchema>,
    >;
    putWorkitemUpdate(
        workitemId: number,
        updateWorkItemRequest: UpdateWorkItemRequest,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MirthMessageResponseSchema>,
    >;
}

• getWorkitem: function

  • getWorkitem(
        workitemId: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WorkItemExtendedSchema>,
    >

    Retreive a particular work item from the EMPI

    Parameters

    • workitemId: number
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

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

    Throws

• getWorkitemCollection: function

  • getWorkitemCollection(
        workitemId: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WorkItemSchema[]>,
    >

    Retreive a list of other work items related to a particular work item

    Parameters

    • workitemId: number
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

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

    Throws

• getWorkitemMessages: function

  • getWorkitemMessages(
        workitemId: number,
        facility?: string,
        since?: string,
        until?: string,
        status?: string[],
        page?: number,
        size?: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMessageSchema>,
    >

    Retreive a list of other work items related to a particular work item

    Parameters

    • workitemId: number
    • Optionalfacility: string
    • Optionalsince: string
    • Optionaluntil: string
    • Optionalstatus: string[]
    • Optionalpage: number
    • Optionalsize: number
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

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

    Throws

• getWorkitemRelated: function

  • getWorkitemRelated(
        workitemId: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WorkItemSchema[]>,
    >

    Retreive a list of other work items related to a particular work item

    Parameters

    • workitemId: number
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

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

    Throws

• getWorkitems: function

  • getWorkitems(
        since?: string,
        until?: string,
        status?: number[],
        facility?: string,
        sortBy?: WorkItemEnum,
        orderBy?: OrderBy,
        page?: number,
        size?: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageWorkItemSchema>,
    >

    Retreive a list of open work items from the EMPI

    Parameters

    • Optionalsince: string
    • Optionaluntil: string
    • Optionalstatus: number[]
    • Optionalfacility: string
    • OptionalsortBy: WorkItemEnum
    • OptionalorderBy: OrderBy
    • Optionalpage: number
    • Optionalsize: number
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

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

    Throws

• postWorkitemClose: function

  • postWorkitemClose(
        workitemId: number,
        closeWorkItemRequest: CloseWorkItemRequest,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MirthMessageResponseSchema>,
    >

    Update and close a particular work item

    Parameters

    • workitemId: number
    • closeWorkItemRequest: CloseWorkItemRequest
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

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

    Throws

• putWorkitemUpdate: function

  • putWorkitemUpdate(
        workitemId: number,
        updateWorkItemRequest: UpdateWorkItemRequest,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MirthMessageResponseSchema>,
    >

    Update a particular work item in the EMPI

    Parameters

    • workitemId: number
    • updateWorkItemRequest: UpdateWorkItemRequest
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

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

    Throws