Function MirthApiFactory

Returns {
    getMirthChannel(
        requestParameters: MirthApiGetMirthChannelRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<ChannelFullModel>;
    getMirthChannelMap(
        options?: AxiosRequestConfig,
    ): AxiosPromise<ChannelMapModel[]>;
    getMirthChannelMessage(
        requestParameters: MirthApiGetMirthChannelMessageRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<ChannelMessageModel>;
    getMirthChannelMessages(
        requestParameters: MirthApiGetMirthChannelMessagesRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<MessagePage>;
    getMirthChannels(
        options?: AxiosRequestConfig,
    ): AxiosPromise<ChannelFullModel[]>;
    getMirthGroups(
        options?: AxiosRequestConfig,
    ): AxiosPromise<ChannelGroupModel[]>;
}

• getMirthChannel: function

  • getMirthChannel(
        requestParameters: MirthApiGetMirthChannelRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<ChannelFullModel>

    Get details and statistics about a specific Mirth channel

    Parameters

    • requestParameters: MirthApiGetMirthChannelRequest

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ChannelFullModel>

    Throws

• getMirthChannelMap: function

  • getMirthChannelMap(
        options?: AxiosRequestConfig,
    ): AxiosPromise<ChannelMapModel[]>

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

    Parameters

    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ChannelMapModel[]>

    Throws

• getMirthChannelMessage: function

  • getMirthChannelMessage(
        requestParameters: MirthApiGetMirthChannelMessageRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<ChannelMessageModel>

    Retreive a specific message from a specific Mirth channel

    Parameters

    • requestParameters: MirthApiGetMirthChannelMessageRequest

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ChannelMessageModel>

    Throws

• getMirthChannelMessages: function

  • getMirthChannelMessages(
        requestParameters: MirthApiGetMirthChannelMessagesRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<MessagePage>

    Retreive a list a messages from a specific Mirth channel

    Parameters

    • requestParameters: MirthApiGetMirthChannelMessagesRequest

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<MessagePage>

    Throws

• getMirthChannels: function

  • getMirthChannels(options?: AxiosRequestConfig): AxiosPromise<ChannelFullModel[]>

    Retrieve a list of Mirth channels

    Parameters

    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ChannelFullModel[]>

    Throws

• getMirthGroups: function

  • getMirthGroups(options?: AxiosRequestConfig): AxiosPromise<ChannelGroupModel[]>

    Retrieve a list of Mirth channel groups

    Parameters

    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ChannelGroupModel[]>

    Throws