Class CamundaClient

Internal accessor for support logger (no public API commitment yet).

Internal invocation helper to apply global backpressure gating + retry + normalization

Activate activities within an ad-hoc sub-process

Activates selected activities within an ad-hoc sub-process identified by element ID. The provided element IDs must exist within the ad-hoc sub-process instance identified by the provided adHocSubProcessInstanceKey.

Activate jobs

Iterate through all known partitions and activate jobs up to the requested maximum.

Assign a client to a group

Assigns a client to a group, making it a member of the group. Members of the group inherit the group authorizations, roles, and tenant assignments.

Assign a client to a tenant

Assign the client to the specified tenant. The client can then access tenant data and perform authorized actions.

Assign a group to a tenant

Assigns a group to a specified tenant. Group members (users, clients) can then access tenant data and perform authorized actions.

Assign a mapping rule to a group

Assigns a mapping rule to a group. *

Assign a mapping rule to a tenant

Assign a single mapping rule to a specified tenant. *

Assign a role to a client

Assigns the specified role to the client. The client will inherit the authorizations associated with this role. *

Assign a role to a group

Assigns the specified role to the group. Every member of the group (user or client) will inherit the authorizations associated with this role. *

Assign a role to a mapping rule

Assigns a role to a mapping rule. *

Assign a role to a tenant

Assigns a role to a specified tenant. Users, Clients or Groups, that have the role assigned, will get access to the tenant's data and can perform actions according to their authorizations.

Assign a role to a user

Assigns the specified role to the user. The user will inherit the authorizations associated with this role. *

Assign user task

Assigns a user task with the given key to the given assignee. *

Assign a user to a group

Assigns a user to a group, making the user a member of the group. Group members inherit the group authorizations, roles, and tenant assignments.

Assign a user to a tenant

Assign a single user to a specified tenant. The user can then access tenant data and perform authorized actions. *

Broadcast signal

Broadcasts a signal. *

Cancel Batch operation

Cancels a running batch operation. This is done asynchronously, the progress can be tracked using the batch operation status endpoint (/batch-operations/{batchOperationKey}).

Cancel process instance

Cancels a running process instance. As a cancellation includes more than just the removal of the process instance resource, the cancellation resource must be posted. *

Cancel process instances (batch)

Cancels multiple running process instances. Since only ACTIVE root instances can be cancelled, any given filters for state and parentProcessInstanceKey are ignored and overridden during this batch operation. This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}).

Complete job

Complete a job with the given payload, which allows completing the associated service task.

Complete user task

Completes a user task with the given key. *

Correlate message

Publishes a message and correlates it to a subscription. If correlation is successful it will return the first process instance key the message correlated with. The message is not buffered. Use the publish message endpoint to send messages that can be buffered.

Create admin user

Creates a new user and assigns the admin role to it. This endpoint is only usable when users are managed in the Orchestration Cluster and while no user is assigned to the admin role. *

Create authorization

Create the authorization. *

Deploy resources

Deploys one or more resources (e.g. processes, decision models, or forms). This is an atomic call, i.e. either all resources are deployed or none of them are.

Upload document

Upload a document to the Camunda 8 cluster.

Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)

Create document link

Create a link to a document in the Camunda 8 cluster.

Note that this is currently supported for document stores of type: AWS, GCP

Upload multiple documents

Upload multiple documents to the Camunda 8 cluster.

The caller must provide a file name for each document, which will be used in case of a multi-status response to identify which documents failed to upload. The file name can be provided in the Content-Disposition header of the file part or in the fileName field of the metadata. You can add a parallel array of metadata objects. These are matched with the files based on index, and must have the same length as the files array. To pass homogenous metadata for all files, spread the metadata over the metadata array. A filename value provided explicitly via the metadata array in the request overrides the Content-Disposition header of the file part.

In case of a multi-status response, the response body will contain a list of DocumentBatchProblemDetail objects, each of which contains the file name of the document that failed to upload and the reason for the failure. The client can choose to retry the whole batch or individual documents based on the response.

Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)

Update element instance variables

Updates all the variables of a particular scope (for example, process instance, element instance) with the given variable data. Specify the element instance in the elementInstanceKey parameter.

Create a global-scoped cluster variable *

Create group

Create a new group. *

Create a job worker that activates and processes jobs of the given type.

Create mapping rule

Create a new mapping rule

Create process instance

Creates and starts an instance of the specified process. The process definition to use to create the instance can be specified either using its unique key (as returned by Deploy resources), or using the BPMN process id and a version.

Waits for the completion of the process instance before returning a result when awaitCompletion is enabled.

Create role

Create a new role. *

Create tenant

Creates a new tenant. *

Create a tenant-scoped cluster variable *

Create user

Create a new user. *

Delete authorization

Deletes the authorization with the given key. *

Delete document

Delete a document from the Camunda 8 cluster.

Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)

Delete a global-scoped cluster variable *

Delete group

Deletes the group with the given ID. *

Delete a mapping rule

Deletes the mapping rule with the given ID.

Delete process instance

Deletes a process instance. Only instances that are completed or terminated can be deleted. *

Delete process instances (batch)

Delete multiple process instances. This will delete the historic data from secondary storage. Only process instances in a final state (COMPLETED or TERMINATED) can be deleted. This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}).

Delete resource

Deletes a deployed resource. This can be a process definition, decision requirements definition, or form definition deployed using the deploy resources endpoint. Specify the resource you want to delete in the resourceKey parameter.

Once a resource has been deleted it cannot be recovered. If the resource needs to be available again, a new deployment of the resource is required.

By default, only the resource itself is deleted from the runtime state. To also delete the historic data associated with a resource, set the deleteHistory flag in the request body to true. The historic data is deleted asynchronously via a batch operation. The details of the created batch operation are included in the response. Note that history deletion is only supported for process resources; for other resource types this flag is ignored and no history will be deleted. *

Delete role

Deletes the role with the given ID. *

Delete tenant

Deletes an existing tenant. *

Delete a tenant-scoped cluster variable *

Delete user

Deletes a user. *

Node-only convenience: deploy resources from local filesystem paths.

Emit the standard support log preamble & redacted configuration to the current support logger. Safe to call multiple times; subsequent calls are ignored (idempotent). Useful when a custom supportLogger was injected and you still want the canonical header & config dump.

Evaluate root level conditional start events

Evaluates root-level conditional start events for process definitions. If the evaluation is successful, it will return the keys of all created process instances, along with their associated process definition key. Multiple root-level conditional start events of the same process definition can trigger if their conditions evaluate to true.

Evaluate decision

Evaluates a decision. You specify the decision to evaluate either by using its unique key (as returned by DeployResource), or using the decision ID. When using the decision ID, the latest deployed version of the decision is used.

Evaluate an expression

Evaluates a FEEL expression and returns the result. Supports references to tenant scoped cluster variables when a tenant ID is provided. *

Fail job

Mark the job as failed.

Get audit log

Get an audit log entry by auditLogKey. *

Get current user

Retrieves the current authenticated user. *

Get authorization

Get authorization by the given key. *

Public accessor for current backpressure adaptive limiter state (stable)

Get batch operation

Get batch operation by key. *

Read-only snapshot of current hydrated configuration (do not mutate directly). Use configure(...) to apply changes.

Get decision definition

Returns a decision definition by key. *

Get decision definition XML

Returns decision definition as XML. *

Get decision instance

Returns a decision instance. *

Get decision requirements

Returns Decision Requirements as JSON. *

Get decision requirements XML

Returns decision requirements as XML. *

Download document

Download a document from the Camunda 8 cluster.

Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)

Get element instance

Returns element instance as JSON. *

Internal accessor (read-only) for eventual consistency error mode.

Get a global-scoped cluster variable *

Global job statistics

Returns global aggregated counts for jobs. Optionally filter by the creation time window and/or jobType.

Get group

Get a group by its ID. *

Get incident

Returns incident as JSON.

Get license status

Obtains the status of the current Camunda license. *

Get a mapping rule

Gets the mapping rule with the given ID.

Get process definition

Returns process definition as JSON. *

Get process instance statistics

Get statistics about process instances, grouped by process definition and tenant.

Get process instance statistics by version

Get statistics about process instances, grouped by version for a given process definition.

Get message subscription statistics

Get message subscription statistics, grouped by process definition.