Archive Process Instance

API Type

Web Services

Description

Archives a process instance based on a specified process instance identifier by moving the set of process instance records from the current AgilePoint Database into the AgilePoint Archive Database. The process instance records and all of the associated data are then deleted from the AgilePoint Database. The process instance to be archived must be completed or canceled.

Syntax

public virtual void ArchiveProcInst(string processInstanceID)

Parameters

Name	Description
processInstanceID	Definition: Specifies the unique ID of a process instance. Type string Allowed Values: A valid process instance ID

Output

None.

Example

// this is console application sample
IWFWorkflowService svc = GetWorkflowService();
string processInstanceID = ..// the ID of process instance to be
     archived

try
    {
    svc.ArchiveProcInst(processInstanceID);
    }

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

Supported Versions

3.2.0.4 and higher