Zeebe · Schema

CreateProcessInstanceRequest

CreateProcessInstanceRequest schema from Zeebe REST API

BPMNCamundaCloud NativeDistributed SystemsJavaMicroservicesProcess AutomationWorkflow Orchestration

Properties

Name Type Description
processDefinitionKey integer
bpmnProcessId string
version integer
variables object
tenantId string
View JSON Schema on GitHub

JSON Schema

zeebe-api-create-process-instance-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CreateProcessInstanceRequest",
  "description": "CreateProcessInstanceRequest schema from Zeebe REST API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zeebe/refs/heads/main/json-schema/zeebe-api-create-process-instance-request-schema.json",
  "type": "object",
  "properties": {
    "processDefinitionKey": {
      "type": "integer",
      "format": "int64",
      "example": 100
    },
    "bpmnProcessId": {
      "type": "string",
      "example": "500123"
    },
    "version": {
      "type": "integer",
      "example": 100
    },
    "variables": {
      "type": "object",
      "example": {}
    },
    "tenantId": {
      "type": "string",
      "example": "500123"
    }
  }
}