WFGetQueueProperty WFGetQueuePropertyThis call returns the specified queue properties. You can view the XML input and output parameters, which have to be passed for fetching properties. 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 |
|
QueueID * |
Root |
It is the queue id whose properties are to be fetched. |
NA |
|
DataFlag |
Root |
It is the data flag for fetching Report related data or not |
"Y" or "N" |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
It refers to the case sensitive call name. |
|
MainCode |
Exception |
Error code specified by WAPI. |
|
Name |
QueueInfo |
It is the name of the queue |
|
Type |
QueueInfo |
It is the type of the queue |
|
Comments |
QueueInfo |
It is the comment associated with the queue |
|
UserCount |
QueueInfo |
It is the number of users in the queue |
|
StreamCount |
QueueInfo |
It is the number of streams in the queue |
|
NoOfWorkitems |
QueueInfo |
It is the number of workitems in the queue |
|
NoOfActiveUsers |
QueueInfo |
It is the number of active members in the queue |
|
NoOfInActiveUsers |
QueueInfo |
It is the number of inactive members in the queue |
|
AllowReassignment |
QueueInfo |
It is the value for reassignment flag, |
|
OrderBy |
QueueInfo |
It is the sort order value for the queue. |
|
FilterValue |
QueueInfo |
It is the filter value for the queue. |
|
FilterOption |
QueueInfo |
It is the filter option for the queue. |
|
Id |
UserInfo |
it is the user id in the queue |
|
Name |
UserInfo |
it is the user name in the queue |
|
ID |
GroupInfo |
It is the group id in the queue |
|
Name |
GroupInfo |
It is the name of the group in the queue |
|
Activityid |
StreamInfo |
It is the activity id for the queue |
|
ProcessName |
StreamInfo |
It is the process name for the queue |
|
VersionNo |
StreamInfo |
It is the version number of the process |
|
ActivityName |
StreamInfo |
It is the activity name |
|
Definition |
StreamInfo |
It is the description of the stream |
|
Name |
StreamInfo |
It is the stream name |
|
Id |
StreamInfo |
It is the stream associated with the queue. |
|
ProcessDefId |
StreamInfo |
It is the process id for the queue. |
|
Code |
Constant Value |
Message |
|
11 |
WM_INVALID_SESSION_HANDLE |
Invalid session |
|
15 |
WM_INVALID_FILTER |
The requested filter is invalid. |