Cancel Activity Instance

API Type

Web Services

Description

Cancels a manual activity instance along with all manual work items associated with the specified manual activity instance ID. Note that an activity instance can be associated with one or more manual work items. Once the manual activity instance is canceled, the process instance will move forward to the next activity.

Syntax

public virtual WFEvent CancelActivityInst(string activityInstanceID)

Parameters

Name	Description
activityInstanceID	Definition: The unique ID for an activity instance. Type string Allowed Values: A valid activity instance ID.

Output

WFEvent object that provides the status of the transaction. The possible statuses are:

• Sent - Indicates event has been sent to engine for processing.
• Failed - Indicates event failed to process.
• Processed - Indicates event has been processed successfully.
• Canceled - Indicates event was canceled.
• Deferred - Indicates event does not need to be sent immediately.

Example

IWFWorkflowService svc = GetWorkflowService();
string activityInstanceID = …// activity instance needs to be
canceled.

try
    {
    WFEvent evt = svc.CancelActivityInst(activityInstanceID);
    }

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

Supported Versions

3.2.0.4 and higher