flowable-mcp

MCP (Model Context Protocol) server for Flowable REST API. Exposes Flowable's process engine as tools accessible from Claude Code / any MCP client.

Quick Start

# Install
cd projects/flowable-mcp
npm install

# Build
npm run build

# Dev (watch mode)
npm run dev

Configuration

Environment variables (with defaults):

| Variable | Default | Description | |----------|---------|-------------| | FLOWABLE_URL | http://localhost:9977/flowable-rest | Flowable REST base URL | | FLOWABLE_USERNAME | admin | Basic Auth username | | FLOWABLE_PASSWORD | test | Basic Auth password |

Claude Code (.mcp.json)

{
  "mcpServers": {
    "flowable": {
      "command": "node",
      "args": ["projects/flowable-mcp/build/index.js"],
      "env": {
        "FLOWABLE_URL": "http://localhost:9977/flowable-rest",
        "FLOWABLE_USERNAME": "admin",
        "FLOWABLE_PASSWORD": "your-password"
      }
    }
  }
}

Tools (78)

Management (4 tools)

| Tool | Description | |------|-------------| | engine-info | Get engine version and health status | | get-engine-properties | Get all engine configuration properties | | list-tables | List all database tables and row counts | | get-table-data | Get row data from a database table (debugging) |

Repository — Process Definitions (6 tools)

| Tool | Description | |------|-------------| | list-process-definitions | List deployed definitions (filter: latest, key, name, suspended) | | get-process-definition | Get single definition by ID | | get-process-definition-xml | Get BPMN 2.0 XML of a definition | | get-process-definition-start-form | Get start form for a definition | | suspend-process-definition | Suspend definition (block new instances) | | activate-process-definition | Activate a suspended definition |

Repository — Deployments (5 tools)

| Tool | Description | |------|-------------| | list-deployments | List all deployments (filter: name) | | get-deployment | Get single deployment by ID | | list-deployment-resources | List resources in a deployment | | create-deployment | Deploy BPMN XML (multipart upload) | | delete-deployment | Delete deployment (optional cascade) |

Runtime — Process Instances (12 tools)

| Tool | Description | |------|-------------| | start-process-instance | Start by key/ID with variables | | list-process-instances | Query running instances | | get-process-instance | Get single instance by ID | | delete-process-instance | Cancel/delete a running instance | | suspend-process-instance | Suspend a running instance | | activate-process-instance | Activate a suspended instance | | get-process-instance-variables | Get all variables | | create-process-instance-variable | Create variables on an instance | | update-process-instance-variable | Update a single variable | | delete-process-instance-variable | Delete a variable | | list-process-instance-identity-links | Get involved people | | create-process-instance-identity-link | Add involved user |

Runtime — Tasks (17 tools)

| Tool | Description | |------|-------------| | list-tasks | Query tasks (filter: assignee, candidateUser, candidateGroup, etc.) | | get-task | Get single task by ID | | update-task | Update task properties (name, assignee, dueDate, priority) | | get-task-variables | Get all task variables | | create-task-variable | Create a variable on a task | | delete-task-variable | Delete a variable from a task | | claim-task | Assign task to a user | | unclaim-task | Remove assignee (make available for claiming) | | delegate-task | Delegate task to another user | | resolve-task | Resolve a delegated task (required after delegate) | | complete-task | Complete task with optional variables | | get-task-form | Get form definition for a task | | list-task-comments | List comments on a task | | create-task-comment | Add a comment to a task | | list-task-identity-links | List candidate users/groups | | create-task-identity-link | Add candidate user/group | | delete-task-identity-link | Remove identity link | | list-task-subtasks | List subtasks |

Runtime — Executions (4 tools)

| Tool | Description | |------|-------------| | list-executions | List executions (debugging process flow) | | get-execution | Get single execution by ID | | get-execution-activities | Get active activities in an execution | | signal-execution | Send signal to execution (trigger wait state) |

Runtime — Events (3 tools)

| Tool | Description | |------|-------------| | send-signal-event | Send signal event to all subscribers | | list-event-subscriptions | List event subscriptions | | list-activity-instances | List active activity instances |

Forms (3 tools)

| Tool | Description | |------|-------------| | get-form-data | Get form data for task or start form | | submit-form-data | Submit form data (complete task or start process) | | get-task-form | Get task form definition |

History (8 tools)

| Tool | Description | |------|-------------| | list-historic-process-instances | Query historic process instances | | get-historic-process-instance | Get single historic process instance | | delete-historic-process-instance | Delete historic process instance | | list-historic-task-instances | Query historic tasks | | get-historic-task-instance | Get single historic task | | list-historic-activity-instances | Track process execution flow | | list-historic-variable-instances | Track variable changes over time | | list-historic-detail | Variable updates and form property history |

Identity (4 tools)

| Tool | Description | |------|-------------| | list-users | List users synced from LDAP | | get-user | Get single user by ID | | list-groups | List groups | | get-group | Get single group by ID |

Jobs (8 tools)

| Tool | Description | |------|-------------| | list-jobs | List background jobs | | get-job | Get single job by ID | | execute-job | Execute a job immediately | | delete-job | Delete a job | | list-timer-jobs | List timer jobs | | list-deadletter-jobs | List failed (deadletter) jobs | | move-deadletter-job | Retry a deadletter job | | list-suspended-jobs | List suspended jobs |

Query (advanced POST filtering) (4 tools)

| Tool | Description | |------|-------------| | query-process-instances | Advanced query with variable value filtering | | query-tasks | Advanced task query with process/task variable filtering | | query-historic-process-instances | Advanced historic process query | | query-historic-task-instances | Advanced historic task query |

Architecture

┌─────────────┐    stdio     ┌──────────────┐   HTTP/Basic Auth   ┌─────────────────┐
│ Claude Code  │◄────────────►│ flowable-mcp │◄───────────────────►│ Flowable REST   │
│ (MCP Client) │              │ (MCP Server) │                     │ :9977           │
└─────────────┘              └──────────────┘                     └─────────────────┘

• Transport: Stdio (stdin/stdout)
• Auth: HTTP Basic Auth (LDAP-backed via Authentik)
• Validation: Zod schemas for all tool inputs

Tech Stack

| Package | Version | Purpose | |---------|---------|---------| | @modelcontextprotocol/sdk | ^1.27.0 | MCP server framework | | zod | ^3.24.0 | Input validation | | typescript | ^5.7.0 | Language |

Known Limitations

• Delegation workflow: After delegate-task, you must call resolve-task before complete-task.
• Binary responses: Image/diagram endpoints (process definition image, process instance diagram) are not yet supported as tools — they return binary data.
• Pagination: All list tools support size and start (0-based) parameters.
• CMMN/DMN/App/External Worker: Only the BPMN Process API is exposed. CMMN, DMN, Event Registry, App, and External Worker APIs are available via REST but not yet as MCP tools.

Flowable REST API Reference

Full API available at http://localhost:9977/flowable-rest/docs (Swagger UI). Flowable REST v7.2.0 exposes 7 API modules with 440+ endpoints.

Process API (/service/...)

| Method | Path | Description | |--------|------|-------------| | GET | /form/form-data | Get form data | | POST | /form/form-data | Submit task form data |

| Method | Path | Description | |--------|------|-------------| | GET | /history/historic-activity-instances | List historic activity instances | | GET | /history/historic-detail | Get historic detail | | GET | /history/historic-detail/{detailId}/data | Get binary data for a historic detail variable | | GET | /history/historic-process-instances | List historic process instances | | POST | /history/historic-process-instances/delete | Bulk delete historic process instances | | DELETE | /history/historic-process-instances/{id} | Delete a historic process instance | | GET | /history/historic-process-instances/{id} | Get a historic process instance | | GET | /history/historic-process-instances/{id}/comments | List comments | | POST | /history/historic-process-instances/{id}/comments | Create comment | | DELETE | /history/historic-process-instances/{id}/comments/{commentId} | Delete comment | | GET | /history/historic-process-instances/{id}/comments/{commentId} | Get comment | | GET | /history/historic-process-instances/{id}/identitylinks | List identity links | | GET | /history/historic-process-instances/{id}/variables/{var}/data | Get binary variable data | | GET | /history/historic-task-instances | List historic task instances | | DELETE | /history/historic-task-instances/{taskId} | Delete historic task | | GET | /history/historic-task-instances/{taskId} | Get historic task | | GET | /history/historic-task-instances/{taskId}/form | Get historic task form | | GET | /history/historic-task-instances/{taskId}/identitylinks | List identity links | | GET | /history/historic-task-instances/{taskId}/variables/{var}/data | Get binary variable data | | GET | /history/historic-task-log-entries | List historic task log entries | | GET | /history/historic-variable-instances | List historic variable instances | | GET | /history/historic-variable-instances/{id}/data | Get binary variable data |

| Method | Path | Description | |--------|------|-------------| | GET | /identity/groups | List groups | | POST | /identity/groups | Create group | | DELETE | /identity/groups/{groupId} | Delete group | | GET | /identity/groups/{groupId} | Get group | | PUT | /identity/groups/{groupId} | Update group | | POST | /identity/groups/{groupId}/members | Add member to group | | DELETE | /identity/groups/{groupId}/members/{userId} | Remove member | | GET | /identity/users | List users | | POST | /identity/users | Create user | | DELETE | /identity/users/{userId} | Delete user | | GET | /identity/users/{userId} | Get user | | PUT | /identity/users/{userId} | Update user | | GET | /identity/users/{userId}/info | List user info | | POST | /identity/users/{userId}/info | Create user info entry | | DELETE | /identity/users/{userId}/info/{key} | Delete user info | | GET | /identity/users/{userId}/info/{key} | Get user info | | PUT | /identity/users/{userId}/info/{key} | Update user info | | GET | /identity/users/{userId}/picture | Get user picture | | PUT | /identity/users/{userId}/picture | Update user picture |

| Method | Path | Description | |--------|------|-------------| | GET | /management/engine | Get engine info | | GET | /management/engine-properties | Get all engine properties | | POST | /management/engine-properties | Create engine property | | DELETE | /management/engine-properties/{prop} | Delete engine property | | PUT | /management/engine-properties/{prop} | Update engine property | | GET | /management/properties | List engine properties | | GET | /management/jobs | List jobs | | DELETE | /management/jobs/{jobId} | Delete job | | GET | /management/jobs/{jobId} | Get job | | POST | /management/jobs/{jobId} | Execute job | | GET | /management/jobs/{jobId}/exception-stacktrace | Get job exception | | GET | /management/timer-jobs | List timer jobs | | DELETE | /management/timer-jobs/{jobId} | Delete timer job | | GET | /management/timer-jobs/{jobId} | Get timer job | | POST | /management/timer-jobs/{jobId} | Move/reschedule timer job | | GET | /management/timer-jobs/{jobId}/exception-stacktrace | Get timer job exception | | GET | /management/deadletter-jobs | List deadletter jobs | | POST | /management/deadletter-jobs | Bulk move deadletter jobs | | DELETE | /management/deadletter-jobs/{jobId} | Delete deadletter job | | GET | /management/deadletter-jobs/{jobId} | Get deadletter job | | POST | /management/deadletter-jobs/{jobId} | Move deadletter job | | GET | /management/deadletter-jobs/{jobId}/exception-stacktrace | Get deadletter exception | | GET | /management/suspended-jobs | List suspended jobs | | DELETE | /management/suspended-jobs/{jobId} | Delete suspended job | | GET | /management/suspended-jobs/{jobId} | Get suspended job | | GET | /management/suspended-jobs/{jobId}/exception-stacktrace | Get suspended job exception | | GET | /management/history-jobs | List history jobs | | DELETE | /management/history-jobs/{jobId} | Delete history job | | GET | /management/history-jobs/{jobId} | Get history job | | POST | /management/history-jobs/{jobId} | Execute history job | | GET | /management/batches | List batches | | DELETE | /management/batches/{batchId} | Delete batch | | GET | /management/batches/{batchId} | Get batch | | GET | /management/batches/{batchId}/batch-document | Get batch document | | GET | /management/batches/{batchId}/batch-parts | List batch parts | | GET | /management/batch-parts/{batchPartId} | Get batch part | | GET | /management/batch-parts/{batchPartId}/batch-part-document | Get batch part document | | GET | /management/tables | List tables | | GET | /management/tables/{tableName} | Get table | | GET | /management/tables/{tableName}/columns | Get table columns | | GET | /management/tables/{tableName}/data | Get table data |

| Method | Path | Description | |--------|------|-------------| | POST | /query/activity-instances | Query activity instances | | POST | /query/executions | Query executions | | POST | /query/historic-activity-instances | Query historic activity instances | | POST | /query/historic-detail | Query historic details | | POST | /query/historic-process-instances | Query historic process instances | | POST | /query/historic-task-instances | Query historic task instances | | POST | /query/historic-variable-instances | Query historic variable instances | | POST | /query/process-instances | Query process instances | | POST | /query/tasks | Query tasks | | POST | /query/variable-instances | Query variable instances |

| Method | Path | Description | |--------|------|-------------| | GET | /repository/deployments | List deployments | | POST | /repository/deployments | Create deployment | | DELETE | /repository/deployments/{id} | Delete deployment | | GET | /repository/deployments/{id} | Get deployment | | GET | /repository/deployments/{id}/resources | List deployment resources | | GET | /repository/deployments/{id}/resources/** | Get deployment resource | | GET | /repository/deployments/{id}/resourcedata/{name} | Get resource content | | GET | /repository/process-definitions | List process definitions | | GET | /repository/process-definitions/{id} | Get process definition | | PUT | /repository/process-definitions/{id} | Execute actions (suspend/activate) | | POST | /repository/process-definitions/{id}/batch-migrate | Batch migrate instances | | GET | /repository/process-definitions/{id}/decision-tables | List decision tables | | GET | /repository/process-definitions/{id}/decisions | List decisions | | GET | /repository/process-definitions/{id}/form-definitions | List form definitions | | GET | /repository/process-definitions/{id}/identitylinks | List candidate starters | | POST | /repository/process-definitions/{id}/identitylinks | Add candidate starter | | DELETE | /repository/process-definitions/{id}/identitylinks/{family}/{identityId} | Delete candidate starter | | GET | /repository/process-definitions/{id}/identitylinks/{family}/{identityId} | Get candidate starter | | GET | /repository/process-definitions/{id}/image | Get process definition image | | POST | /repository/process-definitions/{id}/migrate | Migrate all instances | | GET | /repository/process-definitions/{id}/model | Get BPMN model | | GET | /repository/process-definitions/{id}/resourcedata | Get resource content | | GET | /repository/process-definitions/{id}/start-form | Get start form | | GET | /repository/models | List models | | POST | /repository/models | Create model | | DELETE | /repository/models/{modelId} | Delete model | | GET | /repository/models/{modelId} | Get model | | PUT | /repository/models/{modelId} | Update model | | GET | /repository/models/{modelId}/source | Get editor source | | PUT | /repository/models/{modelId}/source | Set editor source | | GET | /repository/models/{modelId}/source-extra | Get extra editor source | | PUT | /repository/models/{modelId}/source-extra | Set extra editor source |

| Method | Path | Description | |--------|------|-------------| | GET | /runtime/process-instances | List process instances | | POST | /runtime/process-instances | Start process instance | | POST | /runtime/process-instances/delete | Bulk delete | | DELETE | /runtime/process-instances/{id} | Delete instance | | GET | /runtime/process-instances/{id} | Get instance | | PUT | /runtime/process-instances/{id} | Update/action on instance | | POST | /runtime/process-instances/{id}/change-state | Change state | | GET | /runtime/process-instances/{id}/diagram | Get diagram | | POST | /runtime/process-instances/{id}/evaluate-conditions | Evaluate conditions | | GET | /runtime/process-instances/{id}/identitylinks | Get involved people | | POST | /runtime/process-instances/{id}/identitylinks | Add involved user | | DELETE | /runtime/process-instances/{id}/identitylinks/users/{uid}/{type} | Remove involved user | | GET | /runtime/process-instances/{id}/identitylinks/users/{uid}/{type} | Get involved user | | POST | /runtime/process-instances/{id}/inject | Inject activity | | POST | /runtime/process-instances/{id}/migrate | Migrate instance | | DELETE | /runtime/process-instances/{id}/variables | Delete all variables | | GET | /runtime/process-instances/{id}/variables | List variables | | POST | /runtime/process-instances/{id}/variables | Create variables | | PUT | /runtime/process-instances/{id}/variables | Update variables | | DELETE | /runtime/process-instances/{id}/variables/{var} | Delete variable | | GET | /runtime/process-instances/{id}/variables/{var} | Get variable | | PUT | /runtime/process-instances/{id}/variables/{var} | Update variable | | GET | /runtime/process-instances/{id}/variables/{var}/data | Get binary data | | GET | /runtime/executions | List executions | | PUT | /runtime/executions | Signal event received | | GET | /runtime/executions/{id} | Get execution | | PUT | /runtime/executions/{id} | Execute action | | GET | /runtime/executions/{id}/activities | List active activities | | POST | /runtime/executions/{id}/change-state | Change state | | DELETE | /runtime/executions/{id}/variables | Delete all variables | | GET | /runtime/executions/{id}/variables | List variables | | POST | /runtime/executions/{id}/variables | Create variables | | PUT | /runtime/executions/{id}/variables | Update variables | | DELETE | /runtime/executions/{id}/variables/{var} | Delete variable | | GET | /runtime/executions/{id}/variables/{var} | Get variable | | PUT | /runtime/executions/{id}/variables/{var} | Update variable | | GET | /runtime/executions/{id}/variables/{var}/data | Get binary data | | GET | /runtime/tasks | List tasks | | POST | /runtime/tasks | Create task | | PUT | /runtime/tasks | Update tasks | | DELETE | /runtime/tasks/{taskId} | Delete task | | GET | /runtime/tasks/{taskId} | Get task | | POST | /runtime/tasks/{taskId} | Task actions (complete/claim/delegate/resolve) | | PUT | /runtime/tasks/{taskId} | Update task | | GET | /runtime/tasks/{taskId}/attachments | List attachments | | POST | /runtime/tasks/{taskId}/attachments | Create attachment | | DELETE | /runtime/tasks/{taskId}/attachments/{id} | Delete attachment | | GET | /runtime/tasks/{taskId}/attachments/{id} | Get attachment | | GET | /runtime/tasks/{taskId}/attachments/{id}/content | Get attachment content | | GET | /runtime/tasks/{taskId}/comments | List comments | | POST | /runtime/tasks/{taskId}/comments | Create comment | | DELETE | /runtime/tasks/{taskId}/comments/{id} | Delete comment | | GET | /runtime/tasks/{taskId}/comments/{id} | Get comment | | GET | /runtime/tasks/{taskId}/events | List events | | DELETE | /runtime/tasks/{taskId}/events/{id} | Delete event | | GET | /runtime/tasks/{taskId}/events/{id} | Get event | | GET | /runtime/tasks/{taskId}/form | Get task form | | GET | /runtime/tasks/{taskId}/identitylinks | List identity links | | POST | /runtime/tasks/{taskId}/identitylinks | Create identity link | | GET | /runtime/tasks/{taskId}/subtasks | List subtasks | | DELETE | /runtime/tasks/{taskId}/variables | Delete all variables | | GET | /runtime/tasks/{taskId}/variables | List variables | | POST | /runtime/tasks/{taskId}/variables | Create variables | | DELETE | /runtime/tasks/{taskId}/variables/{var} | Delete variable | | GET | /runtime/tasks/{taskId}/variables/{var} | Get variable | | PUT | /runtime/tasks/{taskId}/variables/{var} | Update variable | | GET | /runtime/tasks/{taskId}/variables/{var}/data | Get binary data | | GET | /runtime/activity-instances | List activity instances | | GET | /runtime/event-subscriptions | List event subscriptions | | GET | /runtime/event-subscriptions/{id} | Get event subscription | | POST | /runtime/signals | Signal event received | | GET | /runtime/variable-instances | List variable instances | | GET | /runtime/variable-instances/{id}/data | Get binary data |

IDM API (/service/...)

| Method | Path | Description | |--------|------|-------------| | GET | /idm-management/engine | Get IDM engine info | | GET | /groups | List groups | | POST | /groups | Create group | | DELETE | /groups/{groupId} | Delete group | | GET | /groups/{groupId} | Get group | | PUT | /groups/{groupId} | Update group | | POST | /groups/{groupId}/members | Add member | | DELETE | /groups/{groupId}/members/{userId} | Remove member | | GET | /users | List users | | POST | /users | Create user | | DELETE | /users/{userId} | Delete user | | GET | /users/{userId} | Get user | | PUT | /users/{userId} | Update user | | GET | /privileges | List privileges | | GET | /privileges/{id} | Get privilege | | GET | /privileges/{id}/groups | List groups for privilege | | POST | /privileges/{id}/groups | Add privilege for group | | DELETE | /privileges/{id}/group/{groupId} | Remove privilege for group | | GET | /privileges/{id}/users | List users for privilege | | POST | /privileges/{id}/users | Add privilege for user | | DELETE | /privileges/{id}/users/{userId} | Remove privilege for user |

DMN API (/service/...)

| Method | Path | Description | |--------|------|-------------| | GET | /dmn-management/engine | Get DMN engine info | | GET | /dmn-repository/deployments | List DMN deployments | | POST | /dmn-repository/deployments | Create DMN deployment | | DELETE | /dmn-repository/deployments/{id} | Delete DMN deployment | | GET | /dmn-repository/deployments/{id} | Get DMN deployment | | GET | /dmn-repository/deployments/{id}/resourcedata/{name} | Get resource content | | GET | /dmn-repository/decision-tables | List decision tables | | GET | /dmn-repository/decision-tables/{id} | Get decision table | | GET | /dmn-repository/decision-tables/{id}/model | Get decision table model | | GET | /dmn-repository/decision-tables/{id}/resourcedata | Get resource content | | GET | /dmn-repository/decisions | List decisions | | GET | /dmn-repository/decisions/{id} | Get decision | | GET | /dmn-repository/decisions/{id}/image | Get decision diagram | | GET | /dmn-repository/decisions/{id}/model | Get decision model | | GET | /dmn-repository/decisions/{id}/resourcedata | Get resource content | | GET | /dmn-history/historic-decision-executions | List historic executions | | GET | /dmn-history/historic-decision-executions/{id} | Get historic execution | | GET | /dmn-history/historic-decision-executions/{id}/auditdata | Get audit data | | POST | /dmn-rule/execute | Execute a decision | | POST | /dmn-rule/execute/single-result | Execute decision (single result) | | POST | /dmn-rule/execute-decision | Execute a decision | | POST | /dmn-rule/execute-decision/single-result | Execute decision (single result) | | POST | /dmn-rule/execute-decision-service | Execute decision service | | POST | /dmn-rule/execute-decision-service/single-result | Execute decision service (single result) |

CMMN API (/service/...)

Repository

| Method | Path | Description | |--------|------|-------------| | GET | /cmmn-repository/deployments | List deployments | | POST | /cmmn-repository/deployments | Create deployment | | DELETE | /cmmn-repository/deployments/{id} | Delete deployment | | GET | /cmmn-repository/deployments/{id} | Get deployment | | GET | /cmmn-repository/deployments/{id}/resourcedata/{name} | Get resource content | | GET | /cmmn-repository/deployments/{id}/resources | List resources | | GET | /cmmn-repository/deployments/{id}/resources/** | Get resource | | GET | /cmmn-repository/case-definitions | List case definitions | | GET | /cmmn-repository/case-definitions/{id} | Get case definition | | PUT | /cmmn-repository/case-definitions/{id} | Execute actions | | POST | /cmmn-repository/case-definitions/{id}/batch-migrate | Batch migrate instances | | POST | /cmmn-repository/case-definitions/{id}/batch-migrate-historic-instances | Batch migrate historic | | GET | /cmmn-repository/case-definitions/{id}/decision-tables | List decision tables | | GET | /cmmn-repository/case-definitions/{id}/decisions | List decisions | | GET | /cmmn-repository/case-definitions/{id}/form-definitions | List form definitions | | GET | /cmmn-repository/case-definitions/{id}/identitylinks | List candidate starters | | POST | /cmmn-repository/case-definitions/{id}/identitylinks | Add candidate starter | | DELETE | /cmmn-repository/case-definitions/{id}/identitylinks/{family}/{identityId} | Delete starter | | GET | /cmmn-repository/case-definitions/{id}/identitylinks/{family}/{identityId} | Get starter | | GET | /cmmn-repository/case-definitions/{id}/image | Get case definition image | | POST | /cmmn-repository/case-definitions/{id}/migrate | Migrate all instances | | POST | /cmmn-repository/case-definitions/{id}/migrate-historic-instances | Migrate historic | | GET | /cmmn-repository/case-definitions/{id}/model | Get CMMN model | | GET | /cmmn-repository/case-definitions/{id}/resourcedata | Get resource content | | GET | /cmmn-repository/case-definitions/{id}/start-form | Get start form |

Runtime — Case Instances

| Method | Path | Description | |--------|------|-------------| | GET | /cmmn-runtime/case-instances | List case instances | | POST | /cmmn-runtime/case-instances | Start case instance | | POST | /cmmn-runtime/case-instances/delete | Bulk delete/terminate | | DELETE | /cmmn-runtime/case-instances/{id} | Terminate case | | GET | /cmmn-runtime/case-instances/{id} | Get case instance | | PUT | /cmmn-runtime/case-instances/{id} | Update/action on case | | POST | /cmmn-runtime/case-instances/{id}/change-state | Change state | | DELETE | /cmmn-runtime/case-instances/{id}/delete | Delete case | | GET | /cmmn-runtime/case-instances/{id}/diagram | Get diagram | | GET | /cmmn-runtime/case-instances/{id}/identitylinks | Get involved people | | POST | /cmmn-runtime/case-instances/{id}/identitylinks | Add involved user | | DELETE | /cmmn-runtime/case-instances/{id}/identitylinks/users/{uid}/{type} | Remove user | | GET | /cmmn-runtime/case-instances/{id}/identitylinks/users/{uid}/{type} | Get user | | POST | /cmmn-runtime/case-instances/{id}/migrate | Migrate case | | GET | /cmmn-runtime/case-instances/{id}/stage-overview | Get stage overview | | DELETE | /cmmn-runtime/case-instances/{id}/variables | Delete all variables | | GET | /cmmn-runtime/case-instances/{id}/variables | List variables | | POST | /cmmn-runtime/case-instances/{id}/variables | Create variables | | PUT | /cmmn-runtime/case-instances/{id}/variables | Update variables | | DELETE | /cmmn-runtime/case-instances/{id}/variables/{var} | Delete variable | | GET | /cmmn-runtime/case-instances/{id}/variables/{var} | Get variable | | PUT | /cmmn-runtime/case-instances/{id}/variables/{var} | Update variable | | GET | /cmmn-runtime/case-instances/{id}/variables/{var}/data | Get binary data |

Runtime — Plan Items

| Method | Path | Description | |--------|------|-------------| | GET | /cmmn-runtime/plan-item-instances | List plan item instances | | GET | /cmmn-runtime/plan-item-instances/{id} | Get plan item | | PUT | /cmmn-runtime/plan-item-instances/{id} | Execute action | | POST | /cmmn-runtime/plan-item-instances/{id}/variables | Create variable | | DELETE | /cmmn-runtime/plan-item-instances/{id}/variables/{var} | Delete variable | | PUT | /cmmn-runtime/plan-item-instances/{id}/variables/{var} | Update variable | | GET | /cmmn-runtime/plan-item-instances/{id}/variables/{var}/data | Get binary data |

Runtime — Tasks (same structure as Process tasks)

| Method | Path | Description | |--------|------|-------------| | GET | /cmmn-runtime/tasks | List tasks | | POST | /cmmn-runtime/tasks | Create task | | PUT | /cmmn-runtime/tasks | Update tasks | | DELETE | /cmmn-runtime/tasks/{taskId} | Delete task | | GET | /cmmn-runtime/tasks/{taskId} | Get task | | POST | /cmmn-runtime/tasks/{taskId} | Task actions | | PUT | /cmmn-runtime/tasks/{taskId} | Update task | | GET | /cmmn-runtime/tasks/{taskId}/form | Get task form | | GET | /cmmn-runtime/tasks/{taskId}/identitylinks | List identity links | | POST | /cmmn-runtime/tasks/{taskId}/identitylinks | Create identity link | | GET | /cmmn-runtime/tasks/{taskId}/subtasks | List subtasks | | DELETE | /cmmn-runtime/tasks/{taskId}/variables | Delete all variables | | GET | /cmmn-runtime/tasks/{taskId}/variables | List variables | | POST | /cmmn-runtime/tasks/{taskId}/variables | Create variables | | DELETE | /cmmn-runtime/tasks/{taskId}/variables/{var} | Delete variable | | GET | /cmmn-runtime/tasks/{taskId}/variables/{var} | Get variable | | PUT | /cmmn-runtime/tasks/{taskId}/variables/{var} | Update variable | | GET | /cmmn-runtime/tasks/{taskId}/variables/{var}/data | Get binary data |

Runtime — Other

| Method | Path | Description | |--------|------|-------------| | GET | /cmmn-runtime/event-subscriptions | List event subscriptions | | GET | /cmmn-runtime/event-subscriptions/{id} | Get event subscription | | GET | /cmmn-runtime/variable-instances | List variable instances | | GET | /cmmn-runtime/variable-instances/{id}/data | Get binary data |

History

| Method | Path | Description | |--------|------|-------------| | GET | /cmmn-history/historic-case-instances | List historic cases | | POST | /cmmn-history/historic-case-instances/delete | Bulk delete | | DELETE | /cmmn-history/historic-case-instances/{id} | Delete historic case | | GET | /cmmn-history/historic-case-instances/{id} | Get historic case | | GET | /cmmn-history/historic-case-instances/{id}/identitylinks | List identity links | | POST | /cmmn-history/historic-case-instances/{id}/migrate | Migrate historic case | | GET | /cmmn-history/historic-case-instances/{id}/stage-overview | Stage overview | | GET | /cmmn-history/historic-case-instances/{id}/variables/{var}/data | Get binary data | | GET | /cmmn-history/historic-milestone-instances | List milestones | | GET | /cmmn-history/historic-milestone-instances/{id} | Get milestone | | GET | /cmmn-history/historic-planitem-instances | List plan items | | GET | /cmmn-history/historic-planitem-instances/{id} | Get plan item | | GET | /cmmn-history/historic-task-instances | List historic tasks | | DELETE | /cmmn-history/historic-task-instances/{taskId} | Delete historic task | | GET | /cmmn-history/historic-task-instances/{taskId} | Get historic task | | GET | /cmmn-history/historic-task-instances/{taskId}/form | Get form | | GET | /cmmn-history/historic-task-instances/{taskId}/identitylinks | List identity links | | GET | /cmmn-history/historic-task-instances/{taskId}/variables/{var}/data | Get binary data | | GET | /cmmn-history/historic-variable-instances | List historic variables | | GET | /cmmn-history/historic-variable-instances/{id}/data | Get binary data |

Management

| Method | Path | Description | |--------|------|-------------| | GET | /cmmn-management/engine | Get CMMN engine info | | GET | /cmmn-management/jobs | List jobs | | DELETE | /cmmn-management/jobs/{jobId} | Delete job | | GET | /cmmn-management/jobs/{jobId} | Get job | | POST | /cmmn-management/jobs/{jobId} | Execute job | | GET | /cmmn-management/jobs/{jobId}/exception-stacktrace | Get exception | | GET | /cmmn-management/timer-jobs | List timer jobs | | DELETE | /cmmn-management/timer-jobs/{jobId} | Delete timer job | | GET | /cmmn-management/timer-jobs/{jobId} | Get timer job | | POST | /cmmn-management/timer-jobs/{jobId} | Move/reschedule | | GET | /cmmn-management/timer-jobs/{jobId}/exception-stacktrace | Get exception | | GET | /cmmn-management/deadletter-jobs | List deadletter jobs | | POST | /cmmn-management/deadletter-jobs | Bulk move | | DELETE | /cmmn-management/deadletter-jobs/{jobId} | Delete | | GET | /cmmn-management/deadletter-jobs/{jobId} | Get | | POST | /cmmn-management/deadletter-jobs/{jobId} | Move | | GET | /cmmn-management/deadletter-jobs/{jobId}/exception-stacktrace | Get exception | | GET | /cmmn-management/suspended-jobs | List suspended jobs | | DELETE | /cmmn-management/suspended-jobs/{jobId} | Delete | | GET | /cmmn-management/suspended-jobs/{jobId} | Get | | GET | /cmmn-management/suspended-jobs/{jobId}/exception-stacktrace | Get exception | | GET | /cmmn-management/history-jobs | List history jobs | | DELETE | /cmmn-management/history-jobs/{jobId} | Delete | | GET | /cmmn-management/history-jobs/{jobId} | Get | | POST | /cmmn-management/history-jobs/{jobId} | Execute |

Query

| Method | Path | Description | |--------|------|-------------| | POST | /cmmn-query/case-instances | Query case instances | | POST | /cmmn-query/historic-case-instances | Query historic cases | | POST | /cmmn-query/historic-milestone-instances | Query historic milestones | | POST | /cmmn-query/historic-planitem-instances | Query historic plan items | | POST | /cmmn-query/historic-task-instances | Query historic tasks | | POST | /cmmn-query/historic-variable-instances | Query historic variables | | POST | /cmmn-query/plan-item-instances | Query plan items | | POST | /cmmn-query/tasks | Query tasks | | POST | /cmmn-query/variable-instances | Query variables |

Event Registry API (/service/...)

| Method | Path | Description | |--------|------|-------------| | GET | /event-registry-management/engine | Get engine info | | GET | /event-registry-repository/deployments | List deployments | | POST | /event-registry-repository/deployments | Create deployment | | DELETE | /event-registry-repository/deployments/{id} | Delete deployment | | GET | /event-registry-repository/deployments/{id} | Get deployment | | GET | /event-registry-repository/deployments/{id}/resourcedata/{name} | Get resource content | | GET | /event-registry-repository/deployments/{id}/resources | List resources | | GET | /event-registry-repository/deployments/{id}/resources/** | Get resource | | GET | /event-registry-repository/event-definitions | List event definitions | | GET | /event-registry-repository/event-definitions/{id} | Get event definition | | GET | /event-registry-repository/event-definitions/{id}/model | Get event model | | GET | /event-registry-repository/event-definitions/{id}/resourcedata | Get resource content | | GET | /event-registry-repository/channel-definitions | List channel definitions | | GET | /event-registry-repository/channel-definitions/{id} | Get channel definition | | GET | /event-registry-repository/channel-definitions/{id}/model | Get channel model | | GET | /event-registry-repository/channel-definitions/{id}/resourcedata | Get resource content | | POST | /event-registry-runtime/event-instances | Send event instance |

App API (/service/...)

| Method | Path | Description | |--------|------|-------------| | GET | /app-management/engine | Get app engine info | | GET | /app-repository/deployments | List app deployments | | POST | /app-repository/deployments | Create app deployment | | DELETE | /app-repository/deployments/{id} | Delete deployment | | GET | /app-repository/deployments/{id} | Get deployment | | GET | /app-repository/deployments/{id}/resourcedata/{name} | Get resource content | | GET | /app-repository/deployments/{id}/resources | List resources | | GET | /app-repository/deployments/{id}/resources/** | Get resource | | GET | /app-repository/app-definitions | List app definitions | | GET | /app-repository/app-definitions/{id} | Get app definition | | PUT | /app-repository/app-definitions/{id} | Execute actions | | GET | /app-repository/app-definitions/{id}/model | Get app model | | GET | /app-repository/app-definitions/{id}/resourcedata | Get resource content |

External Worker API (/service/...)

| Method | Path | Description | |--------|------|-------------| | POST | /acquire/jobs | Acquire external worker jobs | | POST | /acquire/jobs/{jobId}/bpmnError | Complete with BPMN error | | POST | /acquire/jobs/{jobId}/cmmnTerminate | Complete with CMMN terminate | | POST | /acquire/jobs/{jobId}/complete | Complete external worker job | | POST | /acquire/jobs/{jobId}/fail | Fail external worker job | | GET | /jobs | List external worker jobs | | GET | /jobs/{jobId} | Get external worker job | | POST | /unacquire/jobs | Unacquire jobs | | POST | /unacquire/jobs/{jobId} | Unacquire single job |