WMGetWorkItem

This call returns the record of a specific work item. This command allows a workflow participant to designate which piece of work he wishes to do. The viewer may be selecting a work item from a list obtained by the WMOpenWorkList command. This command operates on a single work item basis. This command execution need not imply that the work item is reserved or locked.

You can view the XML input and output parameters, which have to be passed for getting the workitem details and displaying it. There is a list of errors and warning that can occur in the execution.

 

Input Parameter description

 View Sample InputXML

Output Parameter description

 View Sample OutputXML

Errors and Warnings

View Sample Code

 

Input Parameter description

* implies for the mandatory parameter.

Name

Parent Tag

Description

Valid Value

Option *

Root

It refers to the case sensitive call name.

case sensitive call name.

EngineName *

Root

It is the cabinet or database name, which has to be connected.

NA

SessionID *

Root

It is the logged in user session id

NA

ProcessInstanceId*

Root

It is the process instance id whose workitem has to be fetched.

NA

WorkItemId *

Root

It is the workitem id that has to be fetched.

NA

 

Output Parameter description

Name

Parent Tag

Description

Option

Root

It refers to the case sensitive call name.

MainCode

Exception

Error code specified by WAPI.

WorkitemID

Workitem

It is the Id of the workitem which is fetched.

WorkitemName

Workitem

It is the Name of the workitem which is fetched.

ActivityInstanceId

Workitem

It is the id of the activity instance associated with the work.

ProcessInstanceId

Workitem

It is the id of the process instance for the workitem.

PriorityLevel

Workitem

It is the priority defined for the workitem. It can be Normal, High or Low.

Participant

Participants

The users assigned for the workitem.

 

Errors and Warnings

Code

Constant Value

Message

11

WM_INVALID_SESSION_HANDLE

Invalid session

4

WM_INVALID_PROCESS_INSTANCE

The process instance ID was not valid.

6

WM_INVALID_WORKITEM

The work item ID was not valid.