Flowable REST API — ProcessInstances

naftiko: 1.0.0-alpha2
info:
  label: Flowable REST API — ProcessInstances
  description: 'Flowable REST API — ProcessInstances. 2 operations. Lead operation: List process instances. Self-contained
    Naftiko capability covering one Flowable Api business surface.'
  tags:
  - Flowable Api
  - ProcessInstances
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FLOWABLE_API_API_KEY: FLOWABLE_API_API_KEY
capability:
  consumes:
  - type: http
    namespace: flowable-processinstances
    baseUri: https://flowable.example.com/flowable-rest/service
    description: Flowable REST API — ProcessInstances business capability. Self-contained, no shared references.
    resources:
    - name: runtime-process-instances
      path: /runtime/process-instances
      operations:
      - name: listprocessinstances
        method: GET
        description: List process instances
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: startprocessinstance
        method: POST
        description: Start a process instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: flowable-processinstances-rest
    port: 8080
    description: REST adapter for Flowable REST API — ProcessInstances. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/runtime/process-instances
      name: runtime-process-instances
      description: REST surface for runtime-process-instances.
      operations:
      - method: GET
        name: listprocessinstances
        description: List process instances
        call: flowable-processinstances.listprocessinstances
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: startprocessinstance
        description: Start a process instance
        call: flowable-processinstances.startprocessinstance
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: flowable-processinstances-mcp
    port: 9090
    transport: http
    description: MCP adapter for Flowable REST API — ProcessInstances. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-process-instances
      description: List process instances
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flowable-processinstances.listprocessinstances
      outputParameters:
      - type: object
        mapping: $.
    - name: start-process-instance
      description: Start a process instance
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: flowable-processinstances.startprocessinstance
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.