Zeebe Process Instances API

openapi: 3.1.0
info:
  title: Zeebe REST Cluster Process Instances API
  description: The Zeebe REST API provides endpoints for interacting with the Zeebe workflow engine that powers Camunda 8, including process deployment, instance management, job handling, and cluster topology queries.
  version: 8.6.0
  contact:
    name: Camunda
    url: https://camunda.com/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: '{baseUrl}/v2'
  description: Zeebe Gateway REST API
  variables:
    baseUrl:
      default: http://localhost:8080
security:
- BearerAuth: []
tags:
- name: Process Instances
paths:
  /process-instances:
    post:
      operationId: createProcessInstance
      summary: Zeebe Create a Process Instance
      description: Creates and starts a new process instance in Zeebe.
      tags:
      - Process Instances
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProcessInstanceRequest'
            examples:
              CreateProcessInstanceRequestExample:
                summary: Default createProcessInstance request
                x-microcks-default: true
                value:
                  processDefinitionKey: 100
                  bpmnProcessId: '500123'
                  version: 100
                  variables: {}
                  tenantId: '500123'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessInstance'
              examples:
                CreateProcessInstance200Example:
                  summary: Default createProcessInstance 200 response
                  x-microcks-default: true
                  value:
                    processInstanceKey: 100
                    processDefinitionKey: 100
                    bpmnProcessId: '500123'
                    version: 100
                    tenantId: '500123'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /process-instances/{processInstanceKey}:
    delete:
      operationId: cancelProcessInstance
      summary: Zeebe Cancel a Process Instance
      description: Cancels a running process instance.
      tags:
      - Process Instances
      parameters:
      - name: processInstanceKey
        in: path
        required: true
        schema:
          type: integer
          format: int64
        example: 100
      responses:
        '204':
          description: Process instance cancelled
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /process-instances/{processInstanceKey}/migration:
    post:
      operationId: migrateProcessInstance
      summary: Zeebe Migrate a Process Instance
      description: Migrates a process instance to a new process definition version.
      tags:
      - Process Instances
      parameters:
      - name: processInstanceKey
        in: path
        required: true
        schema:
          type: integer
          format: int64
        example: 100
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                targetProcessDefinitionKey:
                  type: integer
                  format: int64
                mappingInstructions:
                  type: array
                  items:
                    type: object
                    properties:
                      sourceElementId:
                        type: string
                      targetElementId:
                        type: string
            examples:
              MigrateProcessInstanceRequestExample:
                summary: Default migrateProcessInstance request
                x-microcks-default: true
                value:
                  targetProcessDefinitionKey: 100
                  mappingInstructions:
                  - sourceElementId: '500123'
                    targetElementId: '500123'
      responses:
        '204':
          description: Migration initiated
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CreateProcessInstanceRequest:
      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'
    ProcessInstance:
      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'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer