WFSearchWorkItemList

This call search for the WorkItems based on Search criterion, you can also search across versions. 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.

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	Filter	It refers to the id of the process definition	NA
ProcessName	Filter	It refers to the process name for searching across versions.	NA
QueueName	Filter	It is the queue name for search. It is an optional field.	NA
ActivityId	Filter	It is the activity id for search It is an optional field.	NA
State	Filter	It is the process instance state for search. It is an optional field.	NA
Priority	Filter	It is the priority level for search. It is an optional field.	Normal Low High
DelayFlag	Filter	It is the flag for getting the instances which are in delay --- Y-Delayed, N-Not Delayed , B- Both	Y-Delayed, N-Not Delayed , B- Both
FixedAssignedToUser	Filter	It is the search field on fixed assigned user name.	NA
SystemAssignedToUser	Filter	It is the search on system assigned user.	NA
ProcessedByUser	Filter	It is search field for the user which processed the workitems.	NA
LockedByUser	Filter	It is the search on locked by user name	NA
AssignedToUser	Filter	It is the search on assigned users.	NA
CreatedDateRange	Filter	It is the search on creation date range for the process.	NA
IntroducedDateRange	Filter	It is the search on introduced date range for the process	NA
ValidTillDateRange	Filter	It is the search on expiry date range for the process	NA
IntroducedByUser	Filter	It is the search on user which has introduced the process.	NA
ExpiryDateRange	Filter	It is the search on creation date range for the process	NA
ProcessInstanceState	Filter	It is the process instance state for search.	Completed, Running, Suspended, Aborted, Not Started, Terminated
StateDateRange	Filter	It is the search on start date range for the process	NA
ProcessInstanceName	Filter	It is the process instance name	NA
ProcessedDateRange	Filter	It is the search on processed date range for the process	NA
DataFlag	Filter	It is the flag for the search on the associated data.	"Y" for yes and "N" for No.
Id	InterfaceInfo	It is the Id of the interface on which the search has to be performed.	NA
Name	InterfaceInfo	It is the name of the interface on which the search has to be performed.	NA
Status	InterfaceInfo	It is the status of the interface on which the search has to be performed.	NA
VarName	QueryInfo	It is the variable name on which the search has to be performed.	NA
VarValue	QueryInfo	It is the variable value on which the search has to be performed.	NA
Operator	QueryInfo	Condition operator	NA
JoinCondition	QueryInfo	joining operator, it can be AND OR	NA
SortOrder	BatchInfo	It is sorting order - Ascending or Descending	NA
OrderBy	BatchInfo	It is the field on which filter as to be done	PriorityLevel = 1 WorkItemName = 2 Activity_Name = 3 Locked_By_Name = 4 Introduced_By = 5 InstrumentStatus = 6 CheckListCompleteFlag = 7 LockStatus = 8 WorkItem_state = 9 EntryDateTime = 10 ValidTillDateTime = 11 LockedTime = 12 Introduction_DateTime = 13 QueueName=14 ProcessName=15 AssignedUser=16
LastValue	Workitem	It is the last value of the record retrieved.	NA
WorkitemID	Workitem	It is the workitem id for search	NA
ProcessInstanceId	Workitem	It is the process instance id for search	NA
NoOfRecordsToFetch	Root	It is the batch size	NA
SearchPreviousVersion	Root	Whether to search on previous versions of the process	Y- Yes N- No
SortOnVersion	Root	Whether to sort on previous versions of the Process	Y- Yes N- No
ReferBy	Root	Name of the Referred by user	NA
VarName	QueueData	It is the variable name on which the search has to be performed.	NA
VarValue	QueueData	It is the variable value on which the search has to be performed	NA
Operator	QueueData	Condition operator	NA
JoinCondition	QueueData	Joining operator, it can be AND OR	NA

Input Parameter description	View Sample InputXML
Output Parameter description	View Sample OutputXML
Errors and Warnings

Name	Parent Tag	Description
Option	Root	It refers to the case sensitive call name.
MainCode	Exception	Error code specified by WAPI.
RegistrationNo	WorkItemInfo	It is the registration number of the workitem.
QueueName	WorkItemInfo	It is the associated queue name with the workitem.
ProcessName	WorkItemInfo	It is the process name associated with the workitem
ProcessVersionNo	WorkItemInfo	It is the process version associated with the workitem
ActivityName	WorkItemInfo	It is the activity name associated with the workitem
Status	WorkItemInfo	It is the workitem status
CheckListStatus	WorkItemInfo	it is the checklist status for the workitem.
AssignedTo	WorkItemInfo	It is the assigned to user name.
PendingSince	WorkItemInfo	It is the date since which the workitem is pending.
ValidTill	WorkItemInfo	It is the date till which the workitem is valid
WorkItemId	WorkItemInfo	It is the workitem id
PriorityLevel	WorkItemInfo	It is the priority level set for the workitem.
ParentWorkItemId	WorkItemInfo	It is the parent workitem id
ProcessDefinitionId	WorkItemInfo	It is the process definition id associated with the workitem.
ActivityId	WorkItemInfo	It is the activity id associated with the workitem.
InstrumentStatus	WorkItemInfo	It is the workitem status.
LockStatus	WorkItemInfo	It is the lock status of the workitem.
LockedByUserName	WorkItemInfo	It is the user name which has locked the workitem.
CreatedByUserName	WorkItemInfo	it is the user name which has created workitem
CreationDateTime	WorkItemInfo	It is the creation date- time of the workitem.
LockedTime	WorkItemInfo	It is the lock time of the workitem.
IntroductionDateTime	WorkItemInfo	It is the introduction time of the workitem in the process
IntroducedBy	WorkItemInfo	It is the user name which has introduced the workitem.
AssignmentType	WorkItemInfo	It is the assignment type of the workitem.
Name	QueueData	it is the queue name associated with the workitem.
Value	QueueData	It is the queue value associated with the workitem.
TotalCount	Root	It is the total number of workitems after search.
RetrieveCount	Root	It is the number of workitems retrieved after search.
WorkItemState	Root	It is the Workitem state
ProcessInstanceState	Root	It is the Process Instance state
QueueType	Root	It is the Queue type
QueueId	Root	It is the index of the Queue
Turnaroundtime	Root	It is the Turnaround time for the Process Instance
Referredby	Root	It is the name of the user who referred the workitem
Referredto	Root	It is the name of the user to whom workitem is referred

Code	Constant Value	Message
400	WF_OPERATION_FAILED	The requested operation failed.

WMSearchWorkItems

Input Parameter description

Output Parameter description

Errors and Warnings