WMGetStreamList WMGetStreamListThis call returns the list of Activities defined for the process. You can view the XML input and output parameters, which have to be passed for fetching the list. 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 |
|
ProcessDefinitionID * |
Root |
It refers to the id of the process definition |
NA |
|
ActivityID * |
Root |
It is the activity id |
NA |
|
SortOrder |
BatchInfo |
It is the sort order, which can be ascending or descending |
"A"-ascending "D"-descending |
|
OrderBy |
BatchInfo |
It is the field on which the sorting has to be done. |
1=streamid 2=streamname 3=streamcondition |
|
LastValue |
BatchInfo |
It is the last value retrieved.. |
NA |
|
LastIndex |
BatchInfo |
It is the index of the last element retrieved. |
NA |
|
NoOfRecordsToFetch |
BatchInfo |
It is the batch size for streams. |
NA |
|
ActivityType |
Root |
It is the type of activity. |
NA |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
It refers to the case sensitive call name. |
|
MainCode |
Exception |
Error code specified by WAPI. |
|
ActivityId |
ActivityStreamList |
It is the activity id with which the stream is associated. |
|
ActivityName |
ActivityStreamList |
It is the activity name with which the stream is associated. |
|
Id |
StreamInfo |
It is the stream id |
|
Name |
StreamInfo |
It is the name of the stream |
|
Definition |
StreamInfo |
It is the stream description. |
|
QueueId |
QueueInfo |
Each stream has one queue. It is the queue id for the stream |
|
QueueName |
QueueInfo |
It is the queue name |
|
TotalCount |
Root |
It is the total number of the streams. |
|
RetrievedCount |
Root |
It is the number of streams retrieved. |
|
Code |
Constant Value |
Message |
|
18 |
WM_NO_MORE_DATA |
No more records |
|
11 |
WM_INVALID_SESSION_HANDLE |
Invalid session |
|
15 |
WM_INVALID_FILTER |
The requested filter is invalid. |