Interface CreateProcessInstanceFromProcessDefinition<V>

interface CreateProcessInstanceFromProcessDefinition<V> {
    operationReference?: number | LosslessNumber;
    processDefinitionKey: string;
    requestTimeout?: number;
    startInstructions?: ProcessInstanceCreationStartInstruction[];
    tenantId?: string;
    variables: V;
    version?: number;
}

Type Parameters

Hierarchy (view full)

Properties

operationReference? processDefinitionKey requestTimeout? startInstructions? tenantId? variables version?

Properties

Optional operationReference

operationReference?: number | LosslessNumber

a reference key chosen by the user and will be part of all records resulted from this operation

processDefinitionKey

processDefinitionKey: string

the key of the process definition

Optional requestTimeout

requestTimeout?: number

Timeout (in ms) the request waits for the process to complete. By default or when set to 0, the generic request timeout configured in the cluster is applied.

Optional startInstructions

startInstructions?: ProcessInstanceCreationStartInstruction[]

List of start instructions. If empty (default) the process instance will start at the start event. If non-empty the process instance will apply start instructions after it has been created

Optional tenantId

tenantId?: string

The tenantId for a multi-tenant enabled cluster.

variables

variables: V

JSON document that will instantiate the variables for the root variable scope of the process instance.

Optional version

version?: number

the version of the process; if not specified it will use the latest version

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc