Skip to content
TinyConductor
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Menu
Get started
What is TinyConductor?
Quickstart
Glossary
Deployment modes
Embedded mode
Bundled mode
Cluster mode
How the engine runs your processes
Container image
Kubernetes
Tenant quotas
Beta data handling
Testing processes
Testing processes
Testing with .NET
.NET SDK reference
Testing with Rust
Testing with C and other FFI languages
Testing with Java
Testing with TypeScript and Node.js
Testing with Python
Testing with Go
Running in CI
Modeling
BPMN coverage
DMN and FEEL
Cluster variables
Examples
TinyConductor Console
TinyConductor Console
Task authorization
Audit log API
Building an external task list
Identity & access
Identity and access
Connecting your identity provider
Script tasks & connectors
Script tasks
Connectors
Documents
Analytics
Analytics
API reference
Overview
Orchestration API v2
Overview
Process instances
Overview
Start a process instance
POST
Search process instances
POST
Get a process instance
GET
Cancel a process instance
POST
Count element instances per element of one instance
GET
Modify a process instance
POST
Migrate a process instance
POST
Deployments
Overview
Deploy BPMN, DMN and form resources
POST
Process definitions
Overview
Search process definitions
POST
Get a process definition
GET
Get the BPMN source of a definition
GET
Get the start form of a process
GET
Count element instances per element of a definition
POST
Count open message subscriptions per process definition
POST
Search message subscriptions
POST
Element instances
Overview
Get an element instance
GET
Search element instances
POST
Variables
Overview
Set variables in a scope
PUT
Get a variable
GET
Search variables
POST
User tasks
Overview
Search user tasks
POST
Get a user task
GET
Update a user task
PATCH
Get a user task's form
GET
Search a user task's variables
POST
Search the variables a user task sees
POST
Search a user task's audit log
POST
Assign or claim a user task
POST
Unassign a user task
DELETE
Complete a user task
POST
Jobs
Overview
Activate jobs for a worker
POST
Complete a job
POST
Fail a job
POST
Throw a business error from a job
POST
Get a job
GET
Update a job
PATCH
Search jobs
POST
Messages
Overview
Publish a message
POST
Correlate a message immediately
POST
Signals
Overview
Broadcast a signal
POST
Incidents
Overview
Search incidents
POST
Get an incident
GET
Search a process instance's incidents
POST
Search an element instance's incidents
POST
Resolve a process instance's incidents
POST
Resolve an incident
POST
Decisions
Overview
Search decision definitions
POST
Search past decision evaluations
POST
Get one decision of a past evaluation
GET
Get the DMN source of a decision
GET
Search decision requirements graphs
POST
Get a decision requirements graph
GET
Get the DMN source of a decision requirements graph
GET
Evaluate a decision
POST
Resources
Overview
Delete a deployed resource
POST
Clock
Overview
Pin the deterministic clock
PUT
Settle the deterministic clock
POST
Identity
Overview
Create a user
POST
Search users
POST
Get a user
GET
Update a user
PUT
Delete a user
DELETE
Create a group
POST
Search groups
POST
Get a group
GET
Update a group
PUT
Delete a group
DELETE
Create a role
POST
Search roles
POST
Get a role
GET
Update a role
PUT
Delete a role
DELETE
Create a mappingrule
POST
Search mappingrules
POST
Get a mappingrule
GET
Update a mappingrule
PUT
Delete a mappingrule
DELETE
Add a user to a group
PUT
Remove a user from a group
DELETE
Add a client to a group
PUT
Remove a client from a group
DELETE
Add a mapping rule to a group
PUT
Remove a mapping rule from a group
DELETE
Add a user to a role
PUT
Remove a user from a role
DELETE
Add a group to a role
PUT
Remove a group from a role
DELETE
Add a client to a role
PUT
Remove a client from a role
DELETE
Add a mapping rule to a role
PUT
Remove a mapping rule from a role
DELETE
Grant permissions
POST
Search grants
POST
Get a grant
GET
Change a grant
PUT
Revoke a grant
DELETE
Register an API client
POST
Search API clients
POST
Get an API client
GET
Delete an API client
DELETE
Rotate a client secret
POST
Revoke an API client
POST
Tenants
Overview
Create a tenant
POST
Search tenants
POST
Get a tenant
GET
Update a tenant
PUT
Delete a tenant (refused; use the purge)
DELETE
Suspend a tenant
POST
Reactivate a tenant
POST
Release a quarantined tenant
DELETE
Move a tenant to another partition
POST
Follow a tenant move
GET
Export a suspended tenant
POST
Import an archive as a new tenant
POST
Ask for the confirmation of a tenant purge
POST
Where a tenant purge stands
GET
Purge a suspended tenant
POST
Add a user to a tenant
PUT
Remove a user from a tenant
DELETE
Add a group to a tenant
PUT
Remove a group from a tenant
DELETE
Add a client to a tenant
PUT
Remove a client from a tenant
DELETE
Add a mapping rule to a tenant
PUT
Remove a mapping rule from a tenant
DELETE
Cluster
Overview
Get the cluster topology
GET
Get the cluster status
GET
Cluster variables
Overview
Create a global cluster variable
POST
Create a tenant cluster variable
POST
Get a global cluster variable
GET
Update a global cluster variable
PUT
Delete a global cluster variable
DELETE
Get a tenant cluster variable
GET
Update a tenant cluster variable
PUT
Delete a tenant cluster variable
DELETE
Search cluster variables
POST
Documents
Overview
Upload a document
POST
Upload several documents
POST
Download a document
GET
Delete a document
DELETE
Create a document link
POST
REST API v1
Overview
Process instances
Overview
Start a process instance
POST
Start a process instance (/api/v1)
POST
Cancel a process instance
POST
Cancel a process instance (/api/v1)
POST
Set process variables
PUT
Set process variables (/api/v1)
PUT
Modify a process instance
POST
Modify a process instance (/api/v1)
POST
Migrate a process instance
POST
Migrate a process instance (/api/v1)
POST
Deployments
Overview
Deploy resources
POST
Deploy resources (/api/v1)
POST
Delete a deployed resource
POST
Delete a deployed resource (/api/v1)
POST
User tasks
Overview
Assign a user task
POST
Assign a user task (/api/v1)
POST
Claim a user task
POST
Claim a user task (/api/v1)
POST
Unassign a user task
POST
Unassign a user task (/api/v1)
POST
Remove a user task assignee
DELETE
Remove a user task assignee (/api/v1)
DELETE
Update a user task
POST
Update a user task (/api/v1)
POST
Complete a user task
POST
Complete a user task (/api/v1)
POST
Search user tasks
POST
Search user tasks (/api/v1)
POST
Jobs
Overview
Activate jobs
POST
Activate jobs (/api/v1)
POST
Update a job timeout
PATCH
Update a job timeout (/api/v1)
PATCH
Complete a job
POST
Complete a job (/api/v1)
POST
Fail a job
POST
Fail a job (/api/v1)
POST
Throw a BPMN error from a job
POST
Throw a BPMN error from a job (/api/v1)
POST
Messages and signals
Overview
Publish a message
POST
Publish a message (/api/v1)
POST
Broadcast a signal
POST
Broadcast a signal (/api/v1)
POST
Decisions
Overview
Evaluate a decision
POST
Evaluate a decision (/api/v1)
POST
Incidents
Overview
Resolve an incident
POST
Resolve an incident (/api/v1)
POST
History
Overview
Search process instance history
POST
Get process instance detail
GET
Search incident history
POST
Search variable history
POST
Search user task history
POST
Get flow node statistics
GET
Get the definition dashboard
GET
Analytics
Overview
Get analytics reports
GET
Get reports for one definition
GET
Audit
Overview
Read the audit log
GET
Check that the stored audit was not changed
GET
Console
Overview
Get the console configuration
GET
Get the health summary for the console
GET
Get the background work of the engine that answers
GET
List deployments for the console
GET
List the partitions for the console
GET
List saved task filters
GET
Save a task filter
POST
Change a saved task filter
PUT
Delete a saved task filter
DELETE
List the processes the caller may start
GET
Get the start form of a startable process
GET
Search deployed processes for the console
POST
List the element templates the engine ships
GET
List the lint rules of the executable profile
GET
Embedded engine
Overview
Read the record stream
GET
Reset the engine
POST
Read the virtual clock
GET
Run work due now
POST
Advance the clock by a duration
POST
Advance the clock to an instant
POST
System
Overview
Liveness check
GET
Health report
GET
Readiness check
GET
Get this OpenAPI document
GET
Get the compatibility statement
GET
Operations
Operations
Observability
Performance and scaling
Hardware requirements
How TinyConductor is checked
Compatibility
Camunda compatibility
Release notes
TinyConductor 0.1.0
Select theme
Dark
Light
Auto
Overview
Messages
Section titled “Messages”
Publish messages and correlate them with waiting instances.
Operations
Section titled “ Operations ”
POST
/v2/messages/publication
POST
/v2/messages/correlation
