Class WorkItemsApi

WorkItemsApi - object-oriented interface

Hierarchy

BaseAPI
- WorkItemsApi

Index

Constructors

constructor

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

getWorkitem

getWorkitem(
requestParameters: WorkItemsApiGetWorkitemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<WorkItemExtendedSchema, any, {}>>
Retreive a particular work item from the EMPI
Parameters
- requestParameters: WorkItemsApiGetWorkitemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<WorkItemExtendedSchema, any, {}>>
Throws
- Defined in api.ts:13815

getWorkitemCollection

getWorkitemCollection(
requestParameters: WorkItemsApiGetWorkitemCollectionRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<WorkItemSchema[], any, {}>>
Retreive a list of other work items related to a particular work item
Parameters
- requestParameters: WorkItemsApiGetWorkitemCollectionRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<WorkItemSchema[], any, {}>>
Throws
- Defined in api.ts:13826

getWorkitemMessages

getWorkitemMessages(
requestParameters: WorkItemsApiGetWorkitemMessagesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PageMessageSchema, any, {}>>
Retreive a list of other work items related to a particular work item
Parameters
- requestParameters: WorkItemsApiGetWorkitemMessagesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PageMessageSchema, any, {}>>
Throws
- Defined in api.ts:13837

getWorkitemRelated

getWorkitemRelated(
requestParameters: WorkItemsApiGetWorkitemRelatedRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<WorkItemSchema[], any, {}>>
Retreive a list of other work items related to a particular work item
Parameters
- requestParameters: WorkItemsApiGetWorkitemRelatedRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<WorkItemSchema[], any, {}>>
Throws
- Defined in api.ts:13848

getWorkitems

getWorkitems(
requestParameters?: WorkItemsApiGetWorkitemsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PageWorkItemSchema, any, {}>>
Retreive a list of open work items from the EMPI
Parameters
- requestParameters: WorkItemsApiGetWorkitemsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PageWorkItemSchema, any, {}>>
Throws
- Defined in api.ts:13859

postWorkitemClose

postWorkitemClose(
requestParameters: WorkItemsApiPostWorkitemCloseRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<MirthMessageResponseSchema, any, {}>>
Update and close a particular work item
Parameters
- requestParameters: WorkItemsApiPostWorkitemCloseRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MirthMessageResponseSchema, any, {}>>
Throws
- Defined in api.ts:13870

putWorkitemUpdate

putWorkitemUpdate(
requestParameters: WorkItemsApiPutWorkitemUpdateRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<MirthMessageResponseSchema, any, {}>>
Update a particular work item in the EMPI
Parameters
- requestParameters: WorkItemsApiPutWorkitemUpdateRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MirthMessageResponseSchema, any, {}>>
Throws
- Defined in api.ts:13881

Class WorkItemsApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WorkItemsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getWorkitem

Parameters

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

Throws

getWorkitemCollection

Parameters

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

Throws

getWorkitemMessages

Parameters

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

Throws

getWorkitemRelated

Parameters

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

Throws

getWorkitems

Parameters

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

Throws

postWorkitemClose

Parameters

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

Throws

putWorkitemUpdate

Parameters

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

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration