Create a new Process Instance

POST /process-instances

Creates a new process instance. This does not await for the process instance to complete, i.e. it will be executed asynchronously.

application/json

Request Body required

A request to create a new process instance

• bpmnProcessId string

  BPMN process id of the process to instantiate

• processDefinitionKey int64

  Key of the process to instantiate

• variables

  Variables to instantiate the process with

Responses

• 200
• 503

---

successfully created

application/json

Schema

Schema

• data object

  A process instance

  processDefinitionKey int64

  Key of the process which this instance was created for

  bpmnProcessId string

  BPMN process id of the process which this instance was created for

  version integer

  Version of the process which this instance was created for

  processInstanceKey int64

  Unique key of the created process instance on the partition

• error string

Example (from schema)

{
  "data": {
    "processDefinitionKey": 0,
    "bpmnProcessId": "string",
    "version": 0,
    "processInstanceKey": 0
  },
  "error": "string"
}

Unable to connect to Zeebe cluster

Loading...