Query Work List

API Type

Web Services

Description

Retrieves a list of human tasks (manual work items) using a a specified WHERE clause of an SQL query expression.

Good to Know

  • Only pass the WHERE clause without WHERE keyword, not the whole query.

Syntax

public virtual WFManualWorkItem[] QueryWorkList(WFQueryExpr expr)

Parameters

Name Description

expr

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

Output

An array of WFManualWorkItem objects that contain the work item data.

Example

IWFWorkflowService svc = GetWorkflowService();
WFAny any = WFAny.Create(WFManualWorkItem.ASSIGNED);
WFQueryExpr expr = new WFQueryExpr("WF_MANUAL_WORKITEM.STATUS",
SQLExpr.EQ, any, true);

try
	{
    WFManualWorkItem[] workItems = svc.QueryWorkList(expr);
    
    // Iterating through the list of the ManualWorkItem
    foreach (WFManualWorkItem workItem in workItems)
        {
        Console.WriteLine("{0}", workItem.ApplName);
        Console.WriteLine("{0}", workItem.AssignedDate);
        Console.WriteLine("{0}", workItem.DefName);
        Console.WriteLine("{0}", workItem.DueDate);
        }
	}

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

Supported Versions

3.2.0.4 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.