Skip to main content
Version: 8.9 (unreleased)

Type Alias: CreateProcessInstanceData

type CreateProcessInstanceData = object;

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

Properties​

body​

body:
  | {
  awaitCompletion?: boolean;
  fetchVariables?: string[];
  operationReference?: OperationReference;
  processDefinitionId: ProcessDefinitionId;
  processDefinitionVersion?: number;
  requestTimeout?: number;
  runtimeInstructions?: ProcessInstanceCreationRuntimeInstruction[];
  startInstructions?: ProcessInstanceCreationStartInstruction[];
  tags?: TagSet;
  tenantId?: TenantId;
  variables?: {
   [key: string]: unknown;
  };
}
  | {
  awaitCompletion?: boolean;
  fetchVariables?: string[];
  operationReference?: OperationReference;
  processDefinitionKey: ProcessDefinitionKey;
  processDefinitionVersion?: number;
  requestTimeout?: number;
  runtimeInstructions?: ProcessInstanceCreationRuntimeInstruction[];
  startInstructions?: ProcessInstanceCreationStartInstruction[];
  tags?: TagSet;
  tenantId?: TenantId;
  variables?: {
   [key: string]: unknown;
  };
};

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

Instructions for creating a process instance. The process definition can be specified either by id or by key.

Type Declaration​

{
  awaitCompletion?: boolean;
  fetchVariables?: string[];
  operationReference?: OperationReference;
  processDefinitionId: ProcessDefinitionId;
  processDefinitionVersion?: number;
  requestTimeout?: number;
  runtimeInstructions?: ProcessInstanceCreationRuntimeInstruction[];
  startInstructions?: ProcessInstanceCreationStartInstruction[];
  tags?: TagSet;
  tenantId?: TenantId;
  variables?: {
   [key: string]: unknown;
  };
}

awaitCompletion?​

optional awaitCompletion: boolean;

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[];

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;

processDefinitionId​

processDefinitionId: ProcessDefinitionId;

The BPMN process id of the process definition to start an instance of.

processDefinitionVersion?​

optional processDefinitionVersion: number;

The version of the process. By default, the latest version of the process is used.

requestTimeout?​

optional 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.

runtimeInstructions?​

optional runtimeInstructions: ProcessInstanceCreationRuntimeInstruction[];

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[];

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;

tenantId?​

optional tenantId: TenantId;

The tenant id of the process definition.

variables?​

optional variables: object;

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

Index Signature​
[key: string]: unknown
{
  awaitCompletion?: boolean;
  fetchVariables?: string[];
  operationReference?: OperationReference;
  processDefinitionKey: ProcessDefinitionKey;
  processDefinitionVersion?: number;
  requestTimeout?: number;
  runtimeInstructions?: ProcessInstanceCreationRuntimeInstruction[];
  startInstructions?: ProcessInstanceCreationStartInstruction[];
  tags?: TagSet;
  tenantId?: TenantId;
  variables?: {
   [key: string]: unknown;
  };
}

awaitCompletion?​

optional awaitCompletion: boolean;

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[];

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;

processDefinitionKey​

processDefinitionKey: ProcessDefinitionKey;

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

processDefinitionVersion?​

optional processDefinitionVersion: number;

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;

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[];

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[];

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;

tenantId?​

optional tenantId: TenantId;

The tenant id of the process definition.

variables?​

optional variables: object;

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

Index Signature​
[key: string]: unknown

path?​

optional path: never;

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

query?​

optional query: never;

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

url​

url: "/process-instances";

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