Skip to main content
Version: 8.9

Type Alias: CreateProcessInstanceResult

type CreateProcessInstanceResult = object;

Properties​

businessId​

businessId: BusinessId | null;

Business id as provided on creation.

processDefinitionId​

processDefinitionId: ProcessDefinitionId;

The BPMN process id of the process definition which was used to create the process. instance

processDefinitionKey​

processDefinitionKey: ProcessDefinitionKey;

The key of the process definition which was used to create the process instance.

processDefinitionVersion​

processDefinitionVersion: number;

The version of the process definition which was used to create the process instance.

processInstanceKey​

processInstanceKey: ProcessInstanceKey;

The unique identifier of the created process instance; to be used wherever a request needs a process instance key (e.g. CancelProcessInstanceRequest).

tags​

tags: TagSet;

tenantId​

tenantId: TenantId;

The tenant id of the created process instance.

variables​

variables: object;

All the variables visible in the root scope.

Index Signature​

[key: string]: unknown