Start Process Instance

API Type

Web Services

Description

Starts a process instance that is not set to start immediately on creation. This method is obsolete.

Syntax

public virtual WFEvent StartProcInst(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

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

None.

Supported Versions

3.2.0.4 and higher