Get Process Definition Name and Version

API Type

Web Services

Description

Retrieves the name and version of the process model (process definition) with the specified process model ID.

Syntax

public virtual KeyValue GetProcDefNameVersion(string processTemplateID)

Parameters

Name Description

processTemplateID

Function:
The process definition ID for a released process definition.
Type
string
Accepted Values:
A valid process definition ID.

Output

KeyValue object, where Key contains process definition name and Value contains version.

Example

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

//process definition ID for a process.
string processTemplateID = … // for example "1e3d514d43d3465cae6ec3bbbd409168";

try
	{
    //Returns KeyValuepair, for example "process definition
    Name-process definition Version"
    KeyValue keyValue = _ svc.GetProcDefNameVersion(processTemplateID);
    Console.WriteLine("process definition Name: '" +
    keyValue.Key.Tostring() + "' ");
    Console.WriteLine("process definition Version: '" +
    keyValue.Value.Tostring() + "' ");
	}

catch (Exception ex)
	{
    Console.WriteLine( 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.