WMFetchWorkItems WMFetchWorkItemsThis call returns the list of workitems depending upon the filter criterion and the batch information. The fetch process is complete when the call returns the error WM_NO_MORE_DATA.
You can view the XML input and output parameters, which have to be passed for fetching the list and displaying it. There is a list of errors and warning that can occur in the execution.
* 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 |
|
CountFlag |
Root |
It is flag which specifies whether to fetch the total count or not |
"Y" for yes to fetch the total count. "N" for not fetching the total count |
|
NoOfRecordsToFetch |
BatchInfo |
It is the batch size for the process to be fetched. |
NA |
|
LastWorkItem |
BatchInfo |
It is the last workitem that has to be fetched. |
NA |
|
Priority |
Root |
It is the priority of the workitem. |
0-Low 1-Normal 2-High 3-Very High |
|
LastProcessInstance |
Root |
It is the process instance id of the last workitem in the list. |
NA |
|
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 that is fetched. |
|
WorkitemName |
Workitem |
It is the name of the workitem that is fetched. |
|
ActivityInstanceId |
Workitem |
It is the id of the activity instance that is fetched. |
|
ProcessInstanceId |
Workitem |
It is the id of the process instance that is fetched. |
|
PriorityLevel |
Workitem |
It can be High, Normal or Low. |
|
Participant |
Participants |
It is the user name who is working on the workitem. |
|
RetrievedCount |
Root |
It is the number of records retrieved. |
|
Count |
Root |
It is the total number of workitems. |
|
Code |
Constant Value |
Message |
|
11 |
WM_INVALID_SESSION_HANDLE |
Invalid session |
|
20 |
WM_INVALID_QUERY_HANDLE |
WM_INVALID_QUERY_HANDLE |
|
18 |
WM_NO_MORE_DATA. |
No more records |