Query Process Instances

API Type

Web Services


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.


public virtual WFBaseProcessInstance[] QueryProcInsts(WFQueryExpr expr)


Name Description


Specifies the where clause of a SQL query expression.
Accepted Values:
A valid WFQueryExpr object.


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


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);

    // 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-->" +
            Console.WriteLine("DefName-->" + processInstance.DefName);
            Console.WriteLine("DefID-->" + processInstance.DefID);
            Console.WriteLine("CompletedDate-->" +
            Console.WriteLine("LastModifiedBy-->" +

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

Supported Versions and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.