Function MirthApiFp

Returns {
    getMirthChannel(
        channelId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelFullModel>,
    >;
    getMirthChannelMap(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelMapModel[]>,
    >;
    getMirthChannelMessage(
        channelId: string,
        messageId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelMessageModel>,
    >;
    getMirthChannelMessages(
        channelId: string,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessagePage>,
    >;
    getMirthChannels(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelFullModel[]>,
    >;
    getMirthGroups(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelGroupModel[]>,
    >;
}

• getMirthChannel: function

  • getMirthChannel(
        channelId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelFullModel>,
    >

    Get details and statistics about a specific Mirth channel

    Parameters

    • channelId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getMirthChannelMap: function

  • getMirthChannelMap(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelMapModel[]>,
    >

    Retrieve a basic channel ID-name map, available to all user permission levels. Used for things like message filtering.

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getMirthChannelMessage: function

  • getMirthChannelMessage(
        channelId: string,
        messageId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelMessageModel>,
    >

    Retreive a specific message from a specific Mirth channel

    Parameters

    • channelId: string
    • messageId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getMirthChannelMessages: function

  • getMirthChannelMessages(
        channelId: string,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessagePage>,
    >

    Retreive a list a messages from a specific Mirth channel

    Parameters

    • channelId: string
    • Optionalpage: number
    • Optionalsize: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getMirthChannels: function

  • getMirthChannels(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelFullModel[]>,
    >

    Retrieve a list of Mirth channels

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getMirthGroups: function

  • getMirthGroups(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelGroupModel[]>,
    >

    Retrieve a list of Mirth channel groups

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws