Query Process Instances

API Type

Web Services

Description

Retrieves a list of process instances that match a specified query expression. The WFQueryExpr string is used to generate a query expression, and the client application specifies the query terms.

Syntax

public virtual WFBaseProcessInstance[] QueryProcInsts(WFQueryExpr expr)

Parameters

Name	Description
expr	Definition: Specifies the where clause of a SQL query expression. Type WFQueryExpr Allowed Values: A valid WFQueryExpr object.

Output

An array of WFBaseProcessInstance objects. It returns null if nothing matches to the query expression.

Example

IWFWorkflowService svc = GetWorkflowService();

// query all running process instance
string status = WFProcessInstance.RUNNING;
WFAny any = WFAny.Create(status);
WFQueryExpr expr = new WFQueryExpr("STATUS", SQLExpr.EQ, any, true);

try
	{
    // Calling the QueryProcInsts WebMethod, passing the expression as the argument.
    WFBaseProcessInstance[] result = svc.QueryProcInsts(expr);
 
    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