@camunda8/sdk
    Preparing search index...

    Interface CreateProcessInstanceResponse

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

    Properties

    bpmnProcessId processDefinitionKey processInstanceKey tenantId version

    Properties

    bpmnProcessId: string

    The BPMN process ID of the process definition

    processDefinitionKey: string

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

    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.

    tenantId: string

    the tenant identifier of the created process instance

    version: number

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

    Settings

    Member Visibility

    On This Page

    Properties