Update Process Definition

API Type

Web Services

Description

Updates a process definition without using version control. This method is intended for minor changes only, such as typographical errors. Warning: Changes made using this method circumvent version control, meaning changes are not tracked, and versions cannot be managed. Do not use this call for making any major changes to the process definition.

Syntax

public virtual string UpdateProcDef(string xml)

Parameters

Name	Type	Description
xml	Definition: Specifies a process definition in XML format. To generate the process definition file in XML format, in AgilePoint Envision, click File > Export & Import > Save As Deploying File(xml). You can also download the process definition XML from AgilePoint Enterprise Manager. Type string Allowed Values: A string that contains process definition in XML format.

Output

Returns the unique identifier for the process definition that is updated.

Example

// This is console application sample
IWFWorkflowService svc = GetWorkflowService();
string processDefinitionXML =..// see previous description of how to
get process definition XML          

try
	{
    //Update Process definition using updated process xml string
    string processDefinitionID = svc.UpdateProcDef(xml);
	}

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

Supported Versions

4.0.1 and higher