Class MirthApi

MirthApi - object-oriented interface

Hierarchy

BaseAPI
- MirthApi

Index

Constructors

constructor

new MirthApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): MirthApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns MirthApi
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

getMirthChannel

getMirthChannel(
requestParameters: MirthApiGetMirthChannelRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ChannelFullModel, any, {}>>
Get details and statistics about a specific Mirth channel
Parameters
- requestParameters: MirthApiGetMirthChannelRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ChannelFullModel, any, {}>>
Throws
- Defined in api.ts:8270

getMirthChannelMap

getMirthChannelMap(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ChannelMapModel[], any, {}>>
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<AxiosResponse<ChannelMapModel[], any, {}>>
Throws
- Defined in api.ts:8280

getMirthChannelMessage

getMirthChannelMessage(
requestParameters: MirthApiGetMirthChannelMessageRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ChannelMessageModel, any, {}>>
Retreive a specific message from a specific Mirth channel
Parameters
- requestParameters: MirthApiGetMirthChannelMessageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ChannelMessageModel, any, {}>>
Throws
- Defined in api.ts:8291

getMirthChannelMessages

getMirthChannelMessages(
requestParameters: MirthApiGetMirthChannelMessagesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<MessagePage, any, {}>>
Retreive a list a messages from a specific Mirth channel
Parameters
- requestParameters: MirthApiGetMirthChannelMessagesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MessagePage, any, {}>>
Throws
- Defined in api.ts:8302

getMirthChannels

getMirthChannels(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ChannelFullModel[], any, {}>>
Retrieve a list of Mirth channels
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ChannelFullModel[], any, {}>>
Throws
- Defined in api.ts:8312

getMirthGroups

getMirthGroups(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ChannelGroupModel[], any, {}>>
Retrieve a list of Mirth channel groups
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ChannelGroupModel[], any, {}>>
Throws
- Defined in api.ts:8322

Class MirthApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MirthApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getMirthChannel

Parameters

Returns Promise<AxiosResponse<ChannelFullModel, any, {}>>

Throws

getMirthChannelMap

Parameters

Returns Promise<AxiosResponse<ChannelMapModel[], any, {}>>

Throws

getMirthChannelMessage

Parameters

Returns Promise<AxiosResponse<ChannelMessageModel, any, {}>>

Throws

getMirthChannelMessages

Parameters

Returns Promise<AxiosResponse<MessagePage, any, {}>>

Throws

getMirthChannels

Parameters

Returns Promise<AxiosResponse<ChannelFullModel[], any, {}>>

Throws

getMirthGroups

Parameters

Returns Promise<AxiosResponse<ChannelGroupModel[], any, {}>>

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration