Skip to main content
Version: 8.9 (unreleased)

Type Alias: ProcessInstanceModificationActivateInstruction

type ProcessInstanceModificationActivateInstruction = object;

Defined in: gen/types.gen.ts:5971

Instruction describing an element to activate.

Properties

ancestorElementInstanceKey?

optional ancestorElementInstanceKey: string | ElementInstanceKey;

Defined in: gen/types.gen.ts:5987

The key of the ancestor scope the element instance should be created in. Set to -1 to create the new element instance within an existing element instance of the flow scope. If multiple instances of the target element's flow scope exist, choose one specifically with this property by providing its key.


elementId

elementId: ElementId;

Defined in: gen/types.gen.ts:5975

The id of the element to activate.


variableInstructions?

optional variableInstructions: ModifyProcessInstanceVariableInstruction[];

Defined in: gen/types.gen.ts:5979

Instructions describing which variables to create or update.