Delete Process Definition

API Type

Web Services

Description

Deletes the process definition and all of the process instances associated with the process definition. The process definition cannot be deleted if one or more process instances associated with the process definition is running or suspended. The function may take a long time to execute if there are many process instances associated with the process definition.

Syntax

public virtual void DeleteProcDef(string processTemplateID)

Parameters

Name Description

processTemplateID

Definition:
The unique identifier for the process definition to be checked out for modification.
Type
string
Allowed Values:
A valid process template ID

Output

None.

Example

IWFWorkflowService svc = GetWorkflowService();
          
string processTemplateID = ..// The unique identifier of the process definition to be deleted
svc.DeleteProcDef(processTemplateID);

Supported Versions

3.2.0.4 and higher