WMFetchWorkitemStates WMFetchWorkitemStatesThis call returns all the states defined for the workitem. They can be Completed, Running, Not Started, Terminated, Aborted, Suspended and custom States.
You can view the XML input and output parameters, which have to be passed for fetching the workitem state. 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 count. "N" for not fetching the count. |
|
ProcessInstanceId * |
Root |
It refers to the id of the process instance. |
NA |
|
WorkItemId * |
Root |
It refers to the work item id whose states are to be fetched. |
NA |
|
NoOfRecordsToFetch |
BatchInfo |
It is the batch size for the workitem to be fetched. |
NA |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
It refers to the case sensitive call name. |
|
MainCode |
Exception |
Error code specified by WAPI. |
|
Count |
WorkItemStates |
It is the total count of the work item states. |
|
WorkItemState |
WorkItemStates |
It is the state which is fetched. |
|
RetrievedCount |
Root |
It is the number of the workitem state that is fetched. |
|
Code |
Constant Value |
Message |
Comment |
|
11 |
WM_INVALID_SESSION_HANDLE |
Invalid session |
|
|
12 |
WM_INVALID_QUERY_HANDLE |
WM_INVALID_QUERY_HANDLE. |
|
|
502 |
WM_INVALID_PROCESS_DEFINITION |
The process definition ID was not valid. |
|
|
8 |
WM_NO_MORE_DATA |
No more records. |
|