WMGetProcessList WMGetProcessListThis call returns the processes for the cabinet. 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 |
|
DataFlag |
Root |
It is flag which specifies whether to fetch the total count or not |
"Y" for yes and "N" for No. |
|
LatestVersionFlag |
Root |
In case of dataflag=’N’ returns the list of latest version processes |
"Y" or "N" |
|
QueueName |
Filter |
It is the queue name |
NA |
|
StateFlag |
Filter |
It is the process state. |
E- Enabled, D-Disabled or "B"- Both |
|
From |
DateRange |
It is the date from which the report has to be generated. |
NA |
|
To |
DateRange |
It is the date till which the report is generated. |
NA |
|
SortOrder |
BatchInfo |
It is the sort order for records |
"A"= ascending and "D" for Descending |
|
OrderBy |
BatchInfo |
It is the field on which the sorting has to be done. |
NA |
|
LastValue |
BatchInfo |
It is the last process value which is fetched. |
NA |
|
LastIndex |
BatchInfo |
It is the last process definition index which is fetched. |
NA |
|
NoOfRecordsToFetch |
BatchInfo |
It is the batch size for process. |
NA |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
It refers to the case sensitive call name. |
|
MainCode |
Exception |
Error code specified by WAPI. |
|
Name |
ProcessInfo |
It is the process name |
|
Version |
ProcessInfo |
It is the version of the process |
|
NoofInstances |
ProcessInfo |
It is the number of instances of the process |
|
NoOfInstancesCompleted |
ProcessInfo |
It is the number of completed instances. |
|
NoOfInstancesDiscarded |
ProcessInfo |
It is the number of instances which are discarded |
|
NoOfInstancesDelayed |
ProcessInfo |
It is the number of instances which are delayed. |
|
StateSince |
ProcessInfo |
It is the date/time since which the process is in the current state. |
|
State |
ProcessInfo |
It is the process instance state. Such as- Enable or Disable |
|
TotalCount |
Root |
It is the total number of records |
|
RetrievedCount |
Root |
It is the number of retrieved records. |
|
Code |
Constant Value |
Message |
|
11 |
WM_INVALID_SESSION_HANDLE |
Invalid session. |
|
4 |
WM_INVALID_PROCESS_INSTANCE |
The process instance ID was not valid. |
|
7 |
WM_INVALID_ATTRIBUTE |
The attribute was not valid. |