Interface CreateProcessInstanceRequest

interface CreateProcessInstanceRequest {
    bpmnProcessId: string;
    operationReference?: string;
    startInstructions: ProcessInstanceCreationStartInstruction[];
    tenantId?: string;
    variables: string;
    version?: number;
}

Hierarchy (view full)

Properties

bpmnProcessId operationReference? startInstructions tenantId? variables version?

Properties

bpmnProcessId

bpmnProcessId: string

the BPMN process ID of the process definition

Optional operationReference

operationReference?: string

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

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 tenant id of the process definition

variables

variables: string

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