Get Process Definition By Base Process Definition ID

API Type

Web Services

Description

Retrieves all versions of the process model (process definition) with the specified base process model ID.

Syntax

public virtual WFBaseProcessDefinition[] GetProcDefByBasePID(string baseprocessTemplateID)

Parameters

Name Description

baseprocessTemplateID

Function:
The ID of the base process definition.
Type
string
Accepted Values:
A valid base process definition ID.

Output

Array of WFBaseProcessDefinition objects.

Example

// This is console application
IWFWorkflowService svc = GetWorkflowService();

//Base process definition ID.
string baseprocessTemplateID = … // for example "1e3d514d43d3465cae6ec3bbbd409168";

try
	{
    //Returns Array of WFBaseProcessDefinition for all versions of
    process definition WFBaseProcessDefinition[] processDefinitions =
    svc.GetProcDefByBasePID(baseprocessTemplateID);
    for (int i = 0; i < processDefinitions.Length; i++)
	   {
       Console.WriteLine("Definition ID: '" + processDefinitions[i].DefID + "' ");
       Console.WriteLine("Definition Name: '" +
       processDefinitions[i].DefName + "' ");
	   }
	}

catch (Exception ex)
	{
    Console.WriteLine(ShUtil.GetSoapMessage(ex));
	}

Supported Versions

3.2.0.4 and higher

Code Examples in the API Documentation

The AgilePoint NX API documentation is intended as a basic reference to help you understand how to make API calls. API 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.