Skip to content
TinyConductorTinyConductorTinyConductor

Overview

BPM Public API 0.1.0

Section titled “BPM Public API 0.1.0”

The v1 REST compatibility surface described in the Compatibility guide, plus native history routes.

Every operation is served by one route layer in all three deployment modes (Embedded, Bundled, Cluster), which differ only in durability, latency, capacity and tenancy. Each operation carries x-tinyconductor-modes; unsupported appears only for the operations on the reviewed allow-list (bpm_api_core::modes), which answer 501 with the problem type urn:bpm:error:mode-not-supported, the mode in mode and the reason in detail.

Information

  • OpenAPI version: 3.0.3

Operations

Section titled “ Operations ”
POST
/v1/process-instances
POST
/api/v1/process-instances
POST
/v1/process-instances/{key}/cancellation
POST
/api/v1/process-instances/{key}/cancellation
PUT
/v1/process-instances/{key}/variables
PUT
/api/v1/process-instances/{key}/variables
POST
/v1/process-instances/{key}/modification
POST
/api/v1/process-instances/{key}/modification
POST
/v1/process-instances/{key}/migration
POST
/api/v1/process-instances/{key}/migration
POST
/v1/deployments
POST
/api/v1/deployments
POST
/v1/resources/{key}/deletion
POST
/api/v1/resources/{key}/deletion
POST
/v1/user-tasks/{key}/assignment
POST
/api/v1/user-tasks/{key}/assignment
POST
/v1/user-tasks/{key}/claim
POST
/api/v1/user-tasks/{key}/claim
POST
/v1/user-tasks/{key}/unassignment
POST
/api/v1/user-tasks/{key}/unassignment
DELETE
/v1/user-tasks/{key}/assignee
DELETE
/api/v1/user-tasks/{key}/assignee
POST
/v1/user-tasks/{key}/update
POST
/api/v1/user-tasks/{key}/update
POST
/v1/user-tasks/{key}/completion
POST
/api/v1/user-tasks/{key}/completion
POST
/v1/user-tasks/search
POST
/api/v1/user-tasks/search
POST
/v1/jobs/activation
POST
/api/v1/jobs/activation
PATCH
/v1/jobs/{key}
PATCH
/api/v1/jobs/{key}
POST
/v1/jobs/{key}/completion
POST
/api/v1/jobs/{key}/completion
POST
/v1/jobs/{key}/failure
POST
/api/v1/jobs/{key}/failure
POST
/v1/jobs/{key}/error
POST
/api/v1/jobs/{key}/error
POST
/v1/messages/publication
POST
/api/v1/messages
POST
/v1/signals/broadcast
POST
/api/v1/signals
POST
/v1/decision-definitions/evaluation
POST
/api/v1/decision-definitions/evaluation
POST
/v1/incidents/{key}/resolution
POST
/api/v1/incidents/{key}/resolution
POST
/api/v1/history/process-instances/search
GET
/api/v1/history/process-instances/{key}
POST
/api/v1/history/incidents/search
POST
/api/v1/history/variables/search
POST
/api/v1/history/user-tasks/search
GET
/api/v1/history/process-definitions/{key}/flow-node-statistics
GET
/api/v1/history/process-definitions/{key}/dashboard
GET
/api/v1/analytics/reports
GET
/api/v1/analytics/process-definitions/{key}/reports
GET
/v1/audit-log
GET
/v1/audit-log/integrity
GET
/api/v1/console/configuration
GET
/api/v1/console/health
GET
/api/v1/console/health/background
GET
/api/v1/console/deployments
GET
/api/v1/console/partitions
GET
/api/v1/console/task-filters
POST
/api/v1/console/task-filters
PUT
/api/v1/console/task-filters/{filterId}
DELETE
/api/v1/console/task-filters/{filterId}
GET
/api/v1/console/startable-processes
GET
/api/v1/console/startable-processes/{key}/form
POST
/api/v1/console/process-definitions/search
GET
/api/v1/console/modeling/element-templates
GET
/api/v1/console/modeling/lint-rules
GET
/v1/embedded/records
POST
/v1/embedded/reset
GET
/v1/embedded/clock
POST
/v1/embedded/clock/freeze
POST
/v1/embedded/clock/advance-by
POST
/v1/embedded/clock/advance-to
GET
/livez
GET
/healthz
GET
/readyz
GET
/openapi.yaml
GET
/compatibility

Authentication

Section titled “ Authentication ”

bearerAuth

Section titled “bearerAuth”

Security scheme type: http

Bearer format: opaque