Query Archived Process Instances

API Type

Web Services

Description

Retrieves process instances that match a SQL query.

Syntax

public virtual WFBaseProcessInstance[] QueryArchivedProcInsts(string sqlWhereClause)

Parameters

Name Description

sqlWhereClause
Function:
The where clause of the SQL statement you want to query.
Type
string
Accepted Values:
The where clause of a SQL statement.

Output

An array of WFBaseProcessInstance objects.

Example

// Build SQL Statement
string processDefinitionName = "Budget Request Approval Process";
string sqlWhereClause = string.Format("DEF_NAME ='{0}'",
processDefinitionName);

try
	{
    WFBaseProcessInstance[] archivedProcessInstances =
    svc.QueryArchivedProcInsts(sqlWhereClause)
	}

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.