Camunda 8 REST API — Process Instances

naftiko: 1.0.0-alpha2
info:
  label: Camunda 8 REST API — Process Instances
  description: 'Camunda 8 REST API — Process Instances. 4 operations. Lead operation: Create a process instance. Self-contained
    Naftiko capability covering one Camunda business surface.'
  tags:
  - Camunda
  - Process Instances
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CAMUNDA_API_KEY: CAMUNDA_API_KEY
capability:
  consumes:
  - type: http
    namespace: 8-process-instances
    baseUri: ''
    description: Camunda 8 REST API — Process Instances business capability. Self-contained, no shared references.
    resources:
    - name: process-instances
      path: /process-instances
      operations:
      - name: createprocessinstance
        method: POST
        description: Create a process instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: process-instances-search
      path: /process-instances/search
      operations:
      - name: searchprocessinstances
        method: POST
        description: Search process instances
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: process-instances-processInstanceKey
      path: /process-instances/{processInstanceKey}
      operations:
      - name: getprocessinstance
        method: GET
        description: Get process instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: processInstanceKey
          in: path
          type: integer
          required: true
      - name: cancelprocessinstance
        method: DELETE
        description: Cancel a process instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: processInstanceKey
          in: path
          type: integer
          required: true
    authentication:
      type: bearer
      token: '{{env.CAMUNDA_API_KEY}}'
  exposes:
  - type: rest
    namespace: 8-process-instances-rest
    port: 8080
    description: REST adapter for Camunda 8 REST API — Process Instances. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/process-instances
      name: process-instances
      description: REST surface for process-instances.
      operations:
      - method: POST
        name: createprocessinstance
        description: Create a process instance
        call: 8-process-instances.createprocessinstance
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/process-instances/search
      name: process-instances-search
      description: REST surface for process-instances-search.
      operations:
      - method: POST
        name: searchprocessinstances
        description: Search process instances
        call: 8-process-instances.searchprocessinstances
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/process-instances/{processinstancekey}
      name: process-instances-processinstancekey
      description: REST surface for process-instances-processInstanceKey.
      operations:
      - method: GET
        name: getprocessinstance
        description: Get process instance
        call: 8-process-instances.getprocessinstance
        with:
          processInstanceKey: rest.processInstanceKey
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: cancelprocessinstance
        description: Cancel a process instance
        call: 8-process-instances.cancelprocessinstance
        with:
          processInstanceKey: rest.processInstanceKey
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: 8-process-instances-mcp
    port: 9090
    transport: http
    description: MCP adapter for Camunda 8 REST API — Process Instances. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-process-instance
      description: Create a process instance
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: 8-process-instances.createprocessinstance
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: search-process-instances
      description: Search process instances
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: 8-process-instances.searchprocessinstances
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-process-instance
      description: Get process instance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: 8-process-instances.getprocessinstance
      with:
        processInstanceKey: tools.processInstanceKey
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-process-instance
      description: Cancel a process instance
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: 8-process-instances.cancelprocessinstance
      with:
        processInstanceKey: tools.processInstanceKey
      outputParameters:
      - type: object
        mapping: $.