Zeebe · Schema

ProcessInstance

ProcessInstance schema from Zeebe REST API

BPMNCamundaCloud NativeDistributed SystemsJavaMicroservicesProcess AutomationWorkflow Orchestration

Properties

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

JSON Schema

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