Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateProcessInstanceRequest

Hierarchy

  • CreateProcessInstanceRequest

Index

Properties

bpmnProcessId

bpmnProcessId: string

the BPMN process ID of the process definition

processDefinitionKey

processDefinitionKey: number

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

startInstructions

List of start instructions. If empty (default) the process instance will start at the start event. If non-empty the process instance will apply start instructions after it has been created

variables

variables: string

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.

version

version: number

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

Generated using TypeDoc