Interface CreateProcessInstanceResponse

interface CreateProcessInstanceResponse {
    bpmnProcessId: string;
    processDefinitionKey: string;
    processInstanceKey: string;
    tenantId: string;
    version: number;
}

Properties

bpmnProcessId processDefinitionKey processInstanceKey tenantId version

Properties

Readonly bpmnProcessId

bpmnProcessId: string

The BPMN process ID of the process definition

Readonly processDefinitionKey

processDefinitionKey: string

The unique key identifying the process definition (e.g. returned from a process in the DeployResourceResponse message)

Readonly processInstanceKey

processInstanceKey: string

Stringified JSON document that will instantiate the variables for the root variable scope of the process instance; it must be a JSON object, as variables will be mapped in a key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
valid argument, as the root of the JSON document is an array and not an object.

Readonly tenantId

tenantId: string

the tenant identifier of the created process instance

Readonly version

version: number

The version of the process; set to -1 to use the latest version

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc