Skip to main content
Version: 8.9 (unreleased)

Key Types

Technical Preview

The C# SDK is a technical preview available from Camunda 8.9. It will become fully supported in Camunda 8.10. Its API surface may change in future releases without following semver.

Strongly-typed domain key types provide compile-time safety for entity identifiers. Each key wraps a string value and ensures type-safe API calls.

Overview​

Key TypeDescription
AuditLogEntityKeySystem-generated entity key for an audit log entry.
AuditLogKeySystem-generated key for an audit log entry.
AuthorizationKeySystem-generated key for an authorization.
BatchOperationKeySystem-generated key for an batch operation.
ConditionalEvaluationKeySystem-generated key for a conditional evaluation.
DecisionDefinitionKeySystem-generated key for a decision definition.
DecisionEvaluationInstanceKeySystem-generated key for a decision evaluation instance.
DecisionEvaluationKeySystem-generated key for a decision evaluation.
DecisionInstanceKeySystem-generated key for a deployed decision instance.
DecisionRequirementsKeySystem-generated key for a deployed decision requirements definition.
DeploymentKeyKey for a deployment.
ElementInstanceKeySystem-generated key for a element instance.
FormKeySystem-generated key for a deployed form.
IncidentKeySystem-generated key for a incident.
JobKeySystem-generated key for a job.
LongKeyZeebe Engine resource key (Java long serialized as string)
MessageKeySystem-generated key for an message.
MessageSubscriptionKeySystem-generated key for a message subscription.
ProcessDefinitionKeySystem-generated key for a deployed process definition.
ProcessInstanceKeySystem-generated key for a process instance.
ResourceKeyThe system-assigned key for this resource.
RootProcessInstanceKeyThe key of the root process instance. The root process instance is the top-level

ancestor in the process instance hierarchy. This field is only present for data belonging to process instance hierarchies created in version 8.9 or later. | | ScopeKey | System-generated key for a scope. | | SignalKey | System-generated key for an signal. | | UserTaskKey | System-generated key for a user task. | | VariableKey | System-generated key for a variable. |

Common Methods​

All key types share these methods:

MethodDescription
AssumeExists(string)Creates a key from a known-valid string value.
IsValid(string)Validates whether a string is a valid key value.
ValueGets the underlying string value.
ToString()Returns the string representation.

Details​

AuditLogEntityKey​

System-generated entity key for an audit log entry.

public readonly record struct AuditLogEntityKey : ICamundaKey, IEquatable<AuditLogEntityKey>

AuditLogKey​

System-generated key for an audit log entry.

public readonly record struct AuditLogKey : ICamundaKey, IEquatable<AuditLogKey>

AuthorizationKey​

System-generated key for an authorization.

public readonly record struct AuthorizationKey : ICamundaKey, IEquatable<AuthorizationKey>

BatchOperationKey​

System-generated key for an batch operation.

public readonly record struct BatchOperationKey : ICamundaKey, IEquatable<BatchOperationKey>

ConditionalEvaluationKey​

System-generated key for a conditional evaluation.

public readonly record struct ConditionalEvaluationKey : ICamundaKey, IEquatable<ConditionalEvaluationKey>

DecisionDefinitionKey​

System-generated key for a decision definition.

public readonly record struct DecisionDefinitionKey : ICamundaKey, IEquatable<DecisionDefinitionKey>

DecisionEvaluationInstanceKey​

System-generated key for a decision evaluation instance.

public readonly record struct DecisionEvaluationInstanceKey : ICamundaKey, IEquatable<DecisionEvaluationInstanceKey>

DecisionEvaluationKey​

System-generated key for a decision evaluation.

public readonly record struct DecisionEvaluationKey : ICamundaKey, IEquatable<DecisionEvaluationKey>

DecisionInstanceKey​

System-generated key for a deployed decision instance.

public readonly record struct DecisionInstanceKey : ICamundaKey, IEquatable<DecisionInstanceKey>

DecisionRequirementsKey​

System-generated key for a deployed decision requirements definition.

public readonly record struct DecisionRequirementsKey : ICamundaKey, IEquatable<DecisionRequirementsKey>

DeploymentKey​

Key for a deployment.

public readonly record struct DeploymentKey : ICamundaKey, IEquatable<DeploymentKey>

ElementInstanceKey​

System-generated key for a element instance.

public readonly record struct ElementInstanceKey : ICamundaKey, IEquatable<ElementInstanceKey>

FormKey​

System-generated key for a deployed form.

public readonly record struct FormKey : ICamundaKey, IEquatable<FormKey>

IncidentKey​

System-generated key for a incident.

public readonly record struct IncidentKey : ICamundaKey, IEquatable<IncidentKey>

JobKey​

System-generated key for a job.

public readonly record struct JobKey : ICamundaKey, IEquatable<JobKey>

LongKey​

Zeebe Engine resource key (Java long serialized as string)

public readonly record struct LongKey : ICamundaKey, IEquatable<LongKey>

MessageKey​

System-generated key for an message.

public readonly record struct MessageKey : ICamundaKey, IEquatable<MessageKey>

MessageSubscriptionKey​

System-generated key for a message subscription.

public readonly record struct MessageSubscriptionKey : ICamundaKey, IEquatable<MessageSubscriptionKey>

ProcessDefinitionKey​

System-generated key for a deployed process definition.

public readonly record struct ProcessDefinitionKey : ICamundaKey, IEquatable<ProcessDefinitionKey>

ProcessInstanceKey​

System-generated key for a process instance.

public readonly record struct ProcessInstanceKey : ICamundaKey, IEquatable<ProcessInstanceKey>

ResourceKey​

The system-assigned key for this resource.

public readonly record struct ResourceKey : ICamundaKey, IEquatable<ResourceKey>

RootProcessInstanceKey​

The key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy. This field is only present for data belonging to process instance hierarchies created in version 8.9 or later.

public readonly record struct RootProcessInstanceKey : ICamundaKey, IEquatable<RootProcessInstanceKey>

ScopeKey​

System-generated key for a scope.

public readonly record struct ScopeKey : ICamundaKey, IEquatable<ScopeKey>

SignalKey​

System-generated key for an signal.

public readonly record struct SignalKey : ICamundaKey, IEquatable<SignalKey>

UserTaskKey​

System-generated key for a user task.

public readonly record struct UserTaskKey : ICamundaKey, IEquatable<UserTaskKey>

VariableKey​

System-generated key for a variable.

public readonly record struct VariableKey : ICamundaKey, IEquatable<VariableKey>