Class WorkItemsApi

WorkItemsApi - object-oriented interface

Export

WorkItemsApi

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:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration

Methods

getWorkitem

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

getWorkitemCollection

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

getWorkitemMessages

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

getWorkitemRelated

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

getWorkitems

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

postWorkitemClose

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

putWorkitemUpdate

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

Class WorkItemsApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WorkItemsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getWorkitem

Parameters

Returns Promise<AxiosResponse<WorkItemExtendedSchema, any>>

Throws

Memberof

getWorkitemCollection

Parameters

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

Throws

Memberof

getWorkitemMessages

Parameters

Returns Promise<AxiosResponse<PageMessageSchema, any>>

Throws

Memberof

getWorkitemRelated

Parameters

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

Throws

Memberof

getWorkitems

Parameters

Returns Promise<AxiosResponse<PageWorkItemSchema, any>>

Throws

Memberof

postWorkitemClose

Parameters

Returns Promise<AxiosResponse<MirthMessageResponseSchema, any>>

Throws

Memberof

putWorkitemUpdate

Parameters

Returns Promise<AxiosResponse<MirthMessageResponseSchema, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration