Query Process Instances (Extended Method)

API Type

Web Services

Description

Retrieves a list of process instances with a SQL query expression specified by the client application.

Syntax

public virtual WFBaseProcessInstance[] QueryProcInstsEx(string sqlWhereClause)

Parameters

Name	Description
sqlWhereClause	Definition: The where clause of the SQL statement you want to query. Type string Allowed Values: The where clause of a SQL statement.

Output

An array ofWFBaseProcessInstance objects. It returns null if nothing matches the SQL query expression.

Example

// Console application sample code to illustrate QueryProcInstsEx API.
IWFWorkflowService svc = GetWorkflowService();

// SQL Expression
string sqlWhereClause = "STATUS in ('Running','Canceled')";

try
	{
    //Calling QueryProcInstsEx WebMethod with sql query expression as argument.
    WFBaseProcessInstance[] result = svc.QueryProcInstsEx(where);
    
    if (result != null)
        {
        // Iterating through the list of the Process Instance
        foreach (WFBaseProcessInstance processInstance in result
            {
            //Displaying the Process Instance Details on Console.
            Console.WriteLine("ApplName-->" + processInstance.ApplName
            Console.WriteLine("DefName-->" + processInstance.DefName);
            Console.WriteLine("DefID-->" + processInstance.DefID);
            Console.WriteLine("CompletedDate-->" +
            processInstance.CompletedDate);
            Console.WriteLine("LastModifiedBy-->" +
            processInstance.LastModifiedBy);
            }
        }
	}

catch (Exception ex)
	{
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
	}

Supported Versions

3.2.0.4 and higher