Update Process Instance

Description

Updates process attribute, such as process instance name, due date, work object info.

Good to Know

• The process attributes that can be updated are listed in the attribute table.
• To call this method, the API account user must have the access right, Initiate a Process.

Syntax

public void UpdateProcInst(string processInstanceID, NameValue[] attributes)

Parameters

Attributes

Output

None.

Example

// This is console application sample to update process instance name
IWFWorkflowService svc = GetWorkflowService();
string processInstanceID = … // process instance ID
string newProccessInstanceName = "[new process instance name]";
DateTime newDueDate = DateTime.Now.AddDays(7.0);

try
	{
    WFBaseProcessInstance inst = svc.GetProcInst(processInstanceID);
    NameValue[] attributes = new NameValue[]
        {
       new NameValue("ProcInstName", newProccessInstanceName),
       new NameValue("DueDate", newDueDate)),
        };
  
    // update process instance
    svc.UpdateProcInst(processInstanceID, attributes);

    // check if it has been updated.
    string processInstanceName =
    svc.GetProcInst(processInstanceID).ProcInstName;
    Console.WriteLine("New Process Instance Name= '{0}",
    processInstanceName);
	}

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

Supported Versions

3.2.0.4 and higher