WFGetStateList

This call returns the list of states available. The states can be Completed, Running, Suspended, Aborted, Not Started, Terminated and custom defined states.

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.

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

Input Parameter description

* 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 is the process definition id.	NA
ActivityId *	Root	It is the activity id whose states are fetched.	NA
SortOrder	BatchInfo	It is the sorting order for fetching the list.	"A" for ascending and "D" for Descending
OrderBy	BatchInfo	It is the field on which the sorting has to be done.	Order by- 1- user index 2- user name 3- personal name 4- family name 5- mailed 6- count1 7- count2 8- count3
NoOfRecordsToFetch	BatchInfo	It is the batch size for the state list.	NA
LastValue	BatchInfo	It is the last element of the list which is fetched.	NA
LastIndex	BatchInfo	It is the id of the last element of the list which is fetched.	NA

Output Parameter description

Name	Parent Tag	Description
Option	Root	It refers to the case sensitive call name.
MainCode	Exception	Error code specified by WAPI.
Id	StateInfo	It is the id of the state which is fetched.
StateName	StateInfo	It is the name of the state which is fetched.
RetrievedCount	Root	It is the batch size for the states which are fetched.
TotalCount	Root	It is the total number of the states in the list.

Errors and Warnings

Code	Constant Value	Message
15	WM_INVALID_FILTER	The requested filter is invalid.