Zeebe · JSON Structure

Zeebe Api Create Process Instance Request Structure

CreateProcessInstanceRequest schema from Zeebe REST API

Type: object Properties: 5
BPMNCamundaCloud NativeDistributed SystemsJavaMicroservicesProcess AutomationWorkflow Orchestration

CreateProcessInstanceRequest is a JSON Structure definition published by Zeebe, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

processDefinitionKey bpmnProcessId version variables tenantId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zeebe/refs/heads/main/json-structure/zeebe-api-create-process-instance-request-structure.json",
  "name": "CreateProcessInstanceRequest",
  "description": "CreateProcessInstanceRequest schema from Zeebe REST API",
  "type": "object",
  "properties": {
    "processDefinitionKey": {
      "type": "int64",
      "example": 100
    },
    "bpmnProcessId": {
      "type": "string",
      "example": "500123"
    },
    "version": {
      "type": "int32",
      "example": 100
    },
    "variables": {
      "type": "object",
      "example": {}
    },
    "tenantId": {
      "type": "string",
      "example": "500123"
    }
  }
}