WFFetchInstrumentsListWFFetchInstrumentsListThis call fetches workitems for the login user. If Data Flag is set as "Y" then it fetches the queue data associated with the workitem.
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 to get the total number of workitems |
Y for Yes and N for No |
|
DataFlag |
Root |
It is the flag to include the data along with the workitems. |
Y for Yes and N for No |
|
Type |
Filter |
Type of the filter criteria specified. Filter type can be SQL string or an attribute. If you are filtering on attributes, then filter string contains the value of the attribute. 0-255 are reserved , if it is 256 than its SQL type filter. Then you Filter string will contains an SQL query. |
0-255 are reserved , if it is 256 than its SQL type filter. |
|
AttributeName |
Filter |
It is the name for attribute |
NA |
|
Comparison |
Filter |
It is operator for the filter |
1 for > ; 2 for >= ; 3 for =; 4 <> ; 5 for <; 6 for <=; 7 for like, 8 for not like. |
|
FilterString |
Filter |
It is string specified for the filtering |
NA |
|
Length |
Filter |
It is the length of attribute |
NA |
|
NoOfRecordsToFetch |
BatchInfo |
It is the batch size |
NA |
|
OrderBy |
BatchInfo |
It is the field on which filter as to be done |
NA |
|
SortOrder |
BatchInfo |
It is sorting order - Ascending or Descending |
NA |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
It refers to the case sensitive call name. |
|
MainCode |
Exception |
Error code specified by WAPI. |
|
ProcessInstanceId |
Instrument |
It is the process instance id. |
|
WorkItemName |
Instrument |
It is the workitem name. |
|
RouteId |
Instrument |
It is the route id for which the workitem is fetched, |
|
RouteName |
Instrument |
It is the route name for which the workitem is fetched. |
|
WorkStageId |
Instrument |
It is the workstage id on which the workitem is lying. |
|
ActivityName |
Instrument |
It is the activity name on which the workitem is lying |
|
PriorityLevel |
Instrument |
It is the priority level of the workitem |
|
InstrumentStatus |
Instrument |
It is the status of the workitem |
|
LockStatus |
Instrument |
It is the locked status-whether the workitem is locked or not |
|
CreatedByUserName |
Instrument |
It is the user name which has created worktiem |
|
CreationDateTime |
Instrument |
It is the creation date time |
|
WorkitemState |
Instrument |
It is the workitem state-whether enabled or disabled |
|
CheckListCompleteFlag |
Instrument |
It is the checklist complete flag for TO DO List applied on the workitem. |
|
EntryDateTime |
Instrument |
It is the entry date time for the workitem in the current workstep |
|
WorkItemId |
Instrument |
It is the workitem id |
|
QueueName |
Instrument |
It is the queue name on which the workitem is lying |
|
ProcessInstanceState |
Instrument |
It is the process instance state |
|
QueueType |
Instrument |
It is the queue type on which the workitem is lying. |
|
QueueId |
Instrument |
It is the queue id on which the workitem is lying |
|
Name |
QueueData |
Queue name on which the workitem is lying |
|
RetrievedCount |
Root |
It is the retrieved count for the workitems |
|
Count |
Root |
It is the total count for the workitems. |
|
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. |