Update Process Instance

API Type

Web Services

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

Name	Description
processInstanceID	Function: Specifies the unique ID of a process instance. Type string Accepted Values: A valid process instance ID
attributes	Function: Name-value pairs associated with a custom ID. Type NameValue Accepted Values: A valid custom ID with an associated name.

Attributes

Name	Description
ProcInstName	The name of the process instance.
DueDate	The date that the process instance is expected to be complete
workObjectID	The ID of the work object.

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

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.