Skip to main content
Version: 8.9 (unreleased)

Type Alias: ProcessInstanceCreationInstructionByKey

type ProcessInstanceCreationInstructionByKey = object;

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

Process creation by key

Properties​

awaitCompletion?​

optional awaitCompletion: boolean;

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

Wait for the process instance to complete. If the process instance completion does not occur within the requestTimeout, the request will be closed. This can lead to a 504 response status. Disabled by default.

fetchVariables?​

optional fetchVariables: string[];

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

List of variables by name to be included in the response when awaitCompletion is set to true. If empty, all visible variables in the root scope will be returned.

operationReference?​

optional operationReference: OperationReference;

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

processDefinitionKey​

processDefinitionKey: ProcessDefinitionKey;

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

The unique key identifying the process definition, for example, returned for a process in the deploy resources endpoint.

processDefinitionVersion?​

optional processDefinitionVersion: number;

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

As the version is already identified by the processDefinitionKey, the value of this field is ignored. It's here for backwards-compatibility only as previous releases accepted it in request bodies.

requestTimeout?​

optional requestTimeout: number;

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

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.

runtimeInstructions?​

optional runtimeInstructions: ProcessInstanceCreationRuntimeInstruction[];

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

Runtime instructions (alpha). List of instructions that affect the runtime behavior of the process instance. Refer to specific instruction types for more details.

This parameter is an alpha feature and may be subject to change in future releases.

startInstructions?​

optional startInstructions: ProcessInstanceCreationStartInstruction[];

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

List of start instructions. By default, the process instance will start at the start event. If provided, the process instance will apply start instructions after it has been created.

tags?​

optional tags: TagSet;

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

tenantId?​

optional tenantId: TenantId;

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

The tenant id of the process definition.

variables?​

optional variables: object;

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

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

Index Signature​

[key: string]: unknown