Skip to main content
Version: 8.9 (unreleased)

Models

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.

Request and response model classes (506 types).

Quick Reference​

ActivateJobsResponse​

The list of activated jobs

public sealed class ActivateJobsResponse
PropertyTypeDescription
JobsList<ActivatedJobResult>The activated jobs.

ActivatedJobResult​

ActivatedJobResult

public sealed class ActivatedJobResult
PropertyTypeDescription
TypeStringThe type of the job (should match what was requested).
ProcessDefinitionIdProcessDefinitionIdThe bpmn process ID of the job's process definition.
ProcessDefinitionVersionInt32The version of the job's process definition.
ElementIdElementIdThe associated task element ID.
CustomHeadersObjectA set of custom headers defined during modelling; returned as a serialized JSON document.
WorkerStringThe name of the worker which activated this job.
RetriesInt32The amount of retries left to this job (should always be positive).
DeadlineInt64When the job can be activated again, sent as a UNIX epoch timestamp.
VariablesObjectAll variables visible to the task scope, computed at activation time.
TenantIdTenantIdThe ID of the tenant that owns the job.
JobKeyJobKeyThe key, a unique identifier for the job.
ProcessInstanceKeyProcessInstanceKeyThe job's process instance key.
ProcessDefinitionKeyProcessDefinitionKeyThe key of the job's process definition.
ElementInstanceKeyElementInstanceKey
KindJobKindEnumThe job kind.
ListenerEventTypeJobListenerEventTypeEnumThe listener event type of the job.
UserTaskUserTaskPropertiesContains properties of a user task.
TagsList<Tag>List of tags. Tags need to start with a letter; then alphanumerics, _, -, :, or .; length ≤ 100.

AdHocSubProcessActivateActivitiesInstruction​

AdHocSubProcessActivateActivitiesInstruction

public sealed class AdHocSubProcessActivateActivitiesInstruction
PropertyTypeDescription
ElementsList<AdHocSubProcessActivateActivityReference>Activities to activate.
CancelRemainingInstancesNullable<Boolean>Whether to cancel remaining instances of the ad-hoc sub-process.

AdHocSubProcessActivateActivityReference​

AdHocSubProcessActivateActivityReference

public sealed class AdHocSubProcessActivateActivityReference
PropertyTypeDescription
ElementIdElementIdThe ID of the element that should be activated.
VariablesObjectVariables to be set when activating the element.

AdvancedActorTypeFilter​

Advanced AuditLogActorTypeEnum filter.

public sealed class AdvancedActorTypeFilter
PropertyTypeDescription
EqNullable<AuditLogActorTypeEnum>Checks for equality with the provided value.
NeqNullable<AuditLogActorTypeEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<AuditLogActorTypeEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedAuditLogEntityKeyFilter​

Advanced entityKey filter.

public sealed class AdvancedAuditLogEntityKeyFilter
PropertyTypeDescription
EqNullable<AuditLogEntityKey>Checks for equality with the provided value.
NeqNullable<AuditLogEntityKey>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<AuditLogEntityKey>Checks if the property matches any of the provided values.
NotInList<AuditLogEntityKey>Checks if the property matches none of the provided values.

AdvancedAuditLogKeyFilter​

Advanced AuditLogKey filter.

public sealed class AdvancedAuditLogKeyFilter
PropertyTypeDescription
EqNullable<AuditLogKey>Checks for equality with the provided value.
NeqNullable<AuditLogKey>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<AuditLogKey>Checks if the property matches any of the provided values.
NotInList<AuditLogKey>Checks if the property matches none of the provided values.

AdvancedBatchOperationItemStateFilter​

Advanced BatchOperationItemStateEnum filter.

public sealed class AdvancedBatchOperationItemStateFilter
PropertyTypeDescription
EqNullable<BatchOperationItemStateEnum>Checks for equality with the provided value.
NeqNullable<BatchOperationItemStateEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<BatchOperationItemStateEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedBatchOperationStateFilter​

Advanced BatchOperationStateEnum filter.

public sealed class AdvancedBatchOperationStateFilter
PropertyTypeDescription
EqNullable<BatchOperationStateEnum>Checks for equality with the provided value.
NeqNullable<BatchOperationStateEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<BatchOperationStateEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedBatchOperationTypeFilter​

Advanced BatchOperationTypeEnum filter.

public sealed class AdvancedBatchOperationTypeFilter
PropertyTypeDescription
EqNullable<BatchOperationTypeEnum>Checks for equality with the provided value.
NeqNullable<BatchOperationTypeEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<BatchOperationTypeEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedCategoryFilter​

Advanced AuditLogCategoryEnum filter.

public sealed class AdvancedCategoryFilter
PropertyTypeDescription
EqNullable<AuditLogCategoryEnum>Checks for equality with the provided value.
NeqNullable<AuditLogCategoryEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<AuditLogCategoryEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedClusterVariableScopeFilter​

Advanced ClusterVariableScopeEnum filter.

public sealed class AdvancedClusterVariableScopeFilter
PropertyTypeDescription
EqNullable<ClusterVariableScopeEnum>Checks for equality with the provided value.
NeqNullable<ClusterVariableScopeEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<ClusterVariableScopeEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedDateTimeFilter​

Advanced date-time filter.

public sealed class AdvancedDateTimeFilter
PropertyTypeDescription
EqNullable<DateTimeOffset>Checks for equality with the provided value.
NeqNullable<DateTimeOffset>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
GtNullable<DateTimeOffset>Greater than comparison with the provided value.
GteNullable<DateTimeOffset>Greater than or equal comparison with the provided value.
LtNullable<DateTimeOffset>Lower than comparison with the provided value.
LteNullable<DateTimeOffset>Lower than or equal comparison with the provided value.
InList<DateTimeOffset>Checks if the property matches any of the provided values.

AdvancedDecisionDefinitionKeyFilter​

Advanced DecisionDefinitionKey filter.

public sealed class AdvancedDecisionDefinitionKeyFilter
PropertyTypeDescription
EqNullable<DecisionDefinitionKey>Checks for equality with the provided value.
NeqNullable<DecisionDefinitionKey>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<DecisionDefinitionKey>Checks if the property matches any of the provided values.
NotInList<DecisionDefinitionKey>Checks if the property matches none of the provided values.

AdvancedDecisionEvaluationInstanceKeyFilter​

Advanced DecisionEvaluationInstanceKey filter.

public sealed class AdvancedDecisionEvaluationInstanceKeyFilter
PropertyTypeDescription
EqNullable<DecisionEvaluationInstanceKey>Checks for equality with the provided value.
NeqNullable<DecisionEvaluationInstanceKey>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<DecisionEvaluationInstanceKey>Checks if the property matches any of the provided values.
NotInList<DecisionEvaluationInstanceKey>Checks if the property matches none of the provided values.

AdvancedDecisionEvaluationKeyFilter​

Advanced DecisionEvaluationKey filter.

public sealed class AdvancedDecisionEvaluationKeyFilter
PropertyTypeDescription
EqNullable<DecisionEvaluationKey>Checks for equality with the provided value.
NeqNullable<DecisionEvaluationKey>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<DecisionEvaluationKey>Checks if the property matches any of the provided values.
NotInList<DecisionEvaluationKey>Checks if the property matches none of the provided values.

AdvancedDecisionInstanceStateFilter​

Advanced DecisionInstanceStateEnum filter.

public sealed class AdvancedDecisionInstanceStateFilter
PropertyTypeDescription
EqNullable<DecisionInstanceStateEnum>Checks for equality with the provided value.
NeqNullable<DecisionInstanceStateEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<DecisionInstanceStateEnum>Checks if the property matches any of the provided values.
NotInList<DecisionInstanceStateEnum>Checks if the property matches none of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedDecisionRequirementsKeyFilter​

Advanced DecisionRequirementsKey filter.

public sealed class AdvancedDecisionRequirementsKeyFilter
PropertyTypeDescription
EqNullable<DecisionRequirementsKey>Checks for equality with the provided value.
NeqNullable<DecisionRequirementsKey>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<DecisionRequirementsKey>Checks if the property matches any of the provided values.
NotInList<DecisionRequirementsKey>Checks if the property matches none of the provided values.

AdvancedDeploymentKeyFilter​

Advanced DeploymentKey filter.

public sealed class AdvancedDeploymentKeyFilter
PropertyTypeDescription
EqNullable<DeploymentKey>Checks for equality with the provided value.
NeqNullable<DeploymentKey>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<DeploymentKey>Checks if the property matches any of the provided values.
NotInList<DeploymentKey>Checks if the property matches none of the provided values.

AdvancedElementInstanceKeyFilter​

Advanced ElementInstanceKey filter.

public sealed class AdvancedElementInstanceKeyFilter
PropertyTypeDescription
EqNullable<ElementInstanceKey>Checks for equality with the provided value.
NeqNullable<ElementInstanceKey>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<ElementInstanceKey>Checks if the property matches any of the provided values.
NotInList<ElementInstanceKey>Checks if the property matches none of the provided values.

AdvancedElementInstanceStateFilter​

Advanced ElementInstanceStateEnum filter.

public sealed class AdvancedElementInstanceStateFilter
PropertyTypeDescription
EqNullable<ElementInstanceStateEnum>Checks for equality with the provided value.
NeqNullable<ElementInstanceStateEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<ElementInstanceStateEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedEntityTypeFilter​

Advanced AuditLogEntityTypeEnum filter.

public sealed class AdvancedEntityTypeFilter
PropertyTypeDescription
EqNullable<AuditLogEntityTypeEnum>Checks for equality with the provided value.
NeqNullable<AuditLogEntityTypeEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<AuditLogEntityTypeEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedFormKeyFilter​

Advanced FormKey filter.

public sealed class AdvancedFormKeyFilter
PropertyTypeDescription
EqNullable<FormKey>Checks for equality with the provided value.
NeqNullable<FormKey>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<FormKey>Checks if the property matches any of the provided values.
NotInList<FormKey>Checks if the property matches none of the provided values.

AdvancedIncidentErrorTypeFilter​

Advanced IncidentErrorTypeEnum filter

public sealed class AdvancedIncidentErrorTypeFilter
PropertyTypeDescription
EqIncidentErrorTypeEnumChecks for equality with the provided value.
NeqIncidentErrorTypeEnumChecks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<IncidentErrorTypeEnum>Checks if the property matches any of the provided values.
NotInList<IncidentErrorTypeEnum>Checks if the property does not match any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedIncidentStateFilter​

Advanced IncidentStateEnum filter

public sealed class AdvancedIncidentStateFilter
PropertyTypeDescription
EqIncidentStateEnumChecks for equality with the provided value.
NeqIncidentStateEnumChecks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<IncidentStateEnum>Checks if the property matches any of the provided values.
NotInList<IncidentStateEnum>Checks if the property does not match any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedIntegerFilter​

Advanced integer (int32) filter.

public sealed class AdvancedIntegerFilter
PropertyTypeDescription
EqNullable<Int32>Checks for equality with the provided value.
NeqNullable<Int32>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
GtNullable<Int32>Greater than comparison with the provided value.
GteNullable<Int32>Greater than or equal comparison with the provided value.
LtNullable<Int32>Lower than comparison with the provided value.
LteNullable<Int32>Lower than or equal comparison with the provided value.
InList<Int32>Checks if the property matches any of the provided values.

AdvancedJobKeyFilter​

Advanced JobKey filter.

public sealed class AdvancedJobKeyFilter
PropertyTypeDescription
EqNullable<JobKey>Checks for equality with the provided value.
NeqNullable<JobKey>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<JobKey>Checks if the property matches any of the provided values.
NotInList<JobKey>Checks if the property matches none of the provided values.

AdvancedJobKindFilter​

Advanced JobKindEnum filter.

public sealed class AdvancedJobKindFilter
PropertyTypeDescription
EqNullable<JobKindEnum>Checks for equality with the provided value.
NeqNullable<JobKindEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<JobKindEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedJobListenerEventTypeFilter​

Advanced JobListenerEventTypeEnum filter.

public sealed class AdvancedJobListenerEventTypeFilter
PropertyTypeDescription
EqNullable<JobListenerEventTypeEnum>Checks for equality with the provided value.
NeqNullable<JobListenerEventTypeEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<JobListenerEventTypeEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedJobStateFilter​

Advanced JobStateEnum filter.

public sealed class AdvancedJobStateFilter
PropertyTypeDescription
EqNullable<JobStateEnum>Checks for equality with the provided value.
NeqNullable<JobStateEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<JobStateEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedMessageSubscriptionKeyFilter​

Advanced MessageSubscriptionKey filter.

public sealed class AdvancedMessageSubscriptionKeyFilter
PropertyTypeDescription
EqNullable<MessageSubscriptionKey>Checks for equality with the provided value.
NeqNullable<MessageSubscriptionKey>Checks for equality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<MessageSubscriptionKey>Checks if the property matches any of the provided values.
NotInList<MessageSubscriptionKey>Checks if the property matches none of the provided values.

AdvancedMessageSubscriptionStateFilter​

Advanced MessageSubscriptionStateEnum filter

public sealed class AdvancedMessageSubscriptionStateFilter
PropertyTypeDescription
EqNullable<MessageSubscriptionStateEnum>Checks for equality with the provided value.
NeqNullable<MessageSubscriptionStateEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<MessageSubscriptionStateEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedOperationTypeFilter​

Advanced AuditLogOperationTypeEnum filter.

public sealed class AdvancedOperationTypeFilter
PropertyTypeDescription
EqNullable<AuditLogOperationTypeEnum>Checks for equality with the provided value.
NeqNullable<AuditLogOperationTypeEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<AuditLogOperationTypeEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedProcessDefinitionKeyFilter​

Advanced ProcessDefinitionKey filter.

public sealed class AdvancedProcessDefinitionKeyFilter
PropertyTypeDescription
EqNullable<ProcessDefinitionKey>Checks for equality with the provided value.
NeqNullable<ProcessDefinitionKey>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<ProcessDefinitionKey>Checks if the property matches any of the provided values.
NotInList<ProcessDefinitionKey>Checks if the property matches none of the provided values.

AdvancedProcessInstanceKeyFilter​

Advanced ProcessInstanceKey filter.

public sealed class AdvancedProcessInstanceKeyFilter
PropertyTypeDescription
EqNullable<ProcessInstanceKey>Checks for equality with the provided value.
NeqNullable<ProcessInstanceKey>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<ProcessInstanceKey>Checks if the property matches any of the provided values.
NotInList<ProcessInstanceKey>Checks if the property matches none of the provided values.

AdvancedProcessInstanceStateFilter​

Advanced ProcessInstanceStateEnum filter.

public sealed class AdvancedProcessInstanceStateFilter
PropertyTypeDescription
EqNullable<ProcessInstanceStateEnum>Checks for equality with the provided value.
NeqNullable<ProcessInstanceStateEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<ProcessInstanceStateEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedResourceKeyFilter​

Advanced ResourceKey filter.

public sealed class AdvancedResourceKeyFilter
PropertyTypeDescription
EqNullable<ResourceKey>Checks for equality with the provided value.
NeqNullable<ResourceKey>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<ResourceKey>Checks if the property matches any of the provided values.
NotInList<ResourceKey>Checks if the property matches none of the provided values.

AdvancedResultFilter​

Advanced AuditLogResultEnum filter.

public sealed class AdvancedResultFilter
PropertyTypeDescription
EqNullable<AuditLogResultEnum>Checks for equality with the provided value.
NeqNullable<AuditLogResultEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<AuditLogResultEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedScopeKeyFilter​

Advanced ScopeKey filter.

public sealed class AdvancedScopeKeyFilter
PropertyTypeDescription
EqNullable<ScopeKey>Checks for equality with the provided value.
NeqNullable<ScopeKey>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<ScopeKey>Checks if the property matches any of the provided values.
NotInList<ScopeKey>Checks if the property matches none of the provided values.

AdvancedStringFilter​

Advanced string filter.

public sealed class AdvancedStringFilter
PropertyTypeDescription
EqStringChecks for equality with the provided value.
NeqStringChecks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<String>Checks if the property matches any of the provided values.
NotInList<String>Checks if the property matches none of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedUserTaskStateFilter​

Advanced UserTaskStateEnum filter.

public sealed class AdvancedUserTaskStateFilter
PropertyTypeDescription
EqNullable<UserTaskStateEnum>Checks for equality with the provided value.
NeqNullable<UserTaskStateEnum>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<UserTaskStateEnum>Checks if the property matches any of the provided values.
LikeNullable<LikeFilter>Checks if the property matches the provided like value. Supported wildcard characters are: _ _: matches zero, one, or multiple characters. * ?: matches one, single character. Wildcard characters can be escaped with backslash, for instance: \*.

AdvancedVariableKeyFilter​

Advanced VariableKey filter.

public sealed class AdvancedVariableKeyFilter
PropertyTypeDescription
EqNullable<VariableKey>Checks for equality with the provided value.
NeqNullable<VariableKey>Checks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<VariableKey>Checks if the property matches any of the provided values.
NotInList<VariableKey>Checks if the property matches none of the provided values.

AncestorScopeInstruction​

Defines the ancestor scope for the created element instances. The default behavior resembles a "direct" scope instruction with an ancestorElementInstanceKey of "-1".

public abstract class AncestorScopeInstruction

AuditLogActorTypeExactMatch​

Matches the value exactly.

public readonly record struct AuditLogActorTypeExactMatch : ICamundaKey, IEquatable<AuditLogActorTypeExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

AuditLogActorTypeFilterProperty​

AuditLogActorTypeEnum property with full advanced search capabilities.

public sealed class AuditLogActorTypeFilterProperty

AuditLogEntityKeyExactMatch​

Matches the value exactly.

public readonly record struct AuditLogEntityKeyExactMatch : ICamundaKey, IEquatable<AuditLogEntityKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

AuditLogEntityKeyFilterProperty​

EntityKey property with full advanced search capabilities.

public sealed class AuditLogEntityKeyFilterProperty

AuditLogFilter​

Audit log filter request

public sealed class AuditLogFilter
PropertyTypeDescription
AuditLogKeyAuditLogKeyFilterPropertyThe audit log key search filter.
ProcessDefinitionKeyProcessDefinitionKeyFilterPropertyThe process definition key search filter.
ProcessInstanceKeyProcessInstanceKeyFilterPropertyThe process instance key search filter.
ElementInstanceKeyElementInstanceKeyFilterPropertyThe element instance key search filter.
OperationTypeOperationTypeFilterPropertyThe operation type search filter.
ResultAuditLogResultFilterPropertyThe result search filter.
TimestampDateTimeFilterPropertyThe timestamp search filter.
ActorIdStringFilterPropertyThe actor ID search filter.
ActorTypeAuditLogActorTypeFilterPropertyThe actor type search filter.
EntityKeyAuditLogEntityKeyFilterPropertyThe entity key search filter.
EntityTypeEntityTypeFilterPropertyThe entity type search filter.
TenantIdStringFilterPropertyThe tenant ID search filter.
CategoryCategoryFilterPropertyThe category search filter.
DeploymentKeyDeploymentKeyFilterPropertyThe deployment key search filter.
FormKeyFormKeyFilterPropertyThe form key search filter.
ResourceKeyResourceKeyFilterPropertyThe resource key search filter.
BatchOperationTypeBatchOperationTypeFilterPropertyThe batch operation type search filter.
ProcessDefinitionIdStringFilterPropertyThe process definition ID search filter.
JobKeyJobKeyFilterPropertyThe job key search filter.
UserTaskKeyBasicStringFilterPropertyThe user task key search filter.
DecisionRequirementsIdStringFilterPropertyThe decision requirements ID search filter.
DecisionRequirementsKeyDecisionRequirementsKeyFilterPropertyThe decision requirements key search filter.
DecisionDefinitionIdStringFilterPropertyThe decision definition ID search filter.
DecisionDefinitionKeyDecisionDefinitionKeyFilterPropertyThe decision definition key search filter.
DecisionEvaluationKeyDecisionEvaluationKeyFilterPropertyThe decision evaluation key search filter.
RelatedEntityKeyAuditLogEntityKeyFilterPropertyThe related entity key search filter.
RelatedEntityTypeEntityTypeFilterPropertyThe related entity type search filter.
EntityDescriptionStringFilterPropertyThe entity description filter.

AuditLogKeyExactMatch​

Matches the value exactly.

public readonly record struct AuditLogKeyExactMatch : ICamundaKey, IEquatable<AuditLogKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

AuditLogKeyFilterProperty​

AuditLogKey property with full advanced search capabilities.

public sealed class AuditLogKeyFilterProperty

AuditLogResult​

Audit log item.

public sealed class AuditLogResult
PropertyTypeDescription
AuditLogKeyNullable<AuditLogKey>The unique key of the audit log entry.
EntityKeyNullable<AuditLogEntityKey>System-generated entity key for an audit log entry.
EntityTypeNullable<AuditLogEntityTypeEnum>The type of entity affected by the operation.
OperationTypeNullable<AuditLogOperationTypeEnum>The type of operation performed.
BatchOperationKeyNullable<BatchOperationKey>Key of the batch operation.
BatchOperationTypeNullable<BatchOperationTypeEnum>The type of batch operation performed, if this is part of a batch.
TimestampNullable<DateTimeOffset>The timestamp when the operation occurred.
ActorIdStringThe ID of the actor who performed the operation.
ActorTypeNullable<AuditLogActorTypeEnum>The type of actor who performed the operation.
TenantIdNullable<TenantId>The tenant ID of the audit log.
ResultNullable<AuditLogResultEnum>The result status of the operation.
AnnotationStringAdditional notes about the operation.
CategoryNullable<AuditLogCategoryEnum>The category of the audit log operation.
ProcessDefinitionIdNullable<ProcessDefinitionId>The process definition ID.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The key of the process definition.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of the process instance.
RootProcessInstanceKeyNullable<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.
ElementInstanceKeyNullable<ElementInstanceKey>The key of the element instance.
JobKeyNullable<JobKey>The key of the job.
UserTaskKeyNullable<UserTaskKey>The key of the user task.
DecisionRequirementsIdStringThe decision requirements ID.
DecisionRequirementsKeyNullable<DecisionRequirementsKey>The assigned key of the decision requirements.
DecisionDefinitionIdNullable<DecisionDefinitionId>The decision definition ID.
DecisionDefinitionKeyNullable<DecisionDefinitionKey>The key of the decision definition.
DecisionEvaluationKeyNullable<DecisionEvaluationKey>The key of the decision evaluation.
DeploymentKeyNullable<DeploymentKey>The key of the deployment.
FormKeyNullable<FormKey>The key of the form.
ResourceKeyNullable<ResourceKey>The system-assigned key for this resource.
RelatedEntityKeyNullable<AuditLogEntityKey>The key of the related entity. The content depends on the operation type and entity type. For example, for authorization operations, this will contain the ID of the owner (e.g., user or group) the authorization belongs to.
RelatedEntityTypeNullable<AuditLogEntityTypeEnum>The type of the related entity. The content depends on the operation type and entity type. For example, for authorization operations, this will contain the type of the owner (e.g., USER or GROUP) the authorization belongs to.
EntityDescriptionStringAdditional description of the entity affected by the operation. For example, for variable operations, this will contain the variable name.

AuditLogResultExactMatch​

Matches the value exactly.

public readonly record struct AuditLogResultExactMatch : ICamundaKey, IEquatable<AuditLogResultExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

AuditLogResultFilterProperty​

AuditLogResultEnum property with full advanced search capabilities.

public sealed class AuditLogResultFilterProperty

AuditLogSearchQueryRequest​

Audit log search request.

public sealed class AuditLogSearchQueryRequest
PropertyTypeDescription
SortList<AuditLogSearchQuerySortRequest>Sort field criteria.
FilterAuditLogFilterThe audit log search filters.
PageSearchQueryPageRequestPagination criteria.

AuditLogSearchQueryResult​

Audit log search response.

public sealed class AuditLogSearchQueryResult
PropertyTypeDescription
ItemsList<AuditLogResult>The matching audit logs.
PageSearchQueryPageResponsePagination information about the search results.

AuditLogSearchQuerySortRequest​

AuditLogSearchQuerySortRequest

public sealed class AuditLogSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

AuthorizationCreateResult​

AuthorizationCreateResult

public sealed class AuthorizationCreateResult
PropertyTypeDescription
AuthorizationKeyNullable<AuthorizationKey>The key of the created authorization.

AuthorizationFilter​

Authorization search filter.

public sealed class AuthorizationFilter
PropertyTypeDescription
OwnerIdStringThe ID of the owner of permissions.
OwnerTypeNullable<OwnerTypeEnum>The type of the owner of permissions.
ResourceIdsList<String>The IDs of the resource to search permissions for.
ResourcePropertyNamesList<String>The names of the resource properties to search permissions for.
ResourceTypeStringThe type of resource to search permissions for.

AuthorizationIdBasedRequest​

AuthorizationIdBasedRequest

public sealed class AuthorizationIdBasedRequest : AuthorizationRequest
PropertyTypeDescription
OwnerIdStringThe ID of the owner of the permissions.
OwnerTypeOwnerTypeEnumThe type of the owner of permissions.
ResourceIdStringThe ID of the resource to add permissions to.
ResourceTypeStringThe type of resource to add permissions to.
PermissionTypesList<PermissionTypeEnum>The permission types to add.

AuthorizationPropertyBasedRequest​

AuthorizationPropertyBasedRequest

public sealed class AuthorizationPropertyBasedRequest : AuthorizationRequest
PropertyTypeDescription
OwnerIdStringThe ID of the owner of the permissions.
OwnerTypeOwnerTypeEnumThe type of the owner of permissions.
ResourcePropertyNameStringThe name of the resource property on which this authorization is based.
ResourceTypeStringThe type of resource to add permissions to.
PermissionTypesList<PermissionTypeEnum>The permission types to add.

AuthorizationRequest​

Defines an authorization request. Either an id-based or a property-based authorization can be provided.

public abstract class AuthorizationRequest

AuthorizationResult​

AuthorizationResult

public sealed class AuthorizationResult
PropertyTypeDescription
OwnerIdStringThe ID of the owner of permissions.
OwnerTypeNullable<OwnerTypeEnum>The type of the owner of permissions.
ResourceTypeStringThe type of resource that the permissions relate to.
ResourceIdStringID of the resource the permission relates to (mutually exclusive with resourcePropertyName).
ResourcePropertyNameStringThe name of the resource property the permission relates to (mutually exclusive with resourceId).
PermissionTypesList<PermissionTypeEnum>Specifies the types of the permissions.
AuthorizationKeyNullable<AuthorizationKey>The key of the authorization.

AuthorizationSearchQuery​

AuthorizationSearchQuery

public sealed class AuthorizationSearchQuery
PropertyTypeDescription
SortList<AuthorizationSearchQuerySortRequest>Sort field criteria.
FilterAuthorizationFilterThe authorization search filters.
PageSearchQueryPageRequestPagination criteria.

AuthorizationSearchQuerySortRequest​

AuthorizationSearchQuerySortRequest

public sealed class AuthorizationSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

AuthorizationSearchResult​

AuthorizationSearchResult

public sealed class AuthorizationSearchResult
PropertyTypeDescription
ItemsList<AuthorizationResult>The matching authorizations.
PageSearchQueryPageResponsePagination information about the search results.

BaseProcessInstanceFilterFields​

Base process instance search filter.

public sealed class BaseProcessInstanceFilterFields
PropertyTypeDescription
StartDateDateTimeFilterPropertyThe start date.
EndDateDateTimeFilterPropertyThe end date.
StateProcessInstanceStateFilterPropertyThe process instance state.
HasIncidentNullable<Boolean>Whether this process instance has a related incident or not.
TenantIdStringFilterPropertyThe tenant id.
VariablesList<VariableValueFilterProperty>The process instance variables.
ProcessInstanceKeyProcessInstanceKeyFilterPropertyThe key of this process instance.
ParentProcessInstanceKeyProcessInstanceKeyFilterPropertyThe parent process instance key.
ParentElementInstanceKeyElementInstanceKeyFilterPropertyThe parent element instance key.
BatchOperationIdStringFilterPropertyThe batch operation id.
ErrorMessageStringFilterPropertyThe error message related to the process.
HasRetriesLeftNullable<Boolean>Whether the process has failed jobs with retries left.
ElementInstanceStateElementInstanceStateFilterPropertyThe state of the element instances associated with the process instance.
ElementIdStringFilterPropertyThe element id associated with the process instance.
HasElementInstanceIncidentNullable<Boolean>Whether the element instance has an incident or not.
IncidentErrorHashCodeIntegerFilterPropertyThe incident error hash code, associated with this process.
TagsList<Tag>List of tags. Tags need to start with a letter; then alphanumerics, _, -, :, or .; length ≤ 100.

BasicStringFilter​

Basic advanced string filter.

public sealed class BasicStringFilter
PropertyTypeDescription
EqStringChecks for equality with the provided value.
NeqStringChecks for inequality with the provided value.
ExistsNullable<Boolean>Checks if the current property exists.
InList<String>Checks if the property matches any of the provided values.
NotInList<String>Checks if the property matches none of the provided values.

BasicStringFilterProperty​

String property with basic advanced search capabilities.

public sealed class BasicStringFilterProperty

BatchOperationCreatedResult​

The created batch operation.

public sealed class BatchOperationCreatedResult
PropertyTypeDescription
BatchOperationKeyNullable<BatchOperationKey>Key of the batch operation.
BatchOperationTypeNullable<BatchOperationTypeEnum>The type of the batch operation.

BatchOperationError​

BatchOperationError

public sealed class BatchOperationError
PropertyTypeDescription
PartitionIdNullable<Int32>The partition ID where the error occurred.
TypeStringThe type of the error that occurred during the batch operation.
MessageStringThe error message that occurred during the batch operation.

BatchOperationFilter​

Batch operation filter request.

public sealed class BatchOperationFilter
PropertyTypeDescription
BatchOperationKeyBasicStringFilterPropertyThe key (or operate legacy ID) of the batch operation.
OperationTypeBatchOperationTypeFilterPropertyThe type of the batch operation.
StateBatchOperationStateFilterPropertyThe state of the batch operation.
ActorTypeNullable<AuditLogActorTypeEnum>The type of the actor who performed the operation.
ActorIdStringFilterPropertyThe ID of the actor who performed the operation.

BatchOperationItemFilter​

Batch operation item filter request.

public sealed class BatchOperationItemFilter
PropertyTypeDescription
BatchOperationKeyBasicStringFilterPropertyThe key (or operate legacy ID) of the batch operation.
ItemKeyBasicStringFilterPropertyThe key of the item, e.g. a process instance key.
ProcessInstanceKeyProcessInstanceKeyFilterPropertyThe process instance key of the processed item.
StateStringThe state of the batch operation.
OperationTypeBatchOperationTypeFilterPropertyThe type of the batch operation.

BatchOperationItemResponse​

BatchOperationItemResponse

public sealed class BatchOperationItemResponse
PropertyTypeDescription
OperationTypeNullable<BatchOperationTypeEnum>The type of the batch operation.
BatchOperationKeyNullable<BatchOperationKey>The key (or operate legacy ID) of the batch operation.
ItemKeyStringKey of the item, e.g. a process instance key.
ProcessInstanceKeyNullable<ProcessInstanceKey>the process instance key of the processed item.
RootProcessInstanceKeyNullable<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.
StateStringState of the item.
ProcessedDateNullable<DateTimeOffset>the date this item was processed.
ErrorMessageStringthe error message from the engine in case of a failed operation.

BatchOperationItemSearchQuery​

Batch operation item search request.

public sealed class BatchOperationItemSearchQuery
PropertyTypeDescription
SortList<BatchOperationItemSearchQuerySortRequest>Sort field criteria.
FilterBatchOperationItemFilterThe batch operation item search filters.
PageSearchQueryPageRequestPagination criteria.

BatchOperationItemSearchQueryResult​

BatchOperationItemSearchQueryResult

public sealed class BatchOperationItemSearchQueryResult
PropertyTypeDescription
ItemsList<BatchOperationItemResponse>The matching batch operation items.
PageSearchQueryPageResponsePagination information about the search results.

BatchOperationItemSearchQuerySortRequest​

BatchOperationItemSearchQuerySortRequest

public sealed class BatchOperationItemSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

BatchOperationItemStateExactMatch​

Matches the value exactly.

public readonly record struct BatchOperationItemStateExactMatch : ICamundaKey, IEquatable<BatchOperationItemStateExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

BatchOperationItemStateFilterProperty​

BatchOperationItemStateEnum property with full advanced search capabilities.

public sealed class BatchOperationItemStateFilterProperty

BatchOperationResponse​

BatchOperationResponse

public sealed class BatchOperationResponse
PropertyTypeDescription
BatchOperationKeyNullable<BatchOperationKey>Key or (Operate Legacy ID = UUID) of the batch operation.
StateNullable<BatchOperationStateEnum>The batch operation state.
BatchOperationTypeNullable<BatchOperationTypeEnum>The type of the batch operation.
StartDateNullable<DateTimeOffset>The start date of the batch operation.
EndDateNullable<DateTimeOffset>The end date of the batch operation.
ActorTypeNullable<AuditLogActorTypeEnum>The type of actor who performed the operation.
ActorIdStringThe ID of the actor who performed the operation. Available for batch operations created since 8.9.
OperationsTotalCountNullable<Int32>The total number of items contained in this batch operation.
OperationsFailedCountNullable<Int32>The number of items which failed during execution of the batch operation. (e.g. because they are rejected by the Zeebe engine).
OperationsCompletedCountNullable<Int32>The number of successfully completed tasks.
ErrorsList<BatchOperationError>The errors that occurred per partition during the batch operation.

BatchOperationSearchQuery​

Batch operation search request.

public sealed class BatchOperationSearchQuery
PropertyTypeDescription
SortList<BatchOperationSearchQuerySortRequest>Sort field criteria.
FilterBatchOperationFilterThe batch operation search filters.
PageSearchQueryPageRequestPagination criteria.

BatchOperationSearchQueryResult​

The batch operation search query result.

public sealed class BatchOperationSearchQueryResult
PropertyTypeDescription
ItemsList<BatchOperationResponse>The matching batch operations.
PageSearchQueryPageResponsePagination information about the search results.

BatchOperationSearchQuerySortRequest​

BatchOperationSearchQuerySortRequest

public sealed class BatchOperationSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

BatchOperationStateExactMatch​

Matches the value exactly.

public readonly record struct BatchOperationStateExactMatch : ICamundaKey, IEquatable<BatchOperationStateExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

BatchOperationStateFilterProperty​

BatchOperationStateEnum property with full advanced search capabilities.

public sealed class BatchOperationStateFilterProperty

BatchOperationTypeExactMatch​

Matches the value exactly.

public readonly record struct BatchOperationTypeExactMatch : ICamundaKey, IEquatable<BatchOperationTypeExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

BatchOperationTypeFilterProperty​

BatchOperationTypeEnum property with full advanced search capabilities.

public sealed class BatchOperationTypeFilterProperty

BrokerInfo​

Provides information on a broker node.

public sealed class BrokerInfo
PropertyTypeDescription
NodeIdInt32The unique (within a cluster) node ID for the broker.
HostStringThe hostname for reaching the broker.
PortInt32The port for reaching the broker.
PartitionsList<Partition>A list of partitions managed or replicated on this broker.
VersionStringThe broker version.

CamundaUserResult​

CamundaUserResult

public sealed class CamundaUserResult
PropertyTypeDescription
UsernameNullable<Username>The username of the user.
DisplayNameStringThe display name of the user.
EmailStringThe email of the user.
AuthorizedComponentsList<String>The web components the user is authorized to use.
TenantsList<TenantResult>The tenants the user is a member of.
GroupsList<String>The groups assigned to the user.
RolesList<String>The roles assigned to the user.
SalesPlanTypeStringThe plan of the user.
C8LinksDictionary<String>The links to the components in the C8 stack.
CanLogoutBooleanFlag for understanding if the user is able to perform logout.

CancelProcessInstanceRequest​

CancelProcessInstanceRequest

public sealed class CancelProcessInstanceRequest
PropertyTypeDescription
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

CancelProcessInstancesBatchOperationRequest​

The process instance filter that defines which process instances should be canceled.

public sealed class CancelProcessInstancesBatchOperationRequest
PropertyTypeDescription
FilterProcessInstanceFilterThe process instance filter.
OperationReferenceNullable<Int64>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

CategoryExactMatch​

Matches the value exactly.

public readonly record struct CategoryExactMatch : ICamundaKey, IEquatable<CategoryExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

CategoryFilterProperty​

AuditLogCategoryEnum property with full advanced search capabilities.

public sealed class CategoryFilterProperty

Changeset​

JSON object with changed task attribute values.

The following attributes can be adjusted with this endpoint, additional attributes will be ignored:

  • candidateGroups - reset by providing an empty list
  • candidateUsers - reset by providing an empty list
  • dueDate - reset by providing an empty String
  • followUpDate - reset by providing an empty String
  • priority - minimum 0, maximum 100, default 50

Providing any of those attributes with a null value or omitting it preserves the persisted attribute's value.

The assignee cannot be adjusted with this endpoint, use the Assign task endpoint. This ensures correct event emission for assignee changes.

public sealed class Changeset
PropertyTypeDescription
DueDateNullable<DateTimeOffset>The due date of the task. Reset by providing an empty String.
FollowUpDateNullable<DateTimeOffset>The follow-up date of the task. Reset by providing an empty String.
CandidateUsersList<String>The list of candidate users of the task. Reset by providing an empty list.
CandidateGroupsList<String>The list of candidate groups of the task. Reset by providing an empty list.
PriorityNullable<Int32>The priority of the task.

ClockPinRequest​

ClockPinRequest

public sealed class ClockPinRequest
PropertyTypeDescription
TimestampInt64The exact time in epoch milliseconds to which the clock should be pinned.

ClusterVariableResult​

ClusterVariableResult

public sealed class ClusterVariableResult
PropertyTypeDescription
ValueStringFull value of this cluster variable.
NameStringThe name of the cluster variable. Unique within its scope (global or tenant-specific).
ScopeClusterVariableScopeEnumThe scope of a cluster variable.
TenantIdStringOnly provided if the cluster variable scope is TENANT.

ClusterVariableResultBase​

Cluster variable response item.

public sealed class ClusterVariableResultBase
PropertyTypeDescription
NameStringThe name of the cluster variable. Unique within its scope (global or tenant-specific).
ScopeClusterVariableScopeEnumThe scope of a cluster variable.
TenantIdStringOnly provided if the cluster variable scope is TENANT.

ClusterVariableScopeExactMatch​

Matches the value exactly.

public readonly record struct ClusterVariableScopeExactMatch : ICamundaKey, IEquatable<ClusterVariableScopeExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

ClusterVariableScopeFilterProperty​

ClusterVariableScopeEnum property with full advanced search capabilities.

public sealed class ClusterVariableScopeFilterProperty

ClusterVariableSearchQueryFilterRequest​

Cluster variable filter request.

public sealed class ClusterVariableSearchQueryFilterRequest
PropertyTypeDescription
NameStringFilterPropertyName of the cluster variable.
ValueStringFilterPropertyThe value of the cluster variable.
ScopeClusterVariableScopeFilterPropertyThe scope filter for cluster variables.
TenantIdStringFilterPropertyTenant ID of this variable.
IsTruncatedNullable<Boolean>Filter cluster variables by truncation status of their stored values. When true, returns only variables whose stored values are truncated (i.e., the value exceeds the storage size limit and is truncated in storage). When false, returns only variables with non-truncated stored values. This filter is based on the underlying storage characteristic, not the response format.

ClusterVariableSearchQueryRequest​

Cluster variable search query request.

public sealed class ClusterVariableSearchQueryRequest
PropertyTypeDescription
SortList<ClusterVariableSearchQuerySortRequest>Sort field criteria.
FilterClusterVariableSearchQueryFilterRequestThe cluster variable search filters.
PageSearchQueryPageRequestPagination criteria.

ClusterVariableSearchQueryResult​

Cluster variable search query response.

public sealed class ClusterVariableSearchQueryResult
PropertyTypeDescription
ItemsList<ClusterVariableSearchResult>The matching cluster variables.
PageSearchQueryPageResponsePagination information about the search results.

ClusterVariableSearchQuerySortRequest​

ClusterVariableSearchQuerySortRequest

public sealed class ClusterVariableSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

ClusterVariableSearchResult​

Cluster variable search response item.

public sealed class ClusterVariableSearchResult
PropertyTypeDescription
ValueStringValue of this cluster variable. Can be truncated.
IsTruncatedNullable<Boolean>Whether the value is truncated or not.
NameStringThe name of the cluster variable. Unique within its scope (global or tenant-specific).
ScopeClusterVariableScopeEnumThe scope of a cluster variable.
TenantIdStringOnly provided if the cluster variable scope is TENANT.

ConditionalEvaluationInstruction​

ConditionalEvaluationInstruction

public sealed class ConditionalEvaluationInstruction : ITenantIdSettable
PropertyTypeDescription
TenantIdNullable<TenantId>Used to evaluate root-level conditional start events for a tenant with the given ID. This will only evaluate root-level conditional start events of process definitions which belong to the tenant.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>Used to evaluate root-level conditional start events of the process definition with the given key.
VariablesObjectJSON object representing the variables to use for evaluation of the conditions and to pass to the process instances that have been triggered.

CorrelatedMessageSubscriptionFilter​

Correlated message subscriptions search filter.

public sealed class CorrelatedMessageSubscriptionFilter
PropertyTypeDescription
CorrelationKeyStringFilterPropertyThe correlation key of the message.
CorrelationTimeDateTimeFilterPropertyThe time when the message was correlated.
ElementIdStringFilterPropertyThe element ID that received the message.
ElementInstanceKeyElementInstanceKeyFilterPropertyThe element instance key that received the message.
MessageKeyBasicStringFilterPropertyThe message key.
MessageNameStringFilterPropertyThe name of the message.
PartitionIdIntegerFilterPropertyThe partition ID that correlated the message.
ProcessDefinitionIdStringFilterPropertyThe process definition ID associated with this correlated message subscription.
ProcessDefinitionKeyProcessDefinitionKeyFilterPropertyThe process definition key associated with this correlated message subscription. For intermediate message events, this only works for data created with 8.9 and later.
ProcessInstanceKeyProcessInstanceKeyFilterPropertyThe process instance key associated with this correlated message subscription.
SubscriptionKeyMessageSubscriptionKeyFilterPropertyThe subscription key that received the message.
TenantIdStringFilterPropertyThe tenant ID associated with this correlated message subscription.

CorrelatedMessageSubscriptionResult​

CorrelatedMessageSubscriptionResult

public sealed class CorrelatedMessageSubscriptionResult
PropertyTypeDescription
CorrelationKeyStringThe correlation key of the message.
CorrelationTimeDateTimeOffsetThe time when the message was correlated.
ElementIdStringThe element ID that received the message.
ElementInstanceKeyNullable<ElementInstanceKey>The element instance key that received the message.
MessageKeyMessageKeyThe message key.
MessageNameStringThe name of the message.
PartitionIdInt32The partition ID that correlated the message.
ProcessDefinitionIdProcessDefinitionIdThe process definition ID associated with this correlated message subscription.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The process definition key associated with this correlated message subscription.
ProcessInstanceKeyProcessInstanceKeyThe process instance key associated with this correlated message subscription.
RootProcessInstanceKeyNullable<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.
SubscriptionKeyMessageSubscriptionKeyThe subscription key that received the message.
TenantIdTenantIdThe tenant ID associated with this correlated message subscription.

CorrelatedMessageSubscriptionSearchQuery​

CorrelatedMessageSubscriptionSearchQuery

public sealed class CorrelatedMessageSubscriptionSearchQuery
PropertyTypeDescription
SortList<CorrelatedMessageSubscriptionSearchQuerySortRequest>Sort field criteria.
FilterCorrelatedMessageSubscriptionFilterThe correlated message subscriptions search filters.
PageSearchQueryPageRequestPagination criteria.

CorrelatedMessageSubscriptionSearchQueryResult​

CorrelatedMessageSubscriptionSearchQueryResult

public sealed class CorrelatedMessageSubscriptionSearchQueryResult
PropertyTypeDescription
ItemsList<CorrelatedMessageSubscriptionResult>The matching correlated message subscriptions.
PageSearchQueryPageResponsePagination information about the search results.

CorrelatedMessageSubscriptionSearchQuerySortRequest​

CorrelatedMessageSubscriptionSearchQuerySortRequest

public sealed class CorrelatedMessageSubscriptionSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

CreateClusterVariableRequest​

CreateClusterVariableRequest

public sealed class CreateClusterVariableRequest
PropertyTypeDescription
NameStringThe name of the cluster variable. Must be unique within its scope (global or tenant-specific).
ValueObjectThe value of the cluster variable. Can be any JSON object or primitive value. Will be serialized as a JSON string in responses.

CreateDeploymentResponse​

CreateDeploymentResponse

public sealed class CreateDeploymentResponse
PropertyTypeDescription
DeploymentKeyDeploymentKeyThe unique key identifying the deployment.
TenantIdTenantIdThe tenant ID associated with the deployment.
DeploymentsList<DeploymentMetadataResult>Items deployed by the request.

CreateProcessInstanceResult​

CreateProcessInstanceResult

public sealed class CreateProcessInstanceResult
PropertyTypeDescription
ProcessDefinitionIdProcessDefinitionIdThe BPMN process id of the process definition which was used to create the process. instance
ProcessDefinitionVersionInt32The version of the process definition which was used to create the process instance.
TenantIdTenantIdThe tenant id of the created process instance.
VariablesObjectAll the variables visible in the root scope.
ProcessDefinitionKeyProcessDefinitionKeyThe key of the process definition which was used to create the process instance.
ProcessInstanceKeyProcessInstanceKeyThe unique identifier of the created process instance; to be used wherever a request needs a process instance key (e.g. CancelProcessInstanceRequest).
TagsList<Tag>List of tags. Tags need to start with a letter; then alphanumerics, _, -, :, or .; length ≤ 100.

CursorBackwardPagination​

CursorBackwardPagination

public sealed class CursorBackwardPagination : SearchQueryPageRequest
PropertyTypeDescription
BeforeStartCursorUse the startCursor value from the previous response to fetch the previous page of results.
LimitNullable<Int32>The maximum number of items to return in one request.

CursorForwardPagination​

CursorForwardPagination

public sealed class CursorForwardPagination : SearchQueryPageRequest
PropertyTypeDescription
AfterEndCursorUse the endCursor value from the previous response to fetch the next page of results.
LimitNullable<Int32>The maximum number of items to return in one request.

DateTimeFilterProperty​

Date-time property with full advanced search capabilities.

public sealed class DateTimeFilterProperty

DecisionDefinitionFilter​

Decision definition search filter.

public sealed class DecisionDefinitionFilter
PropertyTypeDescription
DecisionDefinitionIdNullable<DecisionDefinitionId>The DMN ID of the decision definition.
NameStringThe DMN name of the decision definition.
IsLatestVersionNullable<Boolean>Whether to only return the latest version of each decision definition. When using this filter, pagination functionality is limited, you can only paginate forward using after and limit. The response contains no startCursor in the page, and requests ignore the from and before in the page.
VersionNullable<Int32>The assigned version of the decision definition.
DecisionRequirementsIdStringthe DMN ID of the decision requirements graph that the decision definition is part of.
TenantIdNullable<TenantId>The tenant ID of the decision definition.
DecisionDefinitionKeyNullable<DecisionDefinitionKey>The assigned key, which acts as a unique identifier for this decision definition.
DecisionRequirementsKeyNullable<DecisionRequirementsKey>The assigned key of the decision requirements graph that the decision definition is part of.
DecisionRequirementsNameStringThe DMN name of the decision requirements that the decision definition is part of.
DecisionRequirementsVersionNullable<Int32>The assigned version of the decision requirements that the decision definition is part of.

DecisionDefinitionId​

Id of a decision definition, from the model. Only ids of decision definitions that are deployed are useful.

public readonly record struct DecisionDefinitionId : ICamundaKey, IEquatable<DecisionDefinitionId>
PropertyTypeDescription
ValueStringThe underlying string value.

DecisionDefinitionKeyExactMatch​

Matches the value exactly.

public readonly record struct DecisionDefinitionKeyExactMatch : ICamundaKey, IEquatable<DecisionDefinitionKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

DecisionDefinitionKeyFilterProperty​

DecisionDefinitionKey property with full advanced search capabilities.

public sealed class DecisionDefinitionKeyFilterProperty

DecisionDefinitionResult​

DecisionDefinitionResult

public sealed class DecisionDefinitionResult
PropertyTypeDescription
DecisionDefinitionIdNullable<DecisionDefinitionId>The DMN ID of the decision definition.
NameStringThe DMN name of the decision definition.
VersionNullable<Int32>The assigned version of the decision definition.
DecisionRequirementsIdStringthe DMN ID of the decision requirements graph that the decision definition is part of.
TenantIdNullable<TenantId>The tenant ID of the decision definition.
DecisionDefinitionKeyNullable<DecisionDefinitionKey>The assigned key, which acts as a unique identifier for this decision definition.
DecisionRequirementsKeyNullable<DecisionRequirementsKey>The assigned key of the decision requirements graph that the decision definition is part of.
DecisionRequirementsNameStringThe DMN name of the decision requirements that the decision definition is part of.
DecisionRequirementsVersionNullable<Int32>The assigned version of the decision requirements that the decision definition is part of.

DecisionDefinitionSearchQuery​

DecisionDefinitionSearchQuery

public sealed class DecisionDefinitionSearchQuery
PropertyTypeDescription
SortList<DecisionDefinitionSearchQuerySortRequest>Sort field criteria.
FilterDecisionDefinitionFilterThe decision definition search filters.
PageSearchQueryPageRequestPagination criteria.

DecisionDefinitionSearchQueryResult​

DecisionDefinitionSearchQueryResult

public sealed class DecisionDefinitionSearchQueryResult
PropertyTypeDescription
ItemsList<DecisionDefinitionResult>The matching decision definitions.
PageSearchQueryPageResponsePagination information about the search results.

DecisionDefinitionSearchQuerySortRequest​

DecisionDefinitionSearchQuerySortRequest

public sealed class DecisionDefinitionSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

DecisionEvaluationById​

DecisionEvaluationById

public sealed class DecisionEvaluationById : DecisionEvaluationInstruction, ITenantIdSettable
PropertyTypeDescription
DecisionDefinitionIdDecisionDefinitionIdThe ID of the decision to be evaluated. When using the decision ID, the latest deployed version of the decision is used.
VariablesObjectThe message variables as JSON document.
TenantIdNullable<TenantId>The tenant ID of the decision.

DecisionEvaluationByKey​

DecisionEvaluationByKey

public sealed class DecisionEvaluationByKey : DecisionEvaluationInstruction, ITenantIdSettable
PropertyTypeDescription
DecisionDefinitionKeyDecisionDefinitionKeySystem-generated key for a decision definition.
VariablesObjectThe message variables as JSON document.
TenantIdNullable<TenantId>The tenant ID of the decision.

DecisionEvaluationInstanceKeyExactMatch​

Matches the value exactly.

public readonly record struct DecisionEvaluationInstanceKeyExactMatch : ICamundaKey, IEquatable<DecisionEvaluationInstanceKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

DecisionEvaluationInstanceKeyFilterProperty​

DecisionEvaluationInstanceKey property with full advanced search capabilities.

public sealed class DecisionEvaluationInstanceKeyFilterProperty

DecisionEvaluationInstruction​

DecisionEvaluationInstruction

public abstract class DecisionEvaluationInstruction

DecisionEvaluationKeyExactMatch​

Matches the value exactly.

public readonly record struct DecisionEvaluationKeyExactMatch : ICamundaKey, IEquatable<DecisionEvaluationKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

DecisionEvaluationKeyFilterProperty​

DecisionEvaluationKey property with full advanced search capabilities.

public sealed class DecisionEvaluationKeyFilterProperty

DecisionInstanceDeletionBatchOperationRequest​

The decision instance filter that defines which decision instances should be deleted.

public sealed class DecisionInstanceDeletionBatchOperationRequest
PropertyTypeDescription
FilterDecisionInstanceFilterThe decision instance filter.
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

DecisionInstanceFilter​

Decision instance search filter.

public sealed class DecisionInstanceFilter
PropertyTypeDescription
DecisionEvaluationInstanceKeyDecisionEvaluationInstanceKeyFilterPropertyThe key of the decision evaluation instance.
StateDecisionInstanceStateFilterPropertyThe state of the decision instance.
EvaluationFailureStringThe evaluation failure of the decision instance.
EvaluationDateDateTimeFilterPropertyThe evaluation date of the decision instance.
DecisionDefinitionIdNullable<DecisionDefinitionId>The ID of the DMN decision.
DecisionDefinitionNameStringThe name of the DMN decision.
DecisionDefinitionVersionNullable<Int32>The version of the decision.
DecisionDefinitionTypeNullable<DecisionDefinitionTypeEnum>The type of the decision.
TenantIdNullable<TenantId>The tenant ID of the decision instance.
DecisionEvaluationKeyNullable<DecisionEvaluationKey>The key of the parent decision evaluation. Note that this is not the identifier of an individual decision instance; the decisionEvaluationInstanceKey is the identifier for a decision instance.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The key of the process definition.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of the process instance.
DecisionDefinitionKeyDecisionDefinitionKeyFilterPropertyThe key of the decision.
ElementInstanceKeyElementInstanceKeyFilterPropertyThe key of the element instance this decision instance is linked to.
RootDecisionDefinitionKeyDecisionDefinitionKeyFilterPropertyThe key of the root decision definition.
DecisionRequirementsKeyDecisionRequirementsKeyFilterPropertyThe key of the decision requirements definition.

DecisionInstanceGetQueryResult​

DecisionInstanceGetQueryResult

public sealed class DecisionInstanceGetQueryResult
PropertyTypeDescription
DecisionEvaluationInstanceKeyNullable<DecisionEvaluationInstanceKey>System-generated key for a decision evaluation instance.
StateNullable<DecisionInstanceStateEnum>The state of the decision instance.
EvaluationDateNullable<DateTimeOffset>The evaluation date of the decision instance.
EvaluationFailureStringThe evaluation failure of the decision instance.
DecisionDefinitionIdNullable<DecisionDefinitionId>The ID of the DMN decision.
DecisionDefinitionNameStringThe name of the DMN decision.
DecisionDefinitionVersionNullable<Int32>The version of the decision.
DecisionDefinitionTypeNullable<DecisionDefinitionTypeEnum>The type of the decision.
ResultStringThe result of the decision instance.
TenantIdNullable<TenantId>The tenant ID of the decision instance.
DecisionEvaluationKeyNullable<DecisionEvaluationKey>The key of the decision evaluation where this instance was created.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The key of the process definition.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of the process instance.
RootProcessInstanceKeyNullable<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.
DecisionDefinitionKeyNullable<DecisionDefinitionKey>The key of the decision.
ElementInstanceKeyNullable<ElementInstanceKey>The key of the element instance this decision instance is linked to.
RootDecisionDefinitionKeyNullable<DecisionDefinitionKey>The key of the root decision definition.
EvaluatedInputsList<EvaluatedDecisionInputItem>The evaluated inputs of the decision instance.
MatchedRulesList<MatchedDecisionRuleItem>The matched rules of the decision instance.

DecisionInstanceResult​

DecisionInstanceResult

public sealed class DecisionInstanceResult
PropertyTypeDescription
DecisionEvaluationInstanceKeyNullable<DecisionEvaluationInstanceKey>System-generated key for a decision evaluation instance.
StateNullable<DecisionInstanceStateEnum>The state of the decision instance.
EvaluationDateNullable<DateTimeOffset>The evaluation date of the decision instance.
EvaluationFailureStringThe evaluation failure of the decision instance.
DecisionDefinitionIdNullable<DecisionDefinitionId>The ID of the DMN decision.
DecisionDefinitionNameStringThe name of the DMN decision.
DecisionDefinitionVersionNullable<Int32>The version of the decision.
DecisionDefinitionTypeNullable<DecisionDefinitionTypeEnum>The type of the decision.
ResultStringThe result of the decision instance.
TenantIdNullable<TenantId>The tenant ID of the decision instance.
DecisionEvaluationKeyNullable<DecisionEvaluationKey>The key of the decision evaluation where this instance was created.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The key of the process definition.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of the process instance.
RootProcessInstanceKeyNullable<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.
DecisionDefinitionKeyNullable<DecisionDefinitionKey>The key of the decision.
ElementInstanceKeyNullable<ElementInstanceKey>The key of the element instance this decision instance is linked to.
RootDecisionDefinitionKeyNullable<DecisionDefinitionKey>The key of the root decision definition.

DecisionInstanceSearchQuery​

DecisionInstanceSearchQuery

public sealed class DecisionInstanceSearchQuery
PropertyTypeDescription
SortList<DecisionInstanceSearchQuerySortRequest>Sort field criteria.
FilterDecisionInstanceFilterThe decision instance search filters.
PageSearchQueryPageRequestPagination criteria.

DecisionInstanceSearchQueryResult​

DecisionInstanceSearchQueryResult

public sealed class DecisionInstanceSearchQueryResult
PropertyTypeDescription
ItemsList<DecisionInstanceResult>The matching decision instances.
PageSearchQueryPageResponsePagination information about the search results.

DecisionInstanceSearchQuerySortRequest​

DecisionInstanceSearchQuerySortRequest

public sealed class DecisionInstanceSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

DecisionInstanceStateExactMatch​

Matches the value exactly.

public readonly record struct DecisionInstanceStateExactMatch : ICamundaKey, IEquatable<DecisionInstanceStateExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

DecisionInstanceStateFilterProperty​

DecisionInstanceStateEnum property with full advanced search capabilities.

public sealed class DecisionInstanceStateFilterProperty

DecisionRequirementsFilter​

Decision requirements search filter.

public sealed class DecisionRequirementsFilter
PropertyTypeDescription
DecisionRequirementsNameStringThe DMN name of the decision requirements.
DecisionRequirementsIdStringthe DMN ID of the decision requirements.
DecisionRequirementsKeyNullable<DecisionRequirementsKey>System-generated key for a deployed decision requirements definition.
VersionNullable<Int32>The assigned version of the decision requirements.
TenantIdNullable<TenantId>The tenant ID of the decision requirements.
ResourceNameStringThe name of the resource from which the decision requirements were parsed

DecisionRequirementsKeyExactMatch​

Matches the value exactly.

public readonly record struct DecisionRequirementsKeyExactMatch : ICamundaKey, IEquatable<DecisionRequirementsKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

DecisionRequirementsKeyFilterProperty​

DecisionRequirementsKey property with full advanced search capabilities.

public sealed class DecisionRequirementsKeyFilterProperty

DecisionRequirementsResult​

DecisionRequirementsResult

public sealed class DecisionRequirementsResult
PropertyTypeDescription
DecisionRequirementsNameStringThe DMN name of the decision requirements.
VersionNullable<Int32>The assigned version of the decision requirements.
DecisionRequirementsIdStringThe DMN ID of the decision requirements.
ResourceNameStringThe name of the resource from which this decision requirements was parsed.
TenantIdNullable<TenantId>The tenant ID of the decision requirements.
DecisionRequirementsKeyNullable<DecisionRequirementsKey>The assigned key, which acts as a unique identifier for this decision requirements.

DecisionRequirementsSearchQuery​

DecisionRequirementsSearchQuery

public sealed class DecisionRequirementsSearchQuery
PropertyTypeDescription
SortList<DecisionRequirementsSearchQuerySortRequest>Sort field criteria.
FilterDecisionRequirementsFilterThe decision definition search filters.
PageSearchQueryPageRequestPagination criteria.

DecisionRequirementsSearchQueryResult​

DecisionRequirementsSearchQueryResult

public sealed class DecisionRequirementsSearchQueryResult
PropertyTypeDescription
ItemsList<DecisionRequirementsResult>The matching decision requirements.
PageSearchQueryPageResponsePagination information about the search results.

DecisionRequirementsSearchQuerySortRequest​

DecisionRequirementsSearchQuerySortRequest

public sealed class DecisionRequirementsSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

DeleteDecisionInstanceRequest​

DeleteDecisionInstanceRequest

public sealed class DeleteDecisionInstanceRequest
PropertyTypeDescription
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

DeleteProcessInstanceRequest​

DeleteProcessInstanceRequest

public sealed class DeleteProcessInstanceRequest
PropertyTypeDescription
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

DeleteProcessInstancesBatchOperationRequest​

The process instance filter that defines which process instances should be deleted.

public sealed class DeleteProcessInstancesBatchOperationRequest
PropertyTypeDescription
FilterProcessInstanceFilterThe process instance filter.
OperationReferenceNullable<Int64>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

DeleteResourceRequest​

DeleteResourceRequest

public sealed class DeleteResourceRequest
PropertyTypeDescription
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.
DeleteHistoryNullable<Boolean>Indicates if the historic data of a process resource should be deleted via a batch operation asynchronously. This flag is only effective for process resources. For other resource types (decisions, forms, generic resources), this flag is ignored and no history will be deleted. In those cases, the batchOperation field in the response will not be populated.

DeleteResourceResponse​

DeleteResourceResponse

public sealed class DeleteResourceResponse
PropertyTypeDescription
ResourceKeyResourceKeyThe system-assigned key for this resource, requested to be deleted.
BatchOperationBatchOperationCreatedResultThe batch operation created for asynchronously deleting the historic data. This field is only populated when the request deleteHistory is set to true and the resource is a process definition. For other resource types (decisions, forms, generic resources), this field will not be present in the response.

DeploymentDecisionRequirementsResult​

Deployed decision requirements.

public sealed class DeploymentDecisionRequirementsResult
PropertyTypeDescription
DecisionRequirementsIdString
DecisionRequirementsNameString
VersionNullable<Int32>
ResourceNameString
TenantIdNullable<TenantId>The tenant ID of the deployed decision requirements.
DecisionRequirementsKeyNullable<DecisionRequirementsKey>The assigned decision requirements key, which acts as a unique identifier for this decision requirements.

DeploymentDecisionResult​

A deployed decision.

public sealed class DeploymentDecisionResult
PropertyTypeDescription
DecisionDefinitionIdNullable<DecisionDefinitionId>The dmn decision ID, as parsed during deployment, together with the version forms a unique identifier for a specific decision.
VersionNullable<Int32>The assigned decision version.
NameStringThe DMN name of the decision, as parsed during deployment.
TenantIdNullable<TenantId>The tenant ID of the deployed decision.
DecisionRequirementsIdStringThe dmn ID of the decision requirements graph that this decision is part of, as parsed during deployment.
DecisionDefinitionKeyNullable<DecisionDefinitionKey>The assigned decision key, which acts as a unique identifier for this decision.
DecisionRequirementsKeyNullable<DecisionRequirementsKey>The assigned key of the decision requirements graph that this decision is part of.

DeploymentFormResult​

A deployed form.

public sealed class DeploymentFormResult
PropertyTypeDescription
FormIdNullable<FormId>The form ID, as parsed during deployment, together with the version forms a unique identifier for a specific form.
VersionNullable<Int32>
ResourceNameString
TenantIdNullable<TenantId>The unique identifier of the tenant.
FormKeyNullable<FormKey>The assigned key, which acts as a unique identifier for this form.

DeploymentKeyExactMatch​

Matches the value exactly.

public readonly record struct DeploymentKeyExactMatch : ICamundaKey, IEquatable<DeploymentKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

DeploymentKeyFilterProperty​

DeploymentKey property with full advanced search capabilities.

public sealed class DeploymentKeyFilterProperty

DeploymentMetadataResult​

DeploymentMetadataResult

public sealed class DeploymentMetadataResult
PropertyTypeDescription
ProcessDefinitionDeploymentProcessResultA deployed process.
DecisionDefinitionDeploymentDecisionResultA deployed decision.
DecisionRequirementsDeploymentDecisionRequirementsResultDeployed decision requirements.
FormDeploymentFormResultA deployed form.
ResourceDeploymentResourceResultA deployed Resource.

DeploymentProcessResult​

A deployed process.

public sealed class DeploymentProcessResult
PropertyTypeDescription
ProcessDefinitionIdProcessDefinitionIdThe bpmn process ID, as parsed during deployment, together with the version forms a unique identifier for a specific process definition.
ProcessDefinitionVersionInt32The assigned process version.
ResourceNameStringThe resource name from which this process was parsed.
TenantIdTenantIdThe tenant ID of the deployed process.
ProcessDefinitionKeyProcessDefinitionKeyThe assigned key, which acts as a unique identifier for this process.

DeploymentResourceResult​

A deployed Resource.

public sealed class DeploymentResourceResult
PropertyTypeDescription
ResourceIdString
ResourceNameString
VersionNullable<Int32>
TenantIdNullable<TenantId>The unique identifier of the tenant.
ResourceKeyNullable<ResourceKey>The assigned key, which acts as a unique identifier for this Resource.

DeploymentResult​

DeploymentResult

public sealed class DeploymentResult
PropertyTypeDescription
DeploymentKeyDeploymentKeyThe unique key identifying the deployment.
TenantIdTenantIdThe tenant ID associated with the deployment.
DeploymentsList<DeploymentMetadataResult>Items deployed by the request.

DirectAncestorKeyInstruction​

Provides a concrete key to use as ancestor scope for the created element instance.

public sealed class DirectAncestorKeyInstruction : AncestorScopeInstruction
PropertyTypeDescription
AncestorScopeTypeStringThe type of ancestor scope instruction.
AncestorElementInstanceKeyObjectThe key of the ancestor scope the element instance should be created in. Set to -1 to create the new element instance within an existing element instance of the flow scope. If multiple instances of the target element's flow scope exist, choose one specifically with this property by providing its key.

DocumentCreationBatchResponse​

DocumentCreationBatchResponse

public sealed class DocumentCreationBatchResponse
PropertyTypeDescription
FailedDocumentsList<DocumentCreationFailureDetail>Documents that were successfully created.
CreatedDocumentsList<DocumentReference>Documents that failed creation.

DocumentCreationFailureDetail​

DocumentCreationFailureDetail

public sealed class DocumentCreationFailureDetail
PropertyTypeDescription
FileNameStringThe name of the file that failed to upload.
StatusNullable<Int32>The HTTP status code of the failure.
TitleStringA short, human-readable summary of the problem type.
DetailStringA human-readable explanation specific to this occurrence of the problem.

DocumentId​

Document Id that uniquely identifies a document.

public readonly record struct DocumentId : ICamundaKey, IEquatable<DocumentId>
PropertyTypeDescription
ValueStringThe underlying string value.

DocumentLink

public sealed class DocumentLink
PropertyTypeDescription
UrlStringThe link to the document.
ExpiresAtNullable<DateTimeOffset>The date and time when the link expires.

DocumentLinkRequest​

DocumentLinkRequest

public sealed class DocumentLinkRequest
PropertyTypeDescription
TimeToLiveNullable<Int64>The time-to-live of the document link in ms.

DocumentMetadata​

Information about the document.

public sealed class DocumentMetadata
PropertyTypeDescription
ContentTypeStringThe content type of the document.
FileNameStringThe name of the file.
ExpiresAtNullable<DateTimeOffset>The date and time when the document expires.
SizeNullable<Int64>The size of the document in bytes.
ProcessDefinitionIdNullable<ProcessDefinitionId>The ID of the process definition that created the document.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of the process instance that created the document.
CustomPropertiesObjectCustom properties of the document.

DocumentReference​

DocumentReference

public sealed class DocumentReference
PropertyTypeDescription
CamundaDocumentTypeStringDocument discriminator. Always set to "camunda".
StoreIdStringThe ID of the document store.
DocumentIdNullable<DocumentId>The ID of the document.
ContentHashStringThe hash of the document.
MetadataDocumentMetadataInformation about the document.

ElementId​

The model-defined id of an element.

public readonly record struct ElementId : ICamundaKey, IEquatable<ElementId>
PropertyTypeDescription
ValueStringThe underlying string value.

ElementInstanceFilter​

Element instance filter.

public sealed class ElementInstanceFilter
PropertyTypeDescription
ProcessDefinitionIdNullable<ProcessDefinitionId>The process definition ID associated to this element instance.
StateElementInstanceStateFilterPropertyState of element instance as defined set of values.
TypeStringType of element as defined set of values.
ElementIdNullable<ElementId>The element ID for this element instance.
ElementNameStringThe element name. This only works for data created with 8.8 and onwards. Instances from prior versions don't contain this data and cannot be found.
HasIncidentNullable<Boolean>Shows whether this element instance has an incident related to.
TenantIdNullable<TenantId>The unique identifier of the tenant.
ElementInstanceKeyNullable<ElementInstanceKey>The assigned key, which acts as a unique identifier for this element instance.
ProcessInstanceKeyNullable<ProcessInstanceKey>The process instance key associated to this element instance.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The process definition key associated to this element instance.
IncidentKeyNullable<IncidentKey>The key of incident if field incident is true.
StartDateDateTimeFilterPropertyThe start date of this element instance.
EndDateDateTimeFilterPropertyThe end date of this element instance.
ElementInstanceScopeKeyStringThe scope key of this element instance. If provided with a process instance key it will return element instances that are immediate children of the process instance. If provided with an element instance key it will return element instances that are immediate children of the element instance.

ElementInstanceKeyExactMatch​

Matches the value exactly.

public readonly record struct ElementInstanceKeyExactMatch : ICamundaKey, IEquatable<ElementInstanceKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

ElementInstanceKeyFilterProperty​

ElementInstanceKey property with full advanced search capabilities.

public sealed class ElementInstanceKeyFilterProperty

ElementInstanceResult​

ElementInstanceResult

public sealed class ElementInstanceResult
PropertyTypeDescription
ProcessDefinitionIdProcessDefinitionIdThe process definition ID associated to this element instance.
StartDateDateTimeOffsetDate when element instance started.
EndDateNullable<DateTimeOffset>Date when element instance finished.
ElementIdElementIdThe element ID for this element instance.
ElementNameStringThe element name for this element instance.
TypeStringType of element as defined set of values.
StateElementInstanceStateEnumState of element instance as defined set of values.
HasIncidentBooleanShows whether this element instance has an incident. If true also an incidentKey is provided.
TenantIdTenantIdThe tenant ID of the incident.
ElementInstanceKeyElementInstanceKeyThe assigned key, which acts as a unique identifier for this element instance.
ProcessInstanceKeyProcessInstanceKeyThe process instance key associated to this element instance.
RootProcessInstanceKeyNullable<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.
ProcessDefinitionKeyProcessDefinitionKeyThe process definition key associated to this element instance.
IncidentKeyNullable<IncidentKey>Incident key associated with this element instance.

ElementInstanceSearchQuery​

Element instance search request.

public sealed class ElementInstanceSearchQuery
PropertyTypeDescription
SortList<ElementInstanceSearchQuerySortRequest>Sort field criteria.
FilterElementInstanceFilterThe element instance search filters.
PageSearchQueryPageRequestPagination criteria.

ElementInstanceSearchQueryResult​

ElementInstanceSearchQueryResult

public sealed class ElementInstanceSearchQueryResult
PropertyTypeDescription
ItemsList<ElementInstanceResult>The matching element instances.
PageSearchQueryPageResponsePagination information about the search results.

ElementInstanceSearchQuerySortRequest​

ElementInstanceSearchQuerySortRequest

public sealed class ElementInstanceSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

ElementInstanceStateExactMatch​

Matches the value exactly.

public readonly record struct ElementInstanceStateExactMatch : ICamundaKey, IEquatable<ElementInstanceStateExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

ElementInstanceStateFilterProperty​

ElementInstanceStateEnum property with full advanced search capabilities.

public sealed class ElementInstanceStateFilterProperty

EndCursor​

The end cursor in a search query result set.

public readonly record struct EndCursor : ICamundaKey, IEquatable<EndCursor>
PropertyTypeDescription
ValueStringThe underlying string value.

EntityTypeExactMatch​

Matches the value exactly.

public readonly record struct EntityTypeExactMatch : ICamundaKey, IEquatable<EntityTypeExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

EntityTypeFilterProperty​

AuditLogEntityTypeEnum property with full advanced search capabilities.

public sealed class EntityTypeFilterProperty

EvaluateConditionalResult​

EvaluateConditionalResult

public sealed class EvaluateConditionalResult
PropertyTypeDescription
ConditionalEvaluationKeyConditionalEvaluationKeyThe unique key of the conditional evaluation operation.
TenantIdTenantIdThe tenant ID of the conditional evaluation operation.
ProcessInstancesList<ProcessInstanceReference>List of process instances created. If no root-level conditional start events evaluated to true, the list will be empty.

EvaluateDecisionResult​

EvaluateDecisionResult

public sealed class EvaluateDecisionResult
PropertyTypeDescription
DecisionDefinitionIdDecisionDefinitionIdThe ID of the decision which was evaluated.
DecisionDefinitionNameStringThe name of the decision which was evaluated.
DecisionDefinitionVersionInt32The version of the decision which was evaluated.
DecisionRequirementsIdStringThe ID of the decision requirements graph that the decision which was evaluated is part of.
OutputStringJSON document that will instantiate the result of the decision which was evaluated.
FailedDecisionDefinitionIdDecisionDefinitionIdThe ID of the decision which failed during evaluation.
FailureMessageStringMessage describing why the decision which was evaluated failed.
TenantIdTenantIdThe tenant ID of the evaluated decision.
DecisionDefinitionKeyDecisionDefinitionKeyThe unique key identifying the decision which was evaluated.
DecisionRequirementsKeyDecisionRequirementsKeyThe unique key identifying the decision requirements graph that the decision which was evaluated is part of.
DecisionInstanceKeyNullable<DecisionInstanceKey>Deprecated, please refer to decisionEvaluationKey.
DecisionEvaluationKeyDecisionEvaluationKeyThe unique key identifying this decision evaluation.
EvaluatedDecisionsList<EvaluatedDecisionResult>Decisions that were evaluated within the requested decision evaluation.

EvaluatedDecisionInputItem​

A decision input that was evaluated within this decision evaluation.

public sealed class EvaluatedDecisionInputItem
PropertyTypeDescription
InputIdString
InputNameString
InputValueString

EvaluatedDecisionOutputItem​

The evaluated decision outputs.

public sealed class EvaluatedDecisionOutputItem
PropertyTypeDescription
OutputIdString
OutputNameString
OutputValueString
RuleIdString
RuleIndexNullable<Int32>

EvaluatedDecisionResult​

A decision that was evaluated.

public sealed class EvaluatedDecisionResult
PropertyTypeDescription
DecisionDefinitionIdNullable<DecisionDefinitionId>The ID of the decision which was evaluated.
DecisionDefinitionNameStringThe name of the decision which was evaluated.
DecisionDefinitionVersionNullable<Int32>The version of the decision which was evaluated.
DecisionDefinitionTypeStringThe type of the decision which was evaluated.
OutputStringJSON document that will instantiate the result of the decision which was evaluated.
TenantIdNullable<TenantId>The tenant ID of the evaluated decision.
MatchedRulesList<MatchedDecisionRuleItem>The decision rules that matched within this decision evaluation.
EvaluatedInputsList<EvaluatedDecisionInputItem>The decision inputs that were evaluated within this decision evaluation.
DecisionDefinitionKeyNullable<DecisionDefinitionKey>The unique key identifying the decision which was evaluate.
DecisionEvaluationInstanceKeyNullable<DecisionEvaluationInstanceKey>The unique key identifying this decision evaluation instance.

ExpressionEvaluationRequest​

ExpressionEvaluationRequest

public sealed class ExpressionEvaluationRequest : ITenantIdSettable
PropertyTypeDescription
ExpressionStringThe expression to evaluate (e.g., "=x + y")
TenantIdStringRequired when the expression references tenant-scoped cluster variables

ExpressionEvaluationResult​

ExpressionEvaluationResult

public sealed class ExpressionEvaluationResult
PropertyTypeDescription
ExpressionStringThe evaluated expression
ResultObjectThe result value. Its type can vary.
WarningsList<String>List of warnings generated during expression evaluation

FormId​

The user-defined id for the form

public readonly record struct FormId : ICamundaKey, IEquatable<FormId>
PropertyTypeDescription
ValueStringThe underlying string value.

FormKeyExactMatch​

Matches the value exactly.

public readonly record struct FormKeyExactMatch : ICamundaKey, IEquatable<FormKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

FormKeyFilterProperty​

FormKey property with full advanced search capabilities.

public sealed class FormKeyFilterProperty

FormResult​

FormResult

public sealed class FormResult
PropertyTypeDescription
TenantIdNullable<TenantId>The tenant ID of the form.
FormIdNullable<FormId>The user-provided identifier of the form.
SchemaObjectThe form content.
VersionNullable<Int64>The version of the the deployed form.
FormKeyNullable<FormKey>The assigned key, which acts as a unique identifier for this form.

GetAuditLogResponse​

Audit log item.

public sealed class GetAuditLogResponse
PropertyTypeDescription
AuditLogKeyNullable<AuditLogKey>The unique key of the audit log entry.
EntityKeyNullable<AuditLogEntityKey>System-generated entity key for an audit log entry.
EntityTypeNullable<AuditLogEntityTypeEnum>The type of entity affected by the operation.
OperationTypeNullable<AuditLogOperationTypeEnum>The type of operation performed.
BatchOperationKeyNullable<BatchOperationKey>Key of the batch operation.
BatchOperationTypeNullable<BatchOperationTypeEnum>The type of batch operation performed, if this is part of a batch.
TimestampNullable<DateTimeOffset>The timestamp when the operation occurred.
ActorIdStringThe ID of the actor who performed the operation.
ActorTypeNullable<AuditLogActorTypeEnum>The type of actor who performed the operation.
TenantIdNullable<TenantId>The tenant ID of the audit log.
ResultNullable<AuditLogResultEnum>The result status of the operation.
AnnotationStringAdditional notes about the operation.
CategoryNullable<AuditLogCategoryEnum>The category of the audit log operation.
ProcessDefinitionIdNullable<ProcessDefinitionId>The process definition ID.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The key of the process definition.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of the process instance.
RootProcessInstanceKeyNullable<ProcessInstanceKey>System-generated key for a process instance.
ElementInstanceKeyNullable<ElementInstanceKey>The key of the element instance.
JobKeyNullable<JobKey>The key of the job.
UserTaskKeyNullable<UserTaskKey>The key of the user task.
DecisionRequirementsIdStringThe decision requirements ID.
DecisionRequirementsKeyNullable<DecisionRequirementsKey>The assigned key of the decision requirements.
DecisionDefinitionIdNullable<DecisionDefinitionId>The decision definition ID.
DecisionDefinitionKeyNullable<DecisionDefinitionKey>The key of the decision definition.
DecisionEvaluationKeyNullable<DecisionEvaluationKey>The key of the decision evaluation.
DeploymentKeyNullable<DeploymentKey>The key of the deployment.
FormKeyObjectThe key of the form.
ResourceKeyNullable<ResourceKey>The system-assigned key for this resource.
RelatedEntityKeyNullable<AuditLogEntityKey>The key of the related entity. The content depends on the operation type and entity type. For example, for authorization operations, this will contain the ID of the owner (e.g., user or group) the authorization belongs to.
RelatedEntityTypeNullable<AuditLogEntityTypeEnum>The type of the related entity. The content depends on the operation type and entity type. For example, for authorization operations, this will contain the type of the owner (e.g., USER or GROUP) the authorization belongs to.
EntityDescriptionStringAdditional description of the entity affected by the operation. For example, for variable operations, this will contain the variable name.

GetElementInstanceResponse​

GetElementInstanceResponse

public sealed class GetElementInstanceResponse
PropertyTypeDescription
ProcessDefinitionIdProcessDefinitionIdThe process definition ID associated to this element instance.
StartDateDateTimeOffsetDate when element instance started.
EndDateNullable<DateTimeOffset>Date when element instance finished.
ElementIdElementIdThe element ID for this element instance.
ElementNameStringThe element name for this element instance.
TypeStringType of element as defined set of values.
StateElementInstanceStateEnumState of element instance as defined set of values.
HasIncidentBooleanShows whether this element instance has an incident. If true also an incidentKey is provided.
TenantIdTenantIdThe tenant ID of the incident.
ElementInstanceKeyElementInstanceKeyThe assigned key, which acts as a unique identifier for this element instance.
ProcessInstanceKeyProcessInstanceKeyThe process instance key associated to this element instance.
RootProcessInstanceKeyNullable<ProcessInstanceKey>System-generated key for a process instance.
ProcessDefinitionKeyProcessDefinitionKeyThe process definition key associated to this element instance.
IncidentKeyNullable<IncidentKey>Incident key associated with this element instance.

GetIncidentResponse​

GetIncidentResponse

public sealed class GetIncidentResponse
PropertyTypeDescription
ProcessDefinitionIdNullable<ProcessDefinitionId>The process definition ID associated to this incident.
ErrorTypeIncidentErrorTypeEnum
ErrorMessageStringError message which describes the error in more detail.
ElementIdNullable<ElementId>The element ID associated to this incident.
CreationTimeNullable<DateTimeOffset>
StateIncidentStateEnum
TenantIdNullable<TenantId>The tenant ID of the incident.
IncidentKeyNullable<IncidentKey>The assigned key, which acts as a unique identifier for this incident.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The process definition key associated to this incident.
ProcessInstanceKeyNullable<ProcessInstanceKey>The process instance key associated to this incident.
RootProcessInstanceKeyNullable<ProcessInstanceKey>System-generated key for a process instance.
ElementInstanceKeyNullable<ElementInstanceKey>The element instance key associated to this incident.
JobKeyNullable<JobKey>The job key, if exists, associated with this incident.

GetProcessDefinitionStatisticsRequest​

Process definition element statistics request.

public sealed class GetProcessDefinitionStatisticsRequest
PropertyTypeDescription
FilterObjectThe process definition statistics search filters.

GetProcessInstanceResponse​

Process instance search response item.

public sealed class GetProcessInstanceResponse
PropertyTypeDescription
ProcessDefinitionIdProcessDefinitionIdId of a process definition, from the model. Only ids of process definitions that are deployed are useful.
ProcessDefinitionNameStringThe process definition name.
ProcessDefinitionVersionInt32
ProcessDefinitionVersionTagStringThe process definition version tag.
StartDateDateTimeOffset
EndDateNullable<DateTimeOffset>
StateProcessInstanceStateEnumProcess instance states
HasIncidentBooleanWhether this process instance has a related incident or not.
TenantIdTenantIdThe unique identifier of the tenant.
ProcessInstanceKeyProcessInstanceKeyThe key of this process instance.
ProcessDefinitionKeyProcessDefinitionKeyThe process definition key.
ParentProcessInstanceKeyNullable<ProcessInstanceKey>The parent process instance key.
ParentElementInstanceKeyNullable<ElementInstanceKey>The parent element instance key.
RootProcessInstanceKeyNullable<ProcessInstanceKey>System-generated key for a process instance.
TagsList<String>List of tags. Tags need to start with a letter; then alphanumerics, _, -, :, or .; length ≤ 100.

GetProcessInstanceSequenceFlowsResponse​

Process instance sequence flows query response.

public sealed class GetProcessInstanceSequenceFlowsResponse
PropertyTypeDescription
ItemsList<ProcessInstanceSequenceFlowResult>The sequence flows.

GetStartProcessFormResponse​

GetStartProcessFormResponse

public sealed class GetStartProcessFormResponse
PropertyTypeDescription
TenantIdNullable<TenantId>The tenant ID of the form.
FormIdNullable<FormId>The user-provided identifier of the form.
SchemaObjectThe form content.
VersionNullable<Int64>The version of the the deployed form.
FormKeyObjectThe assigned key, which acts as a unique identifier for this form.

GetUserTaskFormResponse​

GetUserTaskFormResponse

public sealed class GetUserTaskFormResponse
PropertyTypeDescription
TenantIdNullable<TenantId>The tenant ID of the form.
FormIdNullable<FormId>The user-provided identifier of the form.
SchemaObjectThe form content.
VersionNullable<Int64>The version of the the deployed form.
FormKeyObjectThe assigned key, which acts as a unique identifier for this form.

GetUserTaskResponse​

GetUserTaskResponse

public sealed class GetUserTaskResponse
PropertyTypeDescription
NameStringThe name for this user task.
StateNullable<UserTaskStateEnum>The state of the user task.
AssigneeStringThe assignee of the user task.
ElementIdNullable<ElementId>The element ID of the user task.
CandidateGroupsList<String>The candidate groups for this user task.
CandidateUsersList<String>The candidate users for this user task.
ProcessDefinitionIdNullable<ProcessDefinitionId>The ID of the process definition.
CreationDateNullable<DateTimeOffset>The creation date of a user task.
CompletionDateNullable<DateTimeOffset>The completion date of a user task.
FollowUpDateNullable<DateTimeOffset>The follow date of a user task.
DueDateNullable<DateTimeOffset>The due date of a user task.
TenantIdNullable<TenantId>The unique identifier of the tenant.
ExternalFormReferenceStringThe external form reference.
ProcessDefinitionVersionNullable<Int32>The version of the process definition.
CustomHeadersDictionary<String>Custom headers for the user task.
PriorityNullable<Int32>The priority of a user task. The higher the value the higher the priority.
UserTaskKeyNullable<UserTaskKey>The key of the user task.
ElementInstanceKeyNullable<ElementInstanceKey>The key of the element instance.
ProcessNameStringThe name of the process definition.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The key of the process definition.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of the process instance.
RootProcessInstanceKeyNullable<ProcessInstanceKey>System-generated key for a process instance.
FormKeyObjectThe key of the form.
TagsList<String>List of tags. Tags need to start with a letter; then alphanumerics, _, -, :, or .; length ≤ 100.

GetVariableResponse​

Variable search response item.

public sealed class GetVariableResponse
PropertyTypeDescription
ValueStringFull value of this variable.
NameStringName of this variable.
TenantIdNullable<TenantId>Tenant ID of this variable.
VariableKeyNullable<VariableKey>The key for this variable.
ScopeKeyNullable<ScopeKey>The key of the scope of this variable.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of the process instance of this variable.
RootProcessInstanceKeyNullable<ProcessInstanceKey>System-generated key for a process instance.

GlobalJobStatisticsQueryResult​

Global job statistics query result.

public sealed class GlobalJobStatisticsQueryResult
PropertyTypeDescription
CreatedStatusMetricMetric for a single job status.
CompletedStatusMetricMetric for a single job status.
FailedStatusMetricMetric for a single job status.
IsIncompleteBooleanTrue if some data is missing because internal limits were reached and some metrics were not recorded.

GroupClientResult​

GroupClientResult

public sealed class GroupClientResult
PropertyTypeDescription
ClientIdStringThe ID of the client.

GroupClientSearchQueryRequest​

GroupClientSearchQueryRequest

public sealed class GroupClientSearchQueryRequest
PropertyTypeDescription
SortList<GroupClientSearchQuerySortRequest>Sort field criteria.
PageSearchQueryPageRequestPagination criteria.

GroupClientSearchQuerySortRequest​

GroupClientSearchQuerySortRequest

public sealed class GroupClientSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

GroupClientSearchResult​

GroupClientSearchResult

public sealed class GroupClientSearchResult
PropertyTypeDescription
ItemsList<GroupClientResult>The matching client IDs.
PageSearchQueryPageResponsePagination information about the search results.

GroupCreateRequest​

GroupCreateRequest

public sealed class GroupCreateRequest
PropertyTypeDescription
GroupIdStringThe ID of the new group.
NameStringThe display name of the new group.
DescriptionStringThe description of the new group.

GroupCreateResult​

GroupCreateResult

public sealed class GroupCreateResult
PropertyTypeDescription
GroupIdStringThe ID of the created group.
NameStringThe display name of the created group.
DescriptionStringThe description of the created group.

GroupFilter​

Group filter request

public sealed class GroupFilter
PropertyTypeDescription
GroupIdStringFilterPropertyThe group ID search filters.
NameStringThe group name search filters.

GroupResult​

Group search response item.

public sealed class GroupResult
PropertyTypeDescription
NameStringThe group name.
GroupIdStringThe group ID.
DescriptionStringThe group description.

GroupSearchQueryRequest​

Group search request.

public sealed class GroupSearchQueryRequest
PropertyTypeDescription
SortList<GroupSearchQuerySortRequest>Sort field criteria.
FilterGroupFilterThe group search filters.
PageSearchQueryPageRequestPagination criteria.

GroupSearchQueryResult​

Group search response.

public sealed class GroupSearchQueryResult
PropertyTypeDescription
ItemsList<GroupResult>The matching groups.
PageSearchQueryPageResponsePagination information about the search results.

GroupSearchQuerySortRequest​

GroupSearchQuerySortRequest

public sealed class GroupSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

GroupUpdateRequest​

GroupUpdateRequest

public sealed class GroupUpdateRequest
PropertyTypeDescription
NameStringThe new name of the group.
DescriptionStringThe new description of the group.

GroupUpdateResult​

GroupUpdateResult

public sealed class GroupUpdateResult
PropertyTypeDescription
GroupIdStringThe unique external group ID.
NameStringThe name of the group.
DescriptionStringThe description of the group.

GroupUserResult​

GroupUserResult

public sealed class GroupUserResult
PropertyTypeDescription
UsernameNullable<Username>The unique name of a user.

GroupUserSearchQueryRequest​

GroupUserSearchQueryRequest

public sealed class GroupUserSearchQueryRequest
PropertyTypeDescription
SortList<GroupUserSearchQuerySortRequest>Sort field criteria.
PageSearchQueryPageRequestPagination criteria.

GroupUserSearchQuerySortRequest​

GroupUserSearchQuerySortRequest

public sealed class GroupUserSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

GroupUserSearchResult​

GroupUserSearchResult

public sealed class GroupUserSearchResult
PropertyTypeDescription
ItemsList<GroupUserResult>The matching members.
PageSearchQueryPageResponsePagination information about the search results.

IncidentErrorTypeEnum​

Incident error type with a defined set of values.

public sealed class IncidentErrorTypeEnum

IncidentErrorTypeExactMatch​

Matches the value exactly.

public readonly record struct IncidentErrorTypeExactMatch : ICamundaKey, IEquatable<IncidentErrorTypeExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

IncidentErrorTypeFilterProperty​

IncidentErrorTypeEnum with full advanced search capabilities.

public sealed class IncidentErrorTypeFilterProperty

IncidentFilter​

Incident search filter.

public sealed class IncidentFilter
PropertyTypeDescription
ProcessDefinitionIdStringFilterPropertyThe process definition ID associated to this incident.
ErrorTypeIncidentErrorTypeFilterPropertyIncident error type with a defined set of values.
ErrorMessageStringFilterPropertyThe error message of this incident.
ElementIdStringFilterPropertyThe element ID associated to this incident.
CreationTimeDateTimeFilterPropertyDate of incident creation.
StateIncidentStateFilterPropertyState of this incident with a defined set of values.
TenantIdStringFilterPropertyThe tenant ID of the incident.
IncidentKeyBasicStringFilterPropertyThe assigned key, which acts as a unique identifier for this incident.
ProcessDefinitionKeyProcessDefinitionKeyFilterPropertyThe process definition key associated to this incident.
ProcessInstanceKeyProcessInstanceKeyFilterPropertyThe process instance key associated to this incident.
ElementInstanceKeyElementInstanceKeyFilterPropertyThe element instance key associated to this incident.
JobKeyJobKeyFilterPropertyThe job key, if exists, associated with this incident.

IncidentProcessInstanceStatisticsByDefinitionFilter​

Filter for the incident process instance statistics by definition query.

public sealed class IncidentProcessInstanceStatisticsByDefinitionFilter
PropertyTypeDescription
ErrorHashCodeInt32The error hash code of the incidents to filter the process instance statistics by.

IncidentProcessInstanceStatisticsByDefinitionQuery​

IncidentProcessInstanceStatisticsByDefinitionQuery

public sealed class IncidentProcessInstanceStatisticsByDefinitionQuery
PropertyTypeDescription
FilterIncidentProcessInstanceStatisticsByDefinitionFilterFilter criteria for the aggregated process instance statistics.
PageOffsetPaginationPagination parameters for the aggregated process instance statistics.
SortList<IncidentProcessInstanceStatisticsByDefinitionQuerySortRequest>Sorting criteria for process instance statistics grouped by process definition.

IncidentProcessInstanceStatisticsByDefinitionQueryResult​

IncidentProcessInstanceStatisticsByDefinitionQueryResult

public sealed class IncidentProcessInstanceStatisticsByDefinitionQueryResult
PropertyTypeDescription
ItemsList<IncidentProcessInstanceStatisticsByDefinitionResult>Statistics of active process instances with incidents, grouped by process definition for the specified error hash code.
PageSearchQueryPageResponsePagination information about the search results.

IncidentProcessInstanceStatisticsByDefinitionQuerySortRequest​

IncidentProcessInstanceStatisticsByDefinitionQuerySortRequest

public sealed class IncidentProcessInstanceStatisticsByDefinitionQuerySortRequest
PropertyTypeDescription
FieldStringThe aggregated field by which the process instance statistics are sorted.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

IncidentProcessInstanceStatisticsByDefinitionResult​

IncidentProcessInstanceStatisticsByDefinitionResult

public sealed class IncidentProcessInstanceStatisticsByDefinitionResult
PropertyTypeDescription
ProcessDefinitionIdNullable<ProcessDefinitionId>Id of a process definition, from the model. Only ids of process definitions that are deployed are useful.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>System-generated key for a deployed process definition.
ProcessDefinitionNameStringThe name of the process definition.
ProcessDefinitionVersionNullable<Int32>The version of the process definition.
TenantIdNullable<TenantId>The unique identifier of the tenant.
ActiveInstancesWithErrorCountNullable<Int64>The number of active process instances that currently have an incident with the specified error hash code.

IncidentProcessInstanceStatisticsByErrorQuery​

IncidentProcessInstanceStatisticsByErrorQuery

public sealed class IncidentProcessInstanceStatisticsByErrorQuery
PropertyTypeDescription
PageOffsetPaginationPagination parameters for process instance statistics grouped by incident error.
SortList<IncidentProcessInstanceStatisticsByErrorQuerySortRequest>Sorting criteria for process instance statistics grouped by incident error.

IncidentProcessInstanceStatisticsByErrorQueryResult​

IncidentProcessInstanceStatisticsByErrorQueryResult

public sealed class IncidentProcessInstanceStatisticsByErrorQueryResult
PropertyTypeDescription
ItemsList<IncidentProcessInstanceStatisticsByErrorResult>Statistics of active process instances grouped by incident error.
PageSearchQueryPageResponsePagination information about the search results.

IncidentProcessInstanceStatisticsByErrorQuerySortRequest​

IncidentProcessInstanceStatisticsByErrorQuerySortRequest

public sealed class IncidentProcessInstanceStatisticsByErrorQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort the incident error statistics by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

IncidentProcessInstanceStatisticsByErrorResult​

IncidentProcessInstanceStatisticsByErrorResult

public sealed class IncidentProcessInstanceStatisticsByErrorResult
PropertyTypeDescription
ErrorHashCodeNullable<Int32>The hash code identifying a specific incident error..
ErrorMessageStringThe error message associated with the incident error hash code.
ActiveInstancesWithErrorCountNullable<Int64>The number of active process instances that currently have an active incident with this error.

IncidentResolutionRequest​

IncidentResolutionRequest

public sealed class IncidentResolutionRequest
PropertyTypeDescription
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

IncidentResult​

IncidentResult

public sealed class IncidentResult
PropertyTypeDescription
ProcessDefinitionIdNullable<ProcessDefinitionId>The process definition ID associated to this incident.
ErrorTypeIncidentErrorTypeEnum
ErrorMessageStringError message which describes the error in more detail.
ElementIdNullable<ElementId>The element ID associated to this incident.
CreationTimeNullable<DateTimeOffset>
StateIncidentStateEnum
TenantIdNullable<TenantId>The tenant ID of the incident.
IncidentKeyNullable<IncidentKey>The assigned key, which acts as a unique identifier for this incident.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The process definition key associated to this incident.
ProcessInstanceKeyNullable<ProcessInstanceKey>The process instance key associated to this incident.
RootProcessInstanceKeyNullable<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.
ElementInstanceKeyNullable<ElementInstanceKey>The element instance key associated to this incident.
JobKeyNullable<JobKey>The job key, if exists, associated with this incident.

IncidentSearchQuery​

IncidentSearchQuery

public sealed class IncidentSearchQuery
PropertyTypeDescription
SortList<IncidentSearchQuerySortRequest>Sort field criteria.
FilterIncidentFilterThe incident search filters.
PageSearchQueryPageRequestPagination criteria.

IncidentSearchQueryResult​

IncidentSearchQueryResult

public sealed class IncidentSearchQueryResult
PropertyTypeDescription
ItemsList<IncidentResult>The matching incidents.
PageSearchQueryPageResponsePagination information about the search results.

IncidentSearchQuerySortRequest​

IncidentSearchQuerySortRequest

public sealed class IncidentSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

IncidentStateEnum​

Incident states with a defined set of values.

public sealed class IncidentStateEnum

IncidentStateExactMatch​

Matches the value exactly.

public readonly record struct IncidentStateExactMatch : ICamundaKey, IEquatable<IncidentStateExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

IncidentStateFilterProperty​

IncidentStateEnum with full advanced search capabilities.

public sealed class IncidentStateFilterProperty

InferredAncestorKeyInstruction​

Instructs the engine to derive the ancestor scope key from the source element's hierarchy. The engine traverses the source element's ancestry to find an instance that matches one of the target element's flow scopes, ensuring the target is activated in the correct scope.

public sealed class InferredAncestorKeyInstruction : AncestorScopeInstruction
PropertyTypeDescription
AncestorScopeTypeStringThe type of ancestor scope instruction.

IntegerFilterProperty​

Integer property with advanced search capabilities.

public sealed class IntegerFilterProperty

JobActivationRequest​

JobActivationRequest

public sealed class JobActivationRequest
PropertyTypeDescription
TypeStringThe job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition type="payment-service" />)
WorkerStringThe name of the worker activating the jobs, mostly used for logging purposes.
TimeoutInt64A job returned after this call will not be activated by another call until the timeout (in ms) has been reached.
MaxJobsToActivateInt32The maximum jobs to activate by this request.
FetchVariableList<String>A list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned.
RequestTimeoutNullable<Int64>The request will be completed when at least one job is activated or after the requestTimeout (in ms). If the requestTimeout = 0, a default timeout is used. If the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.
TenantIdsList<TenantId>A list of IDs of tenants for which to activate jobs.
TenantFilterNullable<TenantFilterEnum>The tenant filtering strategy - determines whether to use provided tenant IDs or assigned tenant IDs from the authenticated principal's authorized tenants.

JobActivationResult​

The list of activated jobs

public sealed class JobActivationResult
PropertyTypeDescription
JobsList<ActivatedJobResult>The activated jobs.

JobChangeset​

JSON object with changed job attribute values. The job cannot be completed or failed with this endpoint, use the complete job or fail job endpoints instead.

public sealed class JobChangeset
PropertyTypeDescription
RetriesNullable<Int32>The new number of retries for the job.
TimeoutNullable<Int64>The new timeout for the job in milliseconds.

JobCompletionRequest​

JobCompletionRequest

public sealed class JobCompletionRequest
PropertyTypeDescription
VariablesObjectThe variables to complete the job with.
ResultJobResultThe result of the completed job as determined by the worker.

JobErrorRequest​

JobErrorRequest

public sealed class JobErrorRequest
PropertyTypeDescription
ErrorCodeStringThe error code that will be matched with an error catch event.
ErrorMessageStringAn error message that provides additional context.
VariablesObjectJSON object that will instantiate the variables at the local scope of the error catch event that catches the thrown error.

JobFailRequest​

JobFailRequest

public sealed class JobFailRequest
PropertyTypeDescription
RetriesNullable<Int32>The amount of retries the job should have left
ErrorMessageStringAn optional error message describing why the job failed; if not provided, an empty string is used.
RetryBackOffNullable<Int64>An optional retry back off for the failed job. The job will not be retryable before the current time plus the back off time. The default is 0 which means the job is retryable immediately.
VariablesObjectJSON object that will instantiate the variables at the local scope of the job's associated task.

JobFilter​

Job search filter.

public sealed class JobFilter
PropertyTypeDescription
DeadlineDateTimeFilterPropertyWhen the job can next be activated.
DeniedReasonStringFilterPropertyThe reason provided by the user task listener for denying the work.
ElementIdStringFilterPropertyThe element ID associated with the job.
ElementInstanceKeyElementInstanceKeyFilterPropertyThe element instance key associated with the job.
EndTimeDateTimeFilterPropertyWhen the job ended.
ErrorCodeStringFilterPropertyThe error code provided for the failed job.
ErrorMessageStringFilterPropertyThe error message that provides additional context for a failed job.
HasFailedWithRetriesLeftNullable<Boolean>Indicates whether the job has failed with retries left.
IsDeniedNullable<Boolean>Indicates whether the user task listener denies the work.
JobKeyJobKeyFilterPropertyThe key, a unique identifier for the job.
KindJobKindFilterPropertyThe kind of the job.
ListenerEventTypeJobListenerEventTypeFilterPropertyThe listener event type of the job.
ProcessDefinitionIdStringFilterPropertyThe process definition ID associated with the job.
ProcessDefinitionKeyProcessDefinitionKeyFilterPropertyThe process definition key associated with the job.
ProcessInstanceKeyProcessInstanceKeyFilterPropertyThe process instance key associated with the job.
RetriesIntegerFilterPropertyThe number of retries left.
StateJobStateFilterPropertyThe state of the job.
TenantIdStringFilterPropertyThe tenant ID.
TypeStringFilterPropertyThe type of the job.
WorkerStringFilterPropertyThe name of the worker for this job.
CreationTimeDateTimeFilterPropertyWhen the job was created. Field is present for jobs created after 8.9.
LastUpdateTimeDateTimeFilterPropertyWhen the job was last updated. Field is present for jobs created after 8.9.

JobKeyExactMatch​

Matches the value exactly.

public readonly record struct JobKeyExactMatch : ICamundaKey, IEquatable<JobKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

JobKeyFilterProperty​

JobKey property with full advanced search capabilities.

public sealed class JobKeyFilterProperty

JobKindExactMatch​

Matches the value exactly.

public readonly record struct JobKindExactMatch : ICamundaKey, IEquatable<JobKindExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

JobKindFilterProperty​

JobKindEnum property with full advanced search capabilities.

public sealed class JobKindFilterProperty

JobListenerEventTypeExactMatch​

Matches the value exactly.

public readonly record struct JobListenerEventTypeExactMatch : ICamundaKey, IEquatable<JobListenerEventTypeExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

JobListenerEventTypeFilterProperty​

JobListenerEventTypeEnum property with full advanced search capabilities.

public sealed class JobListenerEventTypeFilterProperty

JobResult​

The result of the completed job as determined by the worker.

public abstract class JobResult

JobResultActivateElement​

Instruction to activate a single BPMN element within an ad‑hoc sub‑process, optionally providing variables scoped to that element.

public sealed class JobResultActivateElement
PropertyTypeDescription
ElementIdNullable<ElementId>The element ID to activate.
VariablesObjectVariables for the element.

JobResultAdHocSubProcess​

Job result details for an ad‑hoc sub‑process, including elements to activate and flags indicating completion or cancellation behavior.

public sealed class JobResultAdHocSubProcess : JobResult
PropertyTypeDescription
ActivateElementsList<JobResultActivateElement>Indicates which elements need to be activated in the ad-hoc subprocess.
IsCompletionConditionFulfilledNullable<Boolean>Indicates whether the completion condition of the ad-hoc subprocess is fulfilled.
IsCancelRemainingInstancesNullable<Boolean>Indicates whether the remaining instances of the ad-hoc subprocess should be canceled.
TypeStringUsed to distinguish between different types of job results.

JobResultCorrections​

JSON object with attributes that were corrected by the worker.

The following attributes can be corrected, additional attributes will be ignored:

  • assignee - clear by providing an empty String
  • dueDate - clear by providing an empty String
  • followUpDate - clear by providing an empty String
  • candidateGroups - clear by providing an empty list
  • candidateUsers - clear by providing an empty list
  • priority - minimum 0, maximum 100, default 50

Providing any of those attributes with a null value or omitting it preserves the persisted attribute's value.

public sealed class JobResultCorrections
PropertyTypeDescription
AssigneeStringAssignee of the task.
DueDateNullable<DateTimeOffset>The due date of the task.
FollowUpDateNullable<DateTimeOffset>The follow-up date of the task.
CandidateUsersList<String>The list of candidate users of the task.
CandidateGroupsList<String>The list of candidate groups of the task.
PriorityNullable<Int32>The priority of the task.

JobResultUserTask​

Job result details for a user task completion, optionally including a denial reason and corrected task properties.

public sealed class JobResultUserTask : JobResult
PropertyTypeDescription
DeniedNullable<Boolean>Indicates whether the worker denies the work, i.e. explicitly doesn't approve it. For example, a user task listener can deny the completion of a task by setting this flag to true. In this example, the completion of a task is represented by a job that the worker can complete as denied. As a result, the completion request is rejected and the task remains active. Defaults to false.
DeniedReasonStringThe reason provided by the user task listener for denying the work.
CorrectionsJobResultCorrectionsJSON object with attributes that were corrected by the worker. The following attributes can be corrected, additional attributes will be ignored: _ assignee - clear by providing an empty String _ dueDate - clear by providing an empty String _ followUpDate - clear by providing an empty String _ candidateGroups - clear by providing an empty list _ candidateUsers - clear by providing an empty list _ priority - minimum 0, maximum 100, default 50 Providing any of those attributes with a null value or omitting it preserves the persisted attribute's value.
TypeStringUsed to distinguish between different types of job results.

JobSearchQuery​

Job search request.

public sealed class JobSearchQuery
PropertyTypeDescription
SortList<JobSearchQuerySortRequest>Sort field criteria.
FilterJobFilterThe job search filters.
PageSearchQueryPageRequestPagination criteria.

JobSearchQueryResult​

Job search response.

public sealed class JobSearchQueryResult
PropertyTypeDescription
ItemsList<JobSearchResult>The matching jobs.
PageSearchQueryPageResponsePagination information about the search results.

JobSearchQuerySortRequest​

JobSearchQuerySortRequest

public sealed class JobSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

JobSearchResult​

JobSearchResult

public sealed class JobSearchResult
PropertyTypeDescription
CustomHeadersDictionary<String>A set of custom headers defined during modelling.
DeadlineNullable<DateTimeOffset>If the job has been activated, when it will next be available to be activated.
DeniedReasonStringThe reason provided by the user task listener for denying the work.
ElementIdElementIdThe element ID associated with the job.
ElementInstanceKeyElementInstanceKeyThe element instance key associated with the job.
EndTimeNullable<DateTimeOffset>When the job ended.
ErrorCodeStringThe error code provided for a failed job.
ErrorMessageStringThe error message that provides additional context for a failed job.
HasFailedWithRetriesLeftBooleanIndicates whether the job has failed with retries left.
IsDeniedNullable<Boolean>Indicates whether the user task listener denies the work.
JobKeyJobKeyThe key, a unique identifier for the job.
KindJobKindEnumThe job kind.
ListenerEventTypeJobListenerEventTypeEnumThe listener event type of the job.
ProcessDefinitionIdProcessDefinitionIdThe process definition ID associated with the job.
ProcessDefinitionKeyProcessDefinitionKeyThe process definition key associated with the job.
ProcessInstanceKeyProcessInstanceKeyThe process instance key associated with the job.
RootProcessInstanceKeyNullable<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.
RetriesInt32The amount of retries left to this job.
StateJobStateEnumThe state of the job.
TenantIdTenantIdThe unique identifier of the tenant.
TypeStringThe type of the job.
WorkerStringThe name of the worker of this job.
CreationTimeNullable<DateTimeOffset>When the job was created. Field is present for jobs created after 8.9.
LastUpdateTimeNullable<DateTimeOffset>When the job was last updated. Field is present for jobs created after 8.9.

JobStateExactMatch​

Matches the value exactly.

public readonly record struct JobStateExactMatch : ICamundaKey, IEquatable<JobStateExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

JobStateFilterProperty​

JobStateEnum property with full advanced search capabilities.

public sealed class JobStateFilterProperty

JobUpdateRequest​

JobUpdateRequest

public sealed class JobUpdateRequest
PropertyTypeDescription
ChangesetJobChangesetJSON object with changed job attribute values. The job cannot be completed or failed with this endpoint, use the complete job or fail job endpoints instead.
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

LicenseResponse​

The response of a license request.

public sealed class LicenseResponse
PropertyTypeDescription
ValidLicenseBooleanTrue if the Camunda license is valid, false if otherwise
LicenseTypeStringWill return the license type property of the Camunda license
IsCommercialBooleanWill be false when a license contains a non-commerical=true property
ExpiresAtNullable<DateTimeOffset>The date when the Camunda license expires

LikeFilter​

Checks if the property matches the provided like value.

Supported wildcard characters are:

  • *: matches zero, one, or multiple characters.
  • ?: matches one, single character.

Wildcard characters can be escaped with backslash, for instance: \*.

public readonly record struct LikeFilter : ICamundaKey, IEquatable<LikeFilter>
PropertyTypeDescription
ValueStringThe underlying string value.

LimitPagination​

LimitPagination

public sealed class LimitPagination : SearchQueryPageRequest
PropertyTypeDescription
LimitNullable<Int32>The maximum number of items to return in one request.

MappingRuleCreateRequest​

MappingRuleCreateRequest

public sealed class MappingRuleCreateRequest
PropertyTypeDescription
MappingRuleIdStringThe unique ID of the mapping rule.
ClaimNameStringThe name of the claim to map.
ClaimValueStringThe value of the claim to map.
NameStringThe name of the mapping rule.

MappingRuleCreateResult​

MappingRuleCreateResult

public sealed class MappingRuleCreateResult
PropertyTypeDescription
ClaimNameStringThe name of the claim to map.
ClaimValueStringThe value of the claim to map.
NameStringThe name of the mapping rule.
MappingRuleIdStringThe unique ID of the mapping rule.

MappingRuleCreateUpdateRequest​

MappingRuleCreateUpdateRequest

public sealed class MappingRuleCreateUpdateRequest
PropertyTypeDescription
ClaimNameStringThe name of the claim to map.
ClaimValueStringThe value of the claim to map.
NameStringThe name of the mapping rule.

MappingRuleCreateUpdateResult​

MappingRuleCreateUpdateResult

public sealed class MappingRuleCreateUpdateResult
PropertyTypeDescription
ClaimNameStringThe name of the claim to map.
ClaimValueStringThe value of the claim to map.
NameStringThe name of the mapping rule.
MappingRuleIdStringThe unique ID of the mapping rule.

MappingRuleFilter​

Mapping rule search filter.

public sealed class MappingRuleFilter
PropertyTypeDescription
ClaimNameStringThe claim name to match against a token.
ClaimValueStringThe value of the claim to match.
NameStringThe name of the mapping rule.
MappingRuleIdStringThe ID of the mapping rule.

MappingRuleResult​

MappingRuleResult

public sealed class MappingRuleResult
PropertyTypeDescription
ClaimNameStringThe name of the claim to map.
ClaimValueStringThe value of the claim to map.
NameStringThe name of the mapping rule.
MappingRuleIdStringThe ID of the mapping rule.

MappingRuleSearchQueryRequest​

MappingRuleSearchQueryRequest

public sealed class MappingRuleSearchQueryRequest
PropertyTypeDescription
SortList<MappingRuleSearchQuerySortRequest>Sort field criteria.
FilterMappingRuleFilterThe mapping rule search filters.
PageSearchQueryPageRequestPagination criteria.

MappingRuleSearchQueryResult​

MappingRuleSearchQueryResult

public sealed class MappingRuleSearchQueryResult
PropertyTypeDescription
ItemsList<MappingRuleResult>The matching mapping rules.
PageSearchQueryPageResponsePagination information about the search results.

MappingRuleSearchQuerySortRequest​

MappingRuleSearchQuerySortRequest

public sealed class MappingRuleSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

MappingRuleUpdateRequest​

MappingRuleUpdateRequest

public sealed class MappingRuleUpdateRequest
PropertyTypeDescription
ClaimNameStringThe name of the claim to map.
ClaimValueStringThe value of the claim to map.
NameStringThe name of the mapping rule.

MappingRuleUpdateResult​

MappingRuleUpdateResult

public sealed class MappingRuleUpdateResult
PropertyTypeDescription
ClaimNameStringThe name of the claim to map.
ClaimValueStringThe value of the claim to map.
NameStringThe name of the mapping rule.
MappingRuleIdStringThe unique ID of the mapping rule.

MatchedDecisionRuleItem​

A decision rule that matched within this decision evaluation.

public sealed class MatchedDecisionRuleItem
PropertyTypeDescription
RuleIdStringThe ID of the matched rule.
RuleIndexNullable<Int32>The index of the matched rule.
EvaluatedOutputsList<EvaluatedDecisionOutputItem>The evaluated decision outputs.

MessageCorrelationRequest​

MessageCorrelationRequest

public sealed class MessageCorrelationRequest : ITenantIdSettable
PropertyTypeDescription
NameStringThe message name as defined in the BPMN process
CorrelationKeyStringThe correlation key of the message.
VariablesObjectThe message variables as JSON document
TenantIdNullable<TenantId>the tenant for which the message is published

MessageCorrelationResult​

The message key of the correlated message, as well as the first process instance key it correlated with.

public sealed class MessageCorrelationResult
PropertyTypeDescription
TenantIdNullable<TenantId>The tenant ID of the correlated message
MessageKeyNullable<MessageKey>The key of the correlated message.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of the first process instance the message correlated with

MessagePublicationRequest​

MessagePublicationRequest

public sealed class MessagePublicationRequest : ITenantIdSettable
PropertyTypeDescription
NameStringThe name of the message.
CorrelationKeyStringThe correlation key of the message.
TimeToLiveNullable<Int64>Timespan (in ms) to buffer the message on the broker.
MessageIdStringThe unique ID of the message. This is used to ensure only one message with the given ID will be published during the lifetime of the message (if timeToLive is set).
VariablesObjectThe message variables as JSON document.
TenantIdNullable<TenantId>The tenant of the message sender.

MessagePublicationResult​

The message key of the published message.

public sealed class MessagePublicationResult
PropertyTypeDescription
TenantIdNullable<TenantId>The tenant ID of the message.
MessageKeyNullable<MessageKey>The key of the published message.

MessageSubscriptionFilter​

Message subscription search filter.

public sealed class MessageSubscriptionFilter
PropertyTypeDescription
MessageSubscriptionKeyMessageSubscriptionKeyFilterPropertyThe message subscription key associated with this message subscription.
ProcessDefinitionKeyProcessDefinitionKeyFilterPropertyThe process definition key associated with this correlated message subscription. This only works for data created with 8.9 and later.
ProcessDefinitionIdStringFilterPropertyThe process definition ID associated with this message subscription.
ProcessInstanceKeyProcessInstanceKeyFilterPropertyThe process instance key associated with this message subscription.
ElementIdStringFilterPropertyThe element ID associated with this message subscription.
ElementInstanceKeyElementInstanceKeyFilterPropertyThe element instance key associated with this message subscription.
MessageSubscriptionStateMessageSubscriptionStateFilterPropertyThe message subscription state.
LastUpdatedDateDateTimeFilterPropertyThe last updated date of the message subscription.
MessageNameStringFilterPropertyThe name of the message associated with the message subscription.
CorrelationKeyStringFilterPropertyThe correlation key of the message subscription.
TenantIdStringFilterPropertyThe unique external tenant ID.

MessageSubscriptionKeyExactMatch​

Matches the value exactly.

public readonly record struct MessageSubscriptionKeyExactMatch : ICamundaKey, IEquatable<MessageSubscriptionKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

MessageSubscriptionKeyFilterProperty​

MessageSubscriptionKey property with full advanced search capabilities.

public sealed class MessageSubscriptionKeyFilterProperty

MessageSubscriptionResult​

MessageSubscriptionResult

public sealed class MessageSubscriptionResult
PropertyTypeDescription
MessageSubscriptionKeyNullable<MessageSubscriptionKey>The message subscription key associated with this message subscription.
ProcessDefinitionIdNullable<ProcessDefinitionId>The process definition ID associated with this message subscription.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The process definition key associated with this message subscription.
ProcessInstanceKeyNullable<ProcessInstanceKey>The process instance key associated with this message subscription.
RootProcessInstanceKeyNullable<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.
ElementIdNullable<ElementId>The element ID associated with this message subscription.
ElementInstanceKeyNullable<ElementInstanceKey>The element instance key associated with this message subscription.
MessageSubscriptionStateNullable<MessageSubscriptionStateEnum>The state of message subscription.
LastUpdatedDateNullable<DateTimeOffset>The last updated date of the message subscription.
MessageNameStringThe name of the message associated with the message subscription.
CorrelationKeyStringThe correlation key of the message subscription.
TenantIdNullable<TenantId>The unique identifier of the tenant.

MessageSubscriptionSearchQuery​

MessageSubscriptionSearchQuery

public sealed class MessageSubscriptionSearchQuery
PropertyTypeDescription
SortList<MessageSubscriptionSearchQuerySortRequest>Sort field criteria.
FilterMessageSubscriptionFilterThe incident search filters.
PageSearchQueryPageRequestPagination criteria.

MessageSubscriptionSearchQueryResult​

MessageSubscriptionSearchQueryResult

public sealed class MessageSubscriptionSearchQueryResult
PropertyTypeDescription
ItemsList<MessageSubscriptionResult>The matching message subscriptions.
PageSearchQueryPageResponsePagination information about the search results.

MessageSubscriptionSearchQuerySortRequest​

MessageSubscriptionSearchQuerySortRequest

public sealed class MessageSubscriptionSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

MessageSubscriptionStateExactMatch​

Matches the value exactly.

public readonly record struct MessageSubscriptionStateExactMatch : ICamundaKey, IEquatable<MessageSubscriptionStateExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

MessageSubscriptionStateFilterProperty​

MessageSubscriptionStateEnum with full advanced search capabilities.

public sealed class MessageSubscriptionStateFilterProperty

MigrateProcessInstanceMappingInstruction​

The mapping instructions describe how to map elements from the source process definition to the target process definition.

public sealed class MigrateProcessInstanceMappingInstruction
PropertyTypeDescription
SourceElementIdElementIdThe element id to migrate from.
TargetElementIdElementIdThe element id to migrate into.

MigrateProcessInstanceRequest​

The migration instructions describe how to migrate a process instance from one process definition to another.

public sealed class MigrateProcessInstanceRequest
PropertyTypeDescription
TargetProcessDefinitionKeyProcessDefinitionKeyThe key of process definition to migrate the process instance to.
MappingInstructionsList<MigrateProcessInstanceMappingInstruction>Element mappings from the source process instance to the target process instance.
OperationReferenceNullable<Int64>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

MigrateProcessInstancesBatchOperationRequest​

MigrateProcessInstancesBatchOperationRequest

public sealed class MigrateProcessInstancesBatchOperationRequest
PropertyTypeDescription
FilterProcessInstanceFilterThe process instance filter.
MigrationPlanProcessInstanceMigrationBatchOperationPlanThe migration plan.
OperationReferenceNullable<Int64>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

ModifyProcessInstanceRequest​

ModifyProcessInstanceRequest

public sealed class ModifyProcessInstanceRequest
PropertyTypeDescription
OperationReferenceNullable<Int64>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.
ActivateInstructionsList<ProcessInstanceModificationActivateInstruction>Instructions describing which elements to activate in which scopes and which variables to create or update.
MoveInstructionsList<ProcessInstanceModificationMoveInstruction>Instructions describing which elements to move from one scope to another.
TerminateInstructionsList<ProcessInstanceModificationTerminateInstruction>Instructions describing which elements to terminate.

ModifyProcessInstanceVariableInstruction​

Instruction describing which variables to create or update.

public sealed class ModifyProcessInstanceVariableInstruction
PropertyTypeDescription
VariablesObjectJSON document that will instantiate the variables at the scope defined by the scopeId. It must be a JSON object, as variables will be mapped in a key-value fashion.
ScopeIdStringThe id of the element in which scope the variables should be created. Leave empty to create the variables in the global scope of the process instance.

ModifyProcessInstancesBatchOperationRequest​

The process instance filter to define on which process instances tokens should be moved, and new element instances should be activated or terminated.

public sealed class ModifyProcessInstancesBatchOperationRequest
PropertyTypeDescription
FilterProcessInstanceFilterThe process instance filter.
MoveInstructionsList<ProcessInstanceModificationMoveBatchOperationInstruction>Instructions for moving tokens between elements.
OperationReferenceNullable<Int64>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

OffsetPagination​

OffsetPagination

public sealed class OffsetPagination : SearchQueryPageRequest
PropertyTypeDescription
FromNullable<Int32>The index of items to start searching from.
LimitNullable<Int32>The maximum number of items to return in one request.

OperationReference​

A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

public readonly record struct OperationReference : ICamundaLongKey, IEquatable<OperationReference>
PropertyTypeDescription
ValueInt64The underlying long value.

OperationTypeExactMatch​

Matches the value exactly.

public readonly record struct OperationTypeExactMatch : ICamundaKey, IEquatable<OperationTypeExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

OperationTypeFilterProperty​

AuditLogOperationTypeEnum property with full advanced search capabilities.

public sealed class OperationTypeFilterProperty

Partition​

Provides information on a partition within a broker node.

public sealed class Partition
PropertyTypeDescription
PartitionIdInt32The unique ID of this partition.
RoleStringDescribes the Raft role of the broker for a given partition.
HealthStringDescribes the current health of the partition.

ProblemDetail​

A Problem detail object as described in RFC 9457. There may be additional properties specific to the problem type.

public sealed class ProblemDetail
PropertyTypeDescription
TypeStringA URI identifying the problem type.
TitleStringA summary of the problem type.
StatusNullable<Int32>The HTTP status code for this problem.
DetailStringAn explanation of the problem in more detail.
InstanceStringA URI path identifying the origin of the problem.

ProcessDefinitionElementStatisticsQuery​

Process definition element statistics request.

public sealed class ProcessDefinitionElementStatisticsQuery
PropertyTypeDescription
FilterProcessDefinitionStatisticsFilterThe process definition statistics search filters.

ProcessDefinitionElementStatisticsQueryResult​

Process definition element statistics query response.

public sealed class ProcessDefinitionElementStatisticsQueryResult
PropertyTypeDescription
ItemsList<ProcessElementStatisticsResult>The element statistics.

ProcessDefinitionFilter​

Process definition search filter.

public sealed class ProcessDefinitionFilter
PropertyTypeDescription
NameStringFilterPropertyName of this process definition.
IsLatestVersionNullable<Boolean>Whether to only return the latest version of each process definition. When using this filter, pagination functionality is limited, you can only paginate forward using after and limit. The response contains no startCursor in the page, and requests ignore the from and before in the page.
ResourceNameStringResource name of this process definition.
VersionNullable<Int32>Version of this process definition.
VersionTagStringVersion tag of this process definition.
ProcessDefinitionIdStringFilterPropertyProcess definition ID of this process definition.
TenantIdNullable<TenantId>Tenant ID of this process definition.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The key for this process definition.
HasStartFormNullable<Boolean>Indicates whether the start event of the process has an associated Form Key.

ProcessDefinitionId​

Id of a process definition, from the model. Only ids of process definitions that are deployed are useful.

public readonly record struct ProcessDefinitionId : ICamundaKey, IEquatable<ProcessDefinitionId>
PropertyTypeDescription
ValueStringThe underlying string value.

ProcessDefinitionInstanceStatisticsQuery​

ProcessDefinitionInstanceStatisticsQuery

public sealed class ProcessDefinitionInstanceStatisticsQuery
PropertyTypeDescription
PageOffsetPagination
SortList<ProcessDefinitionInstanceStatisticsQuerySortRequest>Sort field criteria.

ProcessDefinitionInstanceStatisticsQueryResult​

ProcessDefinitionInstanceStatisticsQueryResult

public sealed class ProcessDefinitionInstanceStatisticsQueryResult
PropertyTypeDescription
ItemsList<ProcessDefinitionInstanceStatisticsResult>The process definition instance statistics result.
PageSearchQueryPageResponsePagination information about the search results.

ProcessDefinitionInstanceStatisticsQuerySortRequest​

ProcessDefinitionInstanceStatisticsQuerySortRequest

public sealed class ProcessDefinitionInstanceStatisticsQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

ProcessDefinitionInstanceStatisticsResult​

Process definition instance statistics response.

public sealed class ProcessDefinitionInstanceStatisticsResult
PropertyTypeDescription
ProcessDefinitionIdNullable<ProcessDefinitionId>Id of a process definition, from the model. Only ids of process definitions that are deployed are useful.
TenantIdNullable<TenantId>The unique identifier of the tenant.
LatestProcessDefinitionNameStringName of the latest deployed process definition instance version.
HasMultipleVersionsNullable<Boolean>Indicates whether multiple versions of this process definition instance are deployed.
ActiveInstancesWithoutIncidentCountNullable<Int64>Total number of currently active process instances of this definition that do not have incidents.
ActiveInstancesWithIncidentCountNullable<Int64>Total number of currently active process instances of this definition that have at least one incident.

ProcessDefinitionInstanceVersionStatisticsFilter​

Process definition instance version statistics search filter.

public sealed class ProcessDefinitionInstanceVersionStatisticsFilter
PropertyTypeDescription
ProcessDefinitionIdProcessDefinitionIdThe ID of the process definition to retrieve version statistics for.
TenantIdNullable<TenantId>Tenant ID of this process definition.

ProcessDefinitionInstanceVersionStatisticsQuery​

ProcessDefinitionInstanceVersionStatisticsQuery

public sealed class ProcessDefinitionInstanceVersionStatisticsQuery
PropertyTypeDescription
PageOffsetPaginationPagination criteria.
SortList<ProcessDefinitionInstanceVersionStatisticsQuerySortRequest>Sort field criteria.
FilterProcessDefinitionInstanceVersionStatisticsFilterThe process definition instance version statistics search filters.

ProcessDefinitionInstanceVersionStatisticsQueryResult​

ProcessDefinitionInstanceVersionStatisticsQueryResult

public sealed class ProcessDefinitionInstanceVersionStatisticsQueryResult
PropertyTypeDescription
ItemsList<ProcessDefinitionInstanceVersionStatisticsResult>The process definition instance version statistics result.
PageSearchQueryPageResponsePagination information about the search results.

ProcessDefinitionInstanceVersionStatisticsQuerySortRequest​

ProcessDefinitionInstanceVersionStatisticsQuerySortRequest

public sealed class ProcessDefinitionInstanceVersionStatisticsQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

ProcessDefinitionInstanceVersionStatisticsResult​

Process definition instance version statistics response.

public sealed class ProcessDefinitionInstanceVersionStatisticsResult
PropertyTypeDescription
ProcessDefinitionIdProcessDefinitionIdThe ID associated with the process definition.
ProcessDefinitionKeyProcessDefinitionKeyThe unique key of the process definition.
ProcessDefinitionNameStringThe name of the process definition.
TenantIdTenantIdThe tenant ID associated with the process definition.
ProcessDefinitionVersionInt32The version number of the process definition.
ActiveInstancesWithIncidentCountInt64The number of active process instances for this version that currently have incidents.
ActiveInstancesWithoutIncidentCountInt64The number of active process instances for this version that do not have any incidents.

ProcessDefinitionKeyExactMatch​

Matches the value exactly.

public readonly record struct ProcessDefinitionKeyExactMatch : ICamundaKey, IEquatable<ProcessDefinitionKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

ProcessDefinitionKeyFilterProperty​

ProcessDefinitionKey property with full advanced search capabilities.

public sealed class ProcessDefinitionKeyFilterProperty

ProcessDefinitionMessageSubscriptionStatisticsQuery​

ProcessDefinitionMessageSubscriptionStatisticsQuery

public sealed class ProcessDefinitionMessageSubscriptionStatisticsQuery
PropertyTypeDescription
PageCursorForwardPagination
FilterMessageSubscriptionFilterThe message subscription filters.

ProcessDefinitionMessageSubscriptionStatisticsQueryResult​

ProcessDefinitionMessageSubscriptionStatisticsQueryResult

public sealed class ProcessDefinitionMessageSubscriptionStatisticsQueryResult
PropertyTypeDescription
ItemsList<ProcessDefinitionMessageSubscriptionStatisticsResult>The matching process definition message subscription statistics.
PageSearchQueryPageResponsePagination information about the search results.

ProcessDefinitionMessageSubscriptionStatisticsResult​

ProcessDefinitionMessageSubscriptionStatisticsResult

public sealed class ProcessDefinitionMessageSubscriptionStatisticsResult
PropertyTypeDescription
ProcessDefinitionIdNullable<ProcessDefinitionId>The process definition ID associated with this message subscription.
TenantIdNullable<TenantId>The tenant ID associated with this message subscription.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The process definition key associated with this message subscription.
ProcessInstancesWithActiveSubscriptionsNullable<Int64>The number of process instances with active message subscriptions.
ActiveSubscriptionsNullable<Int64>The total number of active message subscriptions for this process definition key.

ProcessDefinitionResult​

ProcessDefinitionResult

public sealed class ProcessDefinitionResult
PropertyTypeDescription
NameStringName of this process definition.
ResourceNameStringResource name for this process definition.
VersionNullable<Int32>Version of this process definition.
VersionTagStringVersion tag of this process definition.
ProcessDefinitionIdNullable<ProcessDefinitionId>Process definition ID of this process definition.
TenantIdNullable<TenantId>Tenant ID of this process definition.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The key for this process definition.
HasStartFormNullable<Boolean>Indicates whether the start event of the process has an associated Form Key.

ProcessDefinitionSearchQuery​

ProcessDefinitionSearchQuery

public sealed class ProcessDefinitionSearchQuery
PropertyTypeDescription
SortList<ProcessDefinitionSearchQuerySortRequest>Sort field criteria.
FilterProcessDefinitionFilterThe process definition search filters.
PageSearchQueryPageRequestPagination criteria.

ProcessDefinitionSearchQueryResult​

ProcessDefinitionSearchQueryResult

public sealed class ProcessDefinitionSearchQueryResult
PropertyTypeDescription
ItemsList<ProcessDefinitionResult>The matching process definitions.
PageSearchQueryPageResponsePagination information about the search results.

ProcessDefinitionSearchQuerySortRequest​

ProcessDefinitionSearchQuerySortRequest

public sealed class ProcessDefinitionSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

ProcessDefinitionStatisticsFilter​

Process definition statistics search filter.

public sealed class ProcessDefinitionStatisticsFilter
PropertyTypeDescription
StartDateDateTimeFilterPropertyThe start date.
EndDateDateTimeFilterPropertyThe end date.
StateProcessInstanceStateFilterPropertyThe process instance state.
HasIncidentNullable<Boolean>Whether this process instance has a related incident or not.
TenantIdStringFilterPropertyThe tenant id.
VariablesList<VariableValueFilterProperty>The process instance variables.
ProcessInstanceKeyProcessInstanceKeyFilterPropertyThe key of this process instance.
ParentProcessInstanceKeyProcessInstanceKeyFilterPropertyThe parent process instance key.
ParentElementInstanceKeyElementInstanceKeyFilterPropertyThe parent element instance key.
BatchOperationIdStringFilterPropertyThe batch operation id.
ErrorMessageStringFilterPropertyThe error message related to the process.
HasRetriesLeftNullable<Boolean>Whether the process has failed jobs with retries left.
ElementInstanceStateElementInstanceStateFilterPropertyThe state of the element instances associated with the process instance.
ElementIdStringFilterPropertyThe element id associated with the process instance.
HasElementInstanceIncidentNullable<Boolean>Whether the element instance has an incident or not.
IncidentErrorHashCodeIntegerFilterPropertyThe incident error hash code, associated with this process.
TagsList<Tag>List of tags. Tags need to start with a letter; then alphanumerics, _, -, :, or .; length ≤ 100.
OrList<BaseProcessInstanceFilterFields>Defines a list of alternative filter groups combined using OR logic. Each object in the array is evaluated independently, and the filter matches if any one of them is satisfied. Top-level fields and the $or clause are combined using AND logic — meaning: (top-level filters) AND (any of the $or filters) must match. <br> <em>Example:</em> json { "state": "ACTIVE", "tenantId": 123, "$or": [ { "processDefinitionId": "process_v1" }, { "processDefinitionId": "process_v2", "hasIncident": true } ] } This matches process instances that: <ul style="padding-left: 20px; margin-left: 20px;"> <li style="list-style-type: disc;">are in <em>ACTIVE</em> state</li> <li style="list-style-type: disc;">have tenant id equal to <em>123</em></li> <li style="list-style-type: disc;">and match either: <ul style="padding-left: 20px; margin-left: 20px;"> <li style="list-style-type: circle;"><code>processDefinitionId</code> is <em>process_v1</em>, or</li> <li style="list-style-type: circle;"><code>processDefinitionId</code> is <em>process_v2</em> and <code>hasIncident</code> is <em>true</em></li> </ul> </li> </ul> <br> <p>Note: Using complex <code>$or</code> conditions may impact performance, use with caution in high-volume environments.

ProcessElementStatisticsResult​

Process element statistics response.

public sealed class ProcessElementStatisticsResult
PropertyTypeDescription
ElementIdNullable<ElementId>The element ID for which the results are aggregated.
ActiveNullable<Int64>The total number of active instances of the element.
CanceledNullable<Int64>The total number of canceled instances of the element.
IncidentsNullable<Int64>The total number of incidents for the element.
CompletedNullable<Int64>The total number of completed instances of the element.

ProcessInstanceCallHierarchyEntry​

ProcessInstanceCallHierarchyEntry

public sealed class ProcessInstanceCallHierarchyEntry
PropertyTypeDescription
ProcessInstanceKeyProcessInstanceKeyThe key of the process instance.
ProcessDefinitionKeyProcessDefinitionKeyThe key of the process definition.
ProcessDefinitionNameStringThe name of the process definition (fall backs to the process definition id if not available).

ProcessInstanceCancellationBatchOperationRequest​

The process instance filter that defines which process instances should be canceled.

public sealed class ProcessInstanceCancellationBatchOperationRequest
PropertyTypeDescription
FilterProcessInstanceFilterThe process instance filter.
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

ProcessInstanceCreationInstruction​

Instructions for creating a process instance. The process definition can be specified either by id or by key.

public abstract class ProcessInstanceCreationInstruction

ProcessInstanceCreationInstructionById​

ProcessInstanceCreationInstructionById

public sealed class ProcessInstanceCreationInstructionById : ProcessInstanceCreationInstruction, ITenantIdSettable
PropertyTypeDescription
ProcessDefinitionIdProcessDefinitionIdThe BPMN process id of the process definition to start an instance of.
ProcessDefinitionVersionNullable<Int32>The version of the process. By default, the latest version of the process is used.
VariablesObjectJSON object that will instantiate the variables for the root variable scope of the process instance.
TenantIdNullable<TenantId>The tenant id of the process definition.
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.
StartInstructionsList<ProcessInstanceCreationStartInstruction>List of start instructions. By default, the process instance will start at the start event. If provided, the process instance will apply start instructions after it has been created.
RuntimeInstructionsList<ProcessInstanceCreationRuntimeInstruction>Runtime instructions (alpha). List of instructions that affect the runtime behavior of the process instance. Refer to specific instruction types for more details. This parameter is an alpha feature and may be subject to change in future releases.
AwaitCompletionNullable<Boolean>Wait for the process instance to complete. If the process instance completion does not occur within the requestTimeout, the request will be closed. This can lead to a 504 response status. Disabled by default.
FetchVariablesList<String>List of variables by name to be included in the response when awaitCompletion is set to true. If empty, all visible variables in the root scope will be returned.
RequestTimeoutNullable<Int64>Timeout (in ms) the request waits for the process to complete. By default or when set to 0, the generic request timeout configured in the cluster is applied.
TagsList<Tag>List of tags. Tags need to start with a letter; then alphanumerics, _, -, :, or .; length ≤ 100.

ProcessInstanceCreationInstructionByKey​

ProcessInstanceCreationInstructionByKey

public sealed class ProcessInstanceCreationInstructionByKey : ProcessInstanceCreationInstruction, ITenantIdSettable
PropertyTypeDescription
ProcessDefinitionKeyProcessDefinitionKeyThe unique key identifying the process definition, for example, returned for a process in the deploy resources endpoint.
ProcessDefinitionVersionNullable<Int32>As the version is already identified by the processDefinitionKey, the value of this field is ignored. It's here for backwards-compatibility only as previous releases accepted it in request bodies.
VariablesObjectJSON object that will instantiate the variables for the root variable scope of the process instance.
StartInstructionsList<ProcessInstanceCreationStartInstruction>List of start instructions. By default, the process instance will start at the start event. If provided, the process instance will apply start instructions after it has been created.
RuntimeInstructionsList<ProcessInstanceCreationRuntimeInstruction>Runtime instructions (alpha). List of instructions that affect the runtime behavior of the process instance. Refer to specific instruction types for more details. This parameter is an alpha feature and may be subject to change in future releases.
TenantIdNullable<TenantId>The tenant id of the process definition.
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.
AwaitCompletionNullable<Boolean>Wait for the process instance to complete. If the process instance completion does not occur within the requestTimeout, the request will be closed. This can lead to a 504 response status. Disabled by default.
RequestTimeoutNullable<Int64>Timeout (in ms) the request waits for the process to complete. By default or when set to 0, the generic request timeout configured in the cluster is applied.
FetchVariablesList<String>List of variables by name to be included in the response when awaitCompletion is set to true. If empty, all visible variables in the root scope will be returned.
TagsList<Tag>List of tags. Tags need to start with a letter; then alphanumerics, _, -, :, or .; length ≤ 100.

ProcessInstanceCreationRuntimeInstruction​

ProcessInstanceCreationRuntimeInstruction

public abstract class ProcessInstanceCreationRuntimeInstruction

ProcessInstanceCreationStartInstruction​

ProcessInstanceCreationStartInstruction

public sealed class ProcessInstanceCreationStartInstruction
PropertyTypeDescription
ElementIdElementIdFuture extensions might include: - different types of start instructions - ability to set local variables for different flow scopes For now, however, the start instruction is implicitly a "startBeforeElement" instruction

ProcessInstanceCreationTerminateInstruction​

Terminates the process instance after a specific BPMN element is completed or terminated.

public sealed class ProcessInstanceCreationTerminateInstruction : ProcessInstanceCreationRuntimeInstruction
PropertyTypeDescription
TypeStringThe type of the runtime instruction
AfterElementIdElementIdThe id of the element that, once completed or terminated, will cause the process to be terminated.

ProcessInstanceDeletionBatchOperationRequest​

The process instance filter that defines which process instances should be deleted.

public sealed class ProcessInstanceDeletionBatchOperationRequest
PropertyTypeDescription
FilterProcessInstanceFilterThe process instance filter.
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

ProcessInstanceElementStatisticsQueryResult​

Process instance element statistics query response.

public sealed class ProcessInstanceElementStatisticsQueryResult
PropertyTypeDescription
ItemsList<ProcessElementStatisticsResult>The element statistics.

ProcessInstanceFilter​

Process instance search filter.

public sealed class ProcessInstanceFilter
PropertyTypeDescription
ProcessDefinitionIdStringFilterPropertyThe process definition id.
ProcessDefinitionNameStringFilterPropertyThe process definition name.
ProcessDefinitionVersionIntegerFilterPropertyThe process definition version.
ProcessDefinitionVersionTagStringFilterPropertyThe process definition version tag.
ProcessDefinitionKeyProcessDefinitionKeyFilterPropertyThe process definition key.
OrList<ProcessInstanceFilterFields>Defines a list of alternative filter groups combined using OR logic. Each object in the array is evaluated independently, and the filter matches if any one of them is satisfied. Top-level fields and the $or clause are combined using AND logic — meaning: (top-level filters) AND (any of the $or filters) must match. <br> <em>Example:</em> json { "state": "ACTIVE", "tenantId": 123, "$or": [ { "processDefinitionId": "process_v1" }, { "processDefinitionId": "process_v2", "hasIncident": true } ] } This matches process instances that: <ul style="padding-left: 20px; margin-left: 20px;"> <li style="list-style-type: disc;">are in <em>ACTIVE</em> state</li> <li style="list-style-type: disc;">have tenant id equal to <em>123</em></li> <li style="list-style-type: disc;">and match either: <ul style="padding-left: 20px; margin-left: 20px;"> <li style="list-style-type: circle;"><code>processDefinitionId</code> is <em>process_v1</em>, or</li> <li style="list-style-type: circle;"><code>processDefinitionId</code> is <em>process_v2</em> and <code>hasIncident</code> is <em>true</em></li> </ul> </li> </ul> <br> <p>Note: Using complex <code>$or</code> conditions may impact performance, use with caution in high-volume environments.

ProcessInstanceFilterFields​

Process instance search filter.

public sealed class ProcessInstanceFilterFields
PropertyTypeDescription
ProcessDefinitionIdStringFilterPropertyThe process definition id.
ProcessDefinitionNameStringFilterPropertyThe process definition name.
ProcessDefinitionVersionIntegerFilterPropertyThe process definition version.
ProcessDefinitionVersionTagStringFilterPropertyThe process definition version tag.
ProcessDefinitionKeyProcessDefinitionKeyFilterPropertyThe process definition key.
StartDateDateTimeFilterPropertyThe start date.
EndDateDateTimeFilterPropertyThe end date.
StateProcessInstanceStateFilterPropertyThe process instance state.
HasIncidentNullable<Boolean>Whether this process instance has a related incident or not.
TenantIdStringFilterPropertyThe tenant id.
VariablesList<VariableValueFilterProperty>The process instance variables.
ProcessInstanceKeyProcessInstanceKeyFilterPropertyThe key of this process instance.
ParentProcessInstanceKeyProcessInstanceKeyFilterPropertyThe parent process instance key.
ParentElementInstanceKeyElementInstanceKeyFilterPropertyThe parent element instance key.
BatchOperationIdStringFilterPropertyThe batch operation id.
ErrorMessageStringFilterPropertyThe error message related to the process.
HasRetriesLeftNullable<Boolean>Whether the process has failed jobs with retries left.
ElementInstanceStateElementInstanceStateFilterPropertyThe state of the element instances associated with the process instance.
ElementIdStringFilterPropertyThe element id associated with the process instance.
HasElementInstanceIncidentNullable<Boolean>Whether the element instance has an incident or not.
IncidentErrorHashCodeIntegerFilterPropertyThe incident error hash code, associated with this process.
TagsList<Tag>List of tags. Tags need to start with a letter; then alphanumerics, _, -, :, or .; length ≤ 100.

ProcessInstanceIncidentResolutionBatchOperationRequest​

The process instance filter that defines which process instances should have their incidents resolved.

public sealed class ProcessInstanceIncidentResolutionBatchOperationRequest
PropertyTypeDescription
FilterProcessInstanceFilterThe process instance filter.
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

ProcessInstanceKeyExactMatch​

Matches the value exactly.

public readonly record struct ProcessInstanceKeyExactMatch : ICamundaKey, IEquatable<ProcessInstanceKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

ProcessInstanceKeyFilterProperty​

ProcessInstanceKey property with full advanced search capabilities.

public sealed class ProcessInstanceKeyFilterProperty

ProcessInstanceMigrationBatchOperationPlan​

The migration instructions describe how to migrate a process instance from one process definition to another.

public sealed class ProcessInstanceMigrationBatchOperationPlan
PropertyTypeDescription
TargetProcessDefinitionKeyProcessDefinitionKeyThe target process definition key.
MappingInstructionsList<MigrateProcessInstanceMappingInstruction>The mapping instructions.

ProcessInstanceMigrationBatchOperationRequest​

ProcessInstanceMigrationBatchOperationRequest

public sealed class ProcessInstanceMigrationBatchOperationRequest
PropertyTypeDescription
FilterProcessInstanceFilterThe process instance filter.
MigrationPlanProcessInstanceMigrationBatchOperationPlanThe migration plan.
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

ProcessInstanceMigrationInstruction​

The migration instructions describe how to migrate a process instance from one process definition to another.

public sealed class ProcessInstanceMigrationInstruction
PropertyTypeDescription
TargetProcessDefinitionKeyProcessDefinitionKeyThe key of process definition to migrate the process instance to.
MappingInstructionsList<MigrateProcessInstanceMappingInstruction>Element mappings from the source process instance to the target process instance.
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

ProcessInstanceModificationActivateInstruction​

Instruction describing an element to activate.

public sealed class ProcessInstanceModificationActivateInstruction
PropertyTypeDescription
ElementIdElementIdThe id of the element to activate.
VariableInstructionsList<ModifyProcessInstanceVariableInstruction>Instructions describing which variables to create or update.
AncestorElementInstanceKeyObjectThe key of the ancestor scope the element instance should be created in. Set to -1 to create the new element instance within an existing element instance of the flow scope. If multiple instances of the target element's flow scope exist, choose one specifically with this property by providing its key.

ProcessInstanceModificationBatchOperationRequest​

The process instance filter to define on which process instances tokens should be moved, and new element instances should be activated or terminated.

public sealed class ProcessInstanceModificationBatchOperationRequest
PropertyTypeDescription
FilterProcessInstanceFilterThe process instance filter.
MoveInstructionsList<ProcessInstanceModificationMoveBatchOperationInstruction>Instructions for moving tokens between elements.
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

ProcessInstanceModificationInstruction​

ProcessInstanceModificationInstruction

public sealed class ProcessInstanceModificationInstruction
PropertyTypeDescription
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.
ActivateInstructionsList<ProcessInstanceModificationActivateInstruction>Instructions describing which elements to activate in which scopes and which variables to create or update.
MoveInstructionsList<ProcessInstanceModificationMoveInstruction>Instructions describing which elements to move from one scope to another.
TerminateInstructionsList<ProcessInstanceModificationTerminateInstruction>Instructions describing which elements to terminate.

ProcessInstanceModificationMoveBatchOperationInstruction​

Instructions describing a move operation. This instruction will terminate all active element instances at sourceElementId and activate a new element instance for each terminated one at targetElementId. The new element instances are created in the parent scope of the source element instances.

public sealed class ProcessInstanceModificationMoveBatchOperationInstruction
PropertyTypeDescription
SourceElementIdElementIdThe source element ID.
TargetElementIdElementIdThe target element ID.

ProcessInstanceModificationMoveInstruction​

Instruction describing a move operation. This instruction will terminate active element instances based on the sourceElementInstruction and activate a new element instance for each terminated one at targetElementId. Note that, for multi-instance activities, only the multi-instance body instances will activate new element instances at the target id.

public sealed class ProcessInstanceModificationMoveInstruction
PropertyTypeDescription
SourceElementInstructionSourceElementInstructionDefines the source element identifier for the move instruction. It can either be a sourceElementId, or sourceElementInstanceKey.
TargetElementIdElementIdThe target element id.
AncestorScopeInstructionAncestorScopeInstructionDefines the ancestor scope for the created element instances. The default behavior resembles a "direct" scope instruction with an ancestorElementInstanceKey of "-1".
VariableInstructionsList<ModifyProcessInstanceVariableInstruction>Instructions describing which variables to create or update.

ProcessInstanceModificationTerminateByIdInstruction​

Instruction describing which elements to terminate. The element instances are determined at runtime by the given id.

public sealed class ProcessInstanceModificationTerminateByIdInstruction : ProcessInstanceModificationTerminateInstruction
PropertyTypeDescription
ElementIdElementIdThe id of the elements to terminate. The element instances are determined at runtime.

ProcessInstanceModificationTerminateByKeyInstruction​

Instruction providing the key of the element instance to terminate.

public sealed class ProcessInstanceModificationTerminateByKeyInstruction : ProcessInstanceModificationTerminateInstruction
PropertyTypeDescription
ElementInstanceKeyElementInstanceKeyThe key of the element instance to terminate.

ProcessInstanceModificationTerminateInstruction​

Instruction describing which elements to terminate.

public abstract class ProcessInstanceModificationTerminateInstruction

ProcessInstanceReference​

ProcessInstanceReference

public sealed class ProcessInstanceReference
PropertyTypeDescription
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The key of the process definition.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of the created process instance.

ProcessInstanceResult​

Process instance search response item.

public sealed class ProcessInstanceResult
PropertyTypeDescription
ProcessDefinitionIdProcessDefinitionIdId of a process definition, from the model. Only ids of process definitions that are deployed are useful.
ProcessDefinitionNameStringThe process definition name.
ProcessDefinitionVersionInt32
ProcessDefinitionVersionTagStringThe process definition version tag.
StartDateDateTimeOffset
EndDateNullable<DateTimeOffset>
StateProcessInstanceStateEnumProcess instance states
HasIncidentBooleanWhether this process instance has a related incident or not.
TenantIdTenantIdThe unique identifier of the tenant.
ProcessInstanceKeyProcessInstanceKeyThe key of this process instance.
ProcessDefinitionKeyProcessDefinitionKeyThe process definition key.
ParentProcessInstanceKeyNullable<ProcessInstanceKey>The parent process instance key.
ParentElementInstanceKeyNullable<ElementInstanceKey>The parent element instance key.
RootProcessInstanceKeyNullable<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.
TagsList<Tag>List of tags. Tags need to start with a letter; then alphanumerics, _, -, :, or .; length ≤ 100.

ProcessInstanceSearchQuery​

Process instance search request.

public sealed class ProcessInstanceSearchQuery
PropertyTypeDescription
SortList<ProcessInstanceSearchQuerySortRequest>Sort field criteria.
FilterProcessInstanceFilterThe process instance search filters.
PageSearchQueryPageRequestPagination criteria.

ProcessInstanceSearchQueryResult​

Process instance search response.

public sealed class ProcessInstanceSearchQueryResult
PropertyTypeDescription
ItemsList<ProcessInstanceResult>The matching process instances.
PageSearchQueryPageResponsePagination information about the search results.

ProcessInstanceSearchQuerySortRequest​

ProcessInstanceSearchQuerySortRequest

public sealed class ProcessInstanceSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

ProcessInstanceSequenceFlowResult​

Process instance sequence flow result.

public sealed class ProcessInstanceSequenceFlowResult
PropertyTypeDescription
SequenceFlowIdStringThe sequence flow id.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of this process instance.
RootProcessInstanceKeyNullable<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.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The process definition key.
ProcessDefinitionIdNullable<ProcessDefinitionId>The process definition id.
ElementIdNullable<ElementId>The element id for this sequence flow, as provided in the BPMN process.
TenantIdNullable<TenantId>The unique identifier of the tenant.

ProcessInstanceSequenceFlowsQueryResult​

Process instance sequence flows query response.

public sealed class ProcessInstanceSequenceFlowsQueryResult
PropertyTypeDescription
ItemsList<ProcessInstanceSequenceFlowResult>The sequence flows.

ProcessInstanceStateExactMatch​

Matches the value exactly.

public readonly record struct ProcessInstanceStateExactMatch : ICamundaKey, IEquatable<ProcessInstanceStateExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

ProcessInstanceStateFilterProperty​

ProcessInstanceStateEnum property with full advanced search capabilities.

public sealed class ProcessInstanceStateFilterProperty

PublishMessageResponse​

The message key of the published message.

public sealed class PublishMessageResponse
PropertyTypeDescription
TenantIdNullable<TenantId>The tenant ID of the message.
MessageKeyObjectThe key of the published message.

ResolveIncidentsBatchOperationRequest​

The process instance filter that defines which process instances should have their incidents resolved.

public sealed class ResolveIncidentsBatchOperationRequest
PropertyTypeDescription
FilterProcessInstanceFilterThe process instance filter.
OperationReferenceNullable<Int64>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

ResourceKeyExactMatch​

Matches the value exactly.

public readonly record struct ResourceKeyExactMatch : ICamundaKey, IEquatable<ResourceKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

ResourceKeyFilterProperty​

ResourceKey property with full advanced search capabilities.

public sealed class ResourceKeyFilterProperty

ResourceResult​

ResourceResult

public sealed class ResourceResult
PropertyTypeDescription
ResourceNameStringThe resource name from which this resource was parsed.
VersionNullable<Int32>The assigned resource version.
VersionTagStringThe version tag of this resource.
ResourceIdStringThe resource ID of this resource.
TenantIdNullable<TenantId>The tenant ID of this resource.
ResourceKeyNullable<ResourceKey>The unique key of this resource.

RoleClientResult​

RoleClientResult

public sealed class RoleClientResult
PropertyTypeDescription
ClientIdStringThe ID of the client.

RoleClientSearchQueryRequest​

RoleClientSearchQueryRequest

public sealed class RoleClientSearchQueryRequest
PropertyTypeDescription
SortList<RoleClientSearchQuerySortRequest>Sort field criteria.
PageSearchQueryPageRequestPagination criteria.

RoleClientSearchQuerySortRequest​

RoleClientSearchQuerySortRequest

public sealed class RoleClientSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

RoleClientSearchResult​

RoleClientSearchResult

public sealed class RoleClientSearchResult
PropertyTypeDescription
ItemsList<RoleClientResult>The matching clients.
PageSearchQueryPageResponsePagination information about the search results.

RoleCreateRequest​

RoleCreateRequest

public sealed class RoleCreateRequest
PropertyTypeDescription
RoleIdStringThe ID of the new role.
NameStringThe display name of the new role.
DescriptionStringThe description of the new role.

RoleCreateResult​

RoleCreateResult

public sealed class RoleCreateResult
PropertyTypeDescription
RoleIdStringThe ID of the created role.
NameStringThe display name of the created role.
DescriptionStringThe description of the created role.

RoleFilter​

Role filter request

public sealed class RoleFilter
PropertyTypeDescription
RoleIdStringThe role ID search filters.
NameStringThe role name search filters.

RoleGroupResult​

RoleGroupResult

public sealed class RoleGroupResult
PropertyTypeDescription
GroupIdStringThe id of the group.

RoleGroupSearchQueryRequest​

RoleGroupSearchQueryRequest

public sealed class RoleGroupSearchQueryRequest
PropertyTypeDescription
SortList<RoleGroupSearchQuerySortRequest>Sort field criteria.
PageSearchQueryPageRequestPagination criteria.

RoleGroupSearchQuerySortRequest​

RoleGroupSearchQuerySortRequest

public sealed class RoleGroupSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

RoleGroupSearchResult​

RoleGroupSearchResult

public sealed class RoleGroupSearchResult
PropertyTypeDescription
ItemsList<RoleGroupResult>The matching groups.
PageSearchQueryPageResponsePagination information about the search results.

RoleResult​

Role search response item.

public sealed class RoleResult
PropertyTypeDescription
NameStringThe role name.
RoleIdStringThe role id.
DescriptionStringThe description of the role.

RoleSearchQueryRequest​

Role search request.

public sealed class RoleSearchQueryRequest
PropertyTypeDescription
SortList<RoleSearchQuerySortRequest>Sort field criteria.
FilterRoleFilterThe role search filters.
PageSearchQueryPageRequestPagination criteria.

RoleSearchQueryResult​

Role search response.

public sealed class RoleSearchQueryResult
PropertyTypeDescription
ItemsList<RoleResult>The matching roles.
PageSearchQueryPageResponsePagination information about the search results.

RoleSearchQuerySortRequest​

RoleSearchQuerySortRequest

public sealed class RoleSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

RoleUpdateRequest​

RoleUpdateRequest

public sealed class RoleUpdateRequest
PropertyTypeDescription
NameStringThe display name of the new role.
DescriptionStringThe description of the new role.

RoleUpdateResult​

RoleUpdateResult

public sealed class RoleUpdateResult
PropertyTypeDescription
NameStringThe display name of the updated role.
DescriptionStringThe description of the updated role.
RoleIdStringThe ID of the updated role.

RoleUserResult​

RoleUserResult

public sealed class RoleUserResult
PropertyTypeDescription
UsernameNullable<Username>The unique name of a user.

RoleUserSearchQueryRequest​

RoleUserSearchQueryRequest

public sealed class RoleUserSearchQueryRequest
PropertyTypeDescription
SortList<RoleUserSearchQuerySortRequest>Sort field criteria.
PageSearchQueryPageRequestPagination criteria.

RoleUserSearchQuerySortRequest​

RoleUserSearchQuerySortRequest

public sealed class RoleUserSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

RoleUserSearchResult​

RoleUserSearchResult

public sealed class RoleUserSearchResult
PropertyTypeDescription
ItemsList<RoleUserResult>The matching users.
PageSearchQueryPageResponsePagination information about the search results.

ScopeKeyExactMatch​

Matches the value exactly.

public readonly record struct ScopeKeyExactMatch : ICamundaKey, IEquatable<ScopeKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

ScopeKeyFilterProperty​

ScopeKey property with full advanced search capabilities.

public sealed class ScopeKeyFilterProperty

SearchAuditLogsResponse​

Audit log search response.

public sealed class SearchAuditLogsResponse
PropertyTypeDescription
ItemsList<AuditLogResult>The matching audit logs.
PageSearchQueryPageResponsePagination information about the search results.

SearchBatchOperationItemsRequest​

Batch operation item search request.

public sealed class SearchBatchOperationItemsRequest
PropertyTypeDescription
SortList<BatchOperationItemSearchQuerySortRequest>Sort field criteria.
FilterObjectThe batch operation item search filters.
PageSearchQueryPageRequestPagination criteria.

SearchBatchOperationItemsResponse​

SearchBatchOperationItemsResponse

public sealed class SearchBatchOperationItemsResponse
PropertyTypeDescription
ItemsList<BatchOperationItemResponse>The matching batch operation items.
PageSearchQueryPageResponsePagination information about the search results.

SearchBatchOperationsRequest​

Batch operation search request.

public sealed class SearchBatchOperationsRequest
PropertyTypeDescription
SortList<BatchOperationSearchQuerySortRequest>Sort field criteria.
FilterObjectThe batch operation search filters.
PageSearchQueryPageRequestPagination criteria.

SearchClientsForGroupRequest​

SearchClientsForGroupRequest

public sealed class SearchClientsForGroupRequest
PropertyTypeDescription
SortList<TenantClientSearchQuerySortRequest>Sort field criteria.
PageSearchQueryPageRequestPagination criteria.

SearchClientsForRoleRequest​

SearchClientsForRoleRequest

public sealed class SearchClientsForRoleRequest
PropertyTypeDescription
SortList<TenantClientSearchQuerySortRequest>Sort field criteria.
PageObjectPagination criteria.

SearchClientsForTenantRequest​

SearchClientsForTenantRequest

public sealed class SearchClientsForTenantRequest
PropertyTypeDescription
SortList<TenantClientSearchQuerySortRequest>Sort field criteria.
PageObjectPagination criteria.

SearchCorrelatedMessageSubscriptionsResponse​

SearchCorrelatedMessageSubscriptionsResponse

public sealed class SearchCorrelatedMessageSubscriptionsResponse
PropertyTypeDescription
ItemsList<CorrelatedMessageSubscriptionResult>The matching correlated message subscriptions.
PageSearchQueryPageResponsePagination information about the search results.

SearchDecisionInstancesResponse​

SearchDecisionInstancesResponse

public sealed class SearchDecisionInstancesResponse
PropertyTypeDescription
ItemsList<DecisionInstanceResult>The matching decision instances.
PageSearchQueryPageResponsePagination information about the search results.

SearchElementInstanceIncidentsResponse​

SearchElementInstanceIncidentsResponse

public sealed class SearchElementInstanceIncidentsResponse
PropertyTypeDescription
ItemsList<IncidentResult>The matching incidents.
PageSearchQueryPageResponsePagination information about the search results.

SearchElementInstancesResponse​

SearchElementInstancesResponse

public sealed class SearchElementInstancesResponse
PropertyTypeDescription
ItemsList<ElementInstanceResult>The matching element instances.
PageSearchQueryPageResponsePagination information about the search results.

SearchGroupIdsForTenantRequest​

SearchGroupIdsForTenantRequest

public sealed class SearchGroupIdsForTenantRequest
PropertyTypeDescription
SortList<TenantGroupSearchQuerySortRequest>Sort field criteria.
PageObjectPagination criteria.

SearchGroupsForRoleRequest​

SearchGroupsForRoleRequest

public sealed class SearchGroupsForRoleRequest
PropertyTypeDescription
SortList<RoleGroupSearchQuerySortRequest>Sort field criteria.
PageObjectPagination criteria.

SearchIncidentsResponse​

SearchIncidentsResponse

public sealed class SearchIncidentsResponse
PropertyTypeDescription
ItemsList<IncidentResult>The matching incidents.
PageSearchQueryPageResponsePagination information about the search results.

SearchJobsResponse​

Job search response.

public sealed class SearchJobsResponse
PropertyTypeDescription
ItemsList<JobSearchResult>The matching jobs.
PageSearchQueryPageResponsePagination information about the search results.

SearchMessageSubscriptionsRequest​

SearchMessageSubscriptionsRequest

public sealed class SearchMessageSubscriptionsRequest
PropertyTypeDescription
SortList<MessageSubscriptionSearchQuerySortRequest>Sort field criteria.
FilterMessageSubscriptionFilterThe incident search filters.
PageObjectPagination criteria.

SearchMessageSubscriptionsResponse​

SearchMessageSubscriptionsResponse

public sealed class SearchMessageSubscriptionsResponse
PropertyTypeDescription
ItemsList<MessageSubscriptionResult>The matching message subscriptions.
PageSearchQueryPageResponsePagination information about the search results.

SearchProcessDefinitionsRequest​

SearchProcessDefinitionsRequest

public sealed class SearchProcessDefinitionsRequest
PropertyTypeDescription
SortList<ProcessDefinitionSearchQuerySortRequest>Sort field criteria.
FilterProcessDefinitionFilterThe process definition search filters.
PageObjectPagination criteria.

SearchProcessInstanceIncidentsResponse​

SearchProcessInstanceIncidentsResponse

public sealed class SearchProcessInstanceIncidentsResponse
PropertyTypeDescription
ItemsList<IncidentResult>The matching incidents.
PageSearchQueryPageResponsePagination information about the search results.

SearchProcessInstancesRequest​

Process instance search request.

public sealed class SearchProcessInstancesRequest
PropertyTypeDescription
SortList<ProcessInstanceSearchQuerySortRequest>Sort field criteria.
FilterProcessInstanceFilterThe process instance search filters.
PageObjectPagination criteria.

SearchProcessInstancesResponse​

Process instance search response.

public sealed class SearchProcessInstancesResponse
PropertyTypeDescription
ItemsList<ProcessInstanceResult>The matching process instances.
PageSearchQueryPageResponsePagination information about the search results.

SearchQueryPageRequest​

Pagination criteria. Can use offset-based pagination (from/limit) OR cursor-based pagination (after/before + limit), but not both.

public abstract class SearchQueryPageRequest

SearchQueryPageResponse​

Pagination information about the search results.

public sealed class SearchQueryPageResponse
PropertyTypeDescription
TotalItemsInt64Total items matching the criteria.
HasMoreTotalItemsNullable<Boolean>Indicates whether there are more items matching the criteria beyond the returned items. This is useful for determining if additional requests are needed to retrieve all results.
StartCursorNullable<StartCursor>The cursor value for getting the previous page of results. Use this in the before field of an ensuing request.
EndCursorNullable<EndCursor>The cursor value for getting the next page of results. Use this in the after field of an ensuing request.

SearchQueryRequest​

SearchQueryRequest

public sealed class SearchQueryRequest
PropertyTypeDescription
PageSearchQueryPageRequestPagination criteria.

SearchQueryResponse​

SearchQueryResponse

public sealed class SearchQueryResponse
PropertyTypeDescription
PageSearchQueryPageResponsePagination information about the search results.

SearchTenantsRequest​

Tenant search request

public sealed class SearchTenantsRequest
PropertyTypeDescription
SortList<TenantSearchQuerySortRequest>Sort field criteria.
FilterTenantFilterThe tenant search filters.
PageObjectPagination criteria.

SearchUserTaskAuditLogsRequest​

User task search query request.

public sealed class SearchUserTaskAuditLogsRequest
PropertyTypeDescription
SortList<AuditLogSearchQuerySortRequest>Sort field criteria.
FilterUserTaskAuditLogFilterThe user task audit log search filters.
PageObjectPagination criteria.

SearchUserTaskAuditLogsResponse​

Audit log search response.

public sealed class SearchUserTaskAuditLogsResponse
PropertyTypeDescription
ItemsList<AuditLogResult>The matching audit logs.
PageSearchQueryPageResponsePagination information about the search results.

SearchUserTaskVariablesRequest​

User task search query request.

public sealed class SearchUserTaskVariablesRequest
PropertyTypeDescription
SortList<VariableSearchQuerySortRequest>Sort field criteria.
FilterObjectThe user task variable search filters.
PageObjectPagination criteria.

SearchUserTaskVariablesResponse​

Variable search query response.

public sealed class SearchUserTaskVariablesResponse
PropertyTypeDescription
ItemsList<Object>The matching variables.
PageSearchQueryPageResponsePagination information about the search results.

SearchUserTasksRequest​

User task search query request.

public sealed class SearchUserTasksRequest
PropertyTypeDescription
SortList<UserTaskSearchQuerySortRequest>Sort field criteria.
FilterObjectThe user task search filters.
PageObjectPagination criteria.

SearchUserTasksResponse​

User task search query response.

public sealed class SearchUserTasksResponse
PropertyTypeDescription
ItemsList<UserTaskResult>The matching user tasks.
PageSearchQueryPageResponsePagination information about the search results.

SearchUsersForGroupRequest​

SearchUsersForGroupRequest

public sealed class SearchUsersForGroupRequest
PropertyTypeDescription
SortList<TenantUserSearchQuerySortRequest>Sort field criteria.
PageSearchQueryPageRequestPagination criteria.

SearchUsersForRoleRequest​

SearchUsersForRoleRequest

public sealed class SearchUsersForRoleRequest
PropertyTypeDescription
SortList<TenantUserSearchQuerySortRequest>Sort field criteria.
PageObjectPagination criteria.

SearchUsersForTenantRequest​

SearchUsersForTenantRequest

public sealed class SearchUsersForTenantRequest
PropertyTypeDescription
SortList<TenantUserSearchQuerySortRequest>Sort field criteria.
PageObjectPagination criteria.

SearchUsersRequest​

SearchUsersRequest

public sealed class SearchUsersRequest
PropertyTypeDescription
SortList<UserSearchQuerySortRequest>Sort field criteria.
FilterUserFilterThe user search filters.
PageObjectPagination criteria.

SearchVariablesRequest​

Variable search query request.

public sealed class SearchVariablesRequest
PropertyTypeDescription
SortList<VariableSearchQuerySortRequest>Sort field criteria.
FilterObjectThe variable search filters.
PageObjectPagination criteria.

SearchVariablesResponse​

Variable search query response.

public sealed class SearchVariablesResponse
PropertyTypeDescription
ItemsList<Object>The matching variables.
PageSearchQueryPageResponsePagination information about the search results.

SetVariableRequest​

SetVariableRequest

public sealed class SetVariableRequest
PropertyTypeDescription
VariablesObjectJSON object representing the variables to set in the element’s scope.
LocalNullable<Boolean>If set to true, the variables are merged strictly into the local scope (as specified by the elementInstanceKey). Otherwise, the variables are propagated to upper scopes and set at the outermost one. Let’s consider the following example: There are two scopes '1' and '2'. Scope '1' is the parent scope of '2'. The effective variables of the scopes are: 1 => { "foo" : 2 } 2 => { "bar" : 1 } An update request with elementInstanceKey as '2', variables { "foo" : 5 }, and local set to true leaves scope '1' unchanged and adjusts scope '2' to { "bar" : 1, "foo" 5 }. By default, with local set to false, scope '1' will be { "foo": 5 } and scope '2' will be { "bar" : 1 }.
OperationReferenceNullable<OperationReference>A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

SignalBroadcastRequest​

SignalBroadcastRequest

public sealed class SignalBroadcastRequest : ITenantIdSettable
PropertyTypeDescription
SignalNameStringThe name of the signal to broadcast.
VariablesObjectThe signal variables as a JSON object.
TenantIdNullable<TenantId>The ID of the tenant that owns the signal.

SignalBroadcastResult​

SignalBroadcastResult

public sealed class SignalBroadcastResult
PropertyTypeDescription
TenantIdTenantIdThe tenant ID of the signal that was broadcast.
SignalKeySignalKeyThe key of the broadcasted signal.

SourceElementIdInstruction​

Defines an instruction with a sourceElementId. The move instruction with this sourceType will terminate all active element instances with the sourceElementId and activate a new element instance for each terminated one at targetElementId.

public sealed class SourceElementIdInstruction : SourceElementInstruction
PropertyTypeDescription
SourceTypeStringThe type of source element instruction.
SourceElementIdElementIdThe id of the source element for the move instruction.

SourceElementInstanceKeyInstruction​

Defines an instruction with a sourceElementInstanceKey. The move instruction with this sourceType will terminate one active element instance with the sourceElementInstanceKey and activate a new element instance at targetElementId.

public sealed class SourceElementInstanceKeyInstruction : SourceElementInstruction
PropertyTypeDescription
SourceTypeStringThe type of source element instruction.
SourceElementInstanceKeyElementInstanceKeyThe source element instance key for the move instruction.

SourceElementInstruction​

Defines the source element identifier for the move instruction. It can either be a sourceElementId, or sourceElementInstanceKey.

public abstract class SourceElementInstruction

StartCursor​

The start cursor in a search query result set.

public readonly record struct StartCursor : ICamundaKey, IEquatable<StartCursor>
PropertyTypeDescription
ValueStringThe underlying string value.

StatusMetric​

Metric for a single job status.

public sealed class StatusMetric
PropertyTypeDescription
CountInt64Number of jobs in this status.
LastUpdatedAtDateTimeOffsetISO 8601 timestamp of the last update for this status.

StringFilterProperty​

String property with full advanced search capabilities.

public sealed class StringFilterProperty

Tag​

A tag. Needs to start with a letter; then alphanumerics, _, -, :, or .; length ≤ 100.

public readonly record struct Tag : ICamundaKey, IEquatable<Tag>
PropertyTypeDescription
ValueStringThe underlying string value.

TenantClientResult​

TenantClientResult

public sealed class TenantClientResult
PropertyTypeDescription
ClientIdStringThe ID of the client.

TenantClientSearchQueryRequest​

TenantClientSearchQueryRequest

public sealed class TenantClientSearchQueryRequest
PropertyTypeDescription
SortList<TenantClientSearchQuerySortRequest>Sort field criteria.
PageSearchQueryPageRequestPagination criteria.

TenantClientSearchQuerySortRequest​

TenantClientSearchQuerySortRequest

public sealed class TenantClientSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

TenantClientSearchResult​

TenantClientSearchResult

public sealed class TenantClientSearchResult
PropertyTypeDescription
ItemsList<TenantClientResult>The matching clients.
PageSearchQueryPageResponsePagination information about the search results.

TenantCreateRequest​

TenantCreateRequest

public sealed class TenantCreateRequest
PropertyTypeDescription
TenantIdStringThe unique ID for the tenant. Must be 255 characters or less. Can contain letters, numbers, [_, -, +, ., @].
NameStringThe name of the tenant.
DescriptionStringThe description of the tenant.

TenantCreateResult​

TenantCreateResult

public sealed class TenantCreateResult
PropertyTypeDescription
TenantIdNullable<TenantId>The unique identifier of the tenant.
NameStringThe name of the tenant.
DescriptionStringThe description of the tenant.

TenantFilter​

Tenant filter request

public sealed class TenantFilter
PropertyTypeDescription
TenantIdNullable<TenantId>The unique identifier of the tenant.
NameStringThe name of the tenant.

TenantGroupResult​

TenantGroupResult

public sealed class TenantGroupResult
PropertyTypeDescription
GroupIdStringThe groupId of the group.

TenantGroupSearchQueryRequest​

TenantGroupSearchQueryRequest

public sealed class TenantGroupSearchQueryRequest
PropertyTypeDescription
SortList<TenantGroupSearchQuerySortRequest>Sort field criteria.
PageSearchQueryPageRequestPagination criteria.

TenantGroupSearchQuerySortRequest​

TenantGroupSearchQuerySortRequest

public sealed class TenantGroupSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

TenantGroupSearchResult​

TenantGroupSearchResult

public sealed class TenantGroupSearchResult
PropertyTypeDescription
ItemsList<TenantGroupResult>The matching groups.
PageSearchQueryPageResponsePagination information about the search results.

TenantId​

The unique identifier of the tenant.

public readonly record struct TenantId : ICamundaKey, IEquatable<TenantId>
PropertyTypeDescription
ValueStringThe underlying string value.

TenantResult​

Tenant search response item.

public sealed class TenantResult
PropertyTypeDescription
NameStringThe tenant name.
TenantIdNullable<TenantId>The unique identifier of the tenant.
DescriptionStringThe tenant description.

TenantSearchQueryRequest​

Tenant search request

public sealed class TenantSearchQueryRequest
PropertyTypeDescription
SortList<TenantSearchQuerySortRequest>Sort field criteria.
FilterTenantFilterThe tenant search filters.
PageSearchQueryPageRequestPagination criteria.

TenantSearchQueryResult​

Tenant search response.

public sealed class TenantSearchQueryResult
PropertyTypeDescription
ItemsList<TenantResult>The matching tenants.
PageSearchQueryPageResponsePagination information about the search results.

TenantSearchQuerySortRequest​

TenantSearchQuerySortRequest

public sealed class TenantSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

TenantUpdateRequest​

TenantUpdateRequest

public sealed class TenantUpdateRequest
PropertyTypeDescription
NameStringThe new name of the tenant.
DescriptionStringThe new description of the tenant.

TenantUpdateResult​

TenantUpdateResult

public sealed class TenantUpdateResult
PropertyTypeDescription
TenantIdNullable<TenantId>The unique identifier of the tenant.
NameStringThe name of the tenant.
DescriptionStringThe description of the tenant.

TenantUserResult​

TenantUserResult

public sealed class TenantUserResult
PropertyTypeDescription
UsernameNullable<Username>The unique name of a user.

TenantUserSearchQueryRequest​

TenantUserSearchQueryRequest

public sealed class TenantUserSearchQueryRequest
PropertyTypeDescription
SortList<TenantUserSearchQuerySortRequest>Sort field criteria.
PageSearchQueryPageRequestPagination criteria.

TenantUserSearchQuerySortRequest​

TenantUserSearchQuerySortRequest

public sealed class TenantUserSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

TenantUserSearchResult​

TenantUserSearchResult

public sealed class TenantUserSearchResult
PropertyTypeDescription
ItemsList<TenantUserResult>The matching users.
PageSearchQueryPageResponsePagination information about the search results.

TopologyResponse​

The response of a topology request.

public sealed class TopologyResponse
PropertyTypeDescription
BrokersList<BrokerInfo>A list of brokers that are part of this cluster.
ClusterIdStringThe cluster Id.
ClusterSizeInt32The number of brokers in the cluster.
PartitionsCountInt32The number of partitions are spread across the cluster.
ReplicationFactorInt32The configured replication factor for this cluster.
GatewayVersionStringThe version of the Zeebe Gateway.
LastCompletedChangeIdStringID of the last completed change

UpdateClusterVariableRequest​

UpdateClusterVariableRequest

public sealed class UpdateClusterVariableRequest
PropertyTypeDescription
ValueObjectThe new value of the cluster variable. Can be any JSON object or primitive value. Will be serialized as a JSON string in responses.

UsageMetricsResponse​

UsageMetricsResponse

public sealed class UsageMetricsResponse
PropertyTypeDescription
ActiveTenantsNullable<Int64>The amount of active tenants.
TenantsDictionary<Object>The usage metrics by tenants. Only available if request withTenants query parameter was true.
ProcessInstancesNullable<Int64>The amount of created root process instances.
DecisionInstancesNullable<Int64>The amount of executed decision instances.
AssigneesNullable<Int64>The amount of unique active task users.

UsageMetricsResponseItem​

UsageMetricsResponseItem

public sealed class UsageMetricsResponseItem
PropertyTypeDescription
ProcessInstancesNullable<Int64>The amount of created root process instances.
DecisionInstancesNullable<Int64>The amount of executed decision instances.
AssigneesNullable<Int64>The amount of unique active task users.

UseSourceParentKeyInstruction​

Instructs the engine to use the source's direct parent key as the ancestor scope key for the target element. This is a simpler alternative to inferred that skips hierarchy traversal and directly uses the source's parent key. This is useful when the source and target elements are siblings within the same flow scope.

public sealed class UseSourceParentKeyInstruction : AncestorScopeInstruction
PropertyTypeDescription
AncestorScopeTypeStringThe type of ancestor scope instruction.

UserCreateResult​

UserCreateResult

public sealed class UserCreateResult
PropertyTypeDescription
UsernameNullable<Username>The unique name of a user.
NameStringThe name of the user.
EmailStringThe email of the user.

UserFilter​

User search filter.

public sealed class UserFilter
PropertyTypeDescription
UsernameStringFilterPropertyThe username of the user.
NameStringFilterPropertyThe name of the user.
EmailStringFilterPropertyThe email of the user.

UserRequest​

UserRequest

public sealed class UserRequest
PropertyTypeDescription
PasswordStringThe password of the user.
UsernameStringThe username of the user.
NameStringThe name of the user.
EmailStringThe email of the user.

UserResult​

UserResult

public sealed class UserResult
PropertyTypeDescription
UsernameNullable<Username>The unique name of a user.
NameStringThe name of the user.
EmailStringThe email of the user.

UserSearchQueryRequest​

UserSearchQueryRequest

public sealed class UserSearchQueryRequest
PropertyTypeDescription
SortList<UserSearchQuerySortRequest>Sort field criteria.
FilterUserFilterThe user search filters.
PageSearchQueryPageRequestPagination criteria.

UserSearchQuerySortRequest​

UserSearchQuerySortRequest

public sealed class UserSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

UserSearchResult​

UserSearchResult

public sealed class UserSearchResult
PropertyTypeDescription
ItemsList<UserResult>The matching users.
PageSearchQueryPageResponsePagination information about the search results.

UserTaskAssignmentRequest​

UserTaskAssignmentRequest

public sealed class UserTaskAssignmentRequest
PropertyTypeDescription
AssigneeStringThe assignee for the user task. The assignee must not be empty or null.
AllowOverrideNullable<Boolean>By default, the task is reassigned if it was already assigned. Set this to false to return an error in such cases. The task must then first be unassigned to be assigned again. Use this when you have users picking from group task queues to prevent race conditions.
ActionStringA custom action value that will be accessible from user task events resulting from this endpoint invocation. If not provided, it will default to "assign".

UserTaskAuditLogFilter​

The user task audit log search filters.

public sealed class UserTaskAuditLogFilter
PropertyTypeDescription
OperationTypeOperationTypeFilterPropertyThe audit log operation type search filter.
ResultAuditLogResultFilterPropertyThe audit log result search filter.
TimestampDateTimeFilterPropertyThe audit log timestamp filter.
ActorTypeAuditLogActorTypeFilterPropertyThe actor type search filter.
ActorIdStringFilterPropertyThe actor ID search filter.

UserTaskAuditLogSearchQueryRequest​

User task search query request.

public sealed class UserTaskAuditLogSearchQueryRequest
PropertyTypeDescription
SortList<AuditLogSearchQuerySortRequest>Sort field criteria.
FilterUserTaskAuditLogFilterThe user task audit log search filters.
PageSearchQueryPageRequestPagination criteria.

UserTaskCompletionRequest​

UserTaskCompletionRequest

public sealed class UserTaskCompletionRequest
PropertyTypeDescription
VariablesObjectThe variables to complete the user task with.
ActionStringA custom action value that will be accessible from user task events resulting from this endpoint invocation. If not provided, it will default to "complete".

UserTaskFilter​

User task filter request.

public sealed class UserTaskFilter
PropertyTypeDescription
StateUserTaskStateFilterPropertyThe user task state.
AssigneeStringFilterPropertyThe assignee of the user task.
PriorityIntegerFilterPropertyThe priority of the user task.
ElementIdNullable<ElementId>The element ID of the user task.
NameStringFilterPropertyThe task name. This only works for data created with 8.8 and onwards. Instances from prior versions don't contain this data and cannot be found.
CandidateGroupStringFilterPropertyThe candidate group for this user task.
CandidateUserStringFilterPropertyThe candidate user for this user task.
TenantIdStringFilterPropertyTenant ID of this user task.
ProcessDefinitionIdNullable<ProcessDefinitionId>The ID of the process definition.
CreationDateDateTimeFilterPropertyThe user task creation date.
CompletionDateDateTimeFilterPropertyThe user task completion date.
FollowUpDateDateTimeFilterPropertyThe user task follow-up date.
DueDateDateTimeFilterPropertyThe user task due date.
ProcessInstanceVariablesList<VariableValueFilterProperty>
LocalVariablesList<VariableValueFilterProperty>
UserTaskKeyNullable<UserTaskKey>The key for this user task.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The key of the process definition.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of the process instance.
ElementInstanceKeyNullable<ElementInstanceKey>The key of the element instance.
TagsList<Tag>List of tags. Tags need to start with a letter; then alphanumerics, _, -, :, or .; length ≤ 100.

UserTaskProperties​

Contains properties of a user task.

public sealed class UserTaskProperties
PropertyTypeDescription
ActionStringThe action performed on the user task.
AssigneeStringThe user assigned to the task.
CandidateGroupsList<String>The groups eligible to claim the task.
CandidateUsersList<String>The users eligible to claim the task.
ChangedAttributesList<String>The attributes that were changed in the task.
DueDateStringThe due date of the user task in ISO 8601 format.
FollowUpDateStringThe follow-up date of the user task in ISO 8601 format.
FormKeyNullable<FormKey>The key of the form associated with the user task.
PriorityNullable<Int32>The priority of the user task.
UserTaskKeyNullable<UserTaskKey>The unique key identifying the user task.

UserTaskResult​

UserTaskResult

public sealed class UserTaskResult
PropertyTypeDescription
NameStringThe name for this user task.
StateNullable<UserTaskStateEnum>The state of the user task.
AssigneeStringThe assignee of the user task.
ElementIdNullable<ElementId>The element ID of the user task.
CandidateGroupsList<String>The candidate groups for this user task.
CandidateUsersList<String>The candidate users for this user task.
ProcessDefinitionIdNullable<ProcessDefinitionId>The ID of the process definition.
CreationDateNullable<DateTimeOffset>The creation date of a user task.
CompletionDateNullable<DateTimeOffset>The completion date of a user task.
FollowUpDateNullable<DateTimeOffset>The follow date of a user task.
DueDateNullable<DateTimeOffset>The due date of a user task.
TenantIdNullable<TenantId>The unique identifier of the tenant.
ExternalFormReferenceStringThe external form reference.
ProcessDefinitionVersionNullable<Int32>The version of the process definition.
CustomHeadersDictionary<String>Custom headers for the user task.
PriorityNullable<Int32>The priority of a user task. The higher the value the higher the priority.
UserTaskKeyNullable<UserTaskKey>The key of the user task.
ElementInstanceKeyNullable<ElementInstanceKey>The key of the element instance.
ProcessNameStringThe name of the process definition.
ProcessDefinitionKeyNullable<ProcessDefinitionKey>The key of the process definition.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of the process instance.
RootProcessInstanceKeyNullable<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.
FormKeyNullable<FormKey>The key of the form.
TagsList<Tag>List of tags. Tags need to start with a letter; then alphanumerics, _, -, :, or .; length ≤ 100.

UserTaskSearchQuery​

User task search query request.

public sealed class UserTaskSearchQuery
PropertyTypeDescription
SortList<UserTaskSearchQuerySortRequest>Sort field criteria.
FilterUserTaskFilterThe user task search filters.
PageSearchQueryPageRequestPagination criteria.

UserTaskSearchQueryResult​

User task search query response.

public sealed class UserTaskSearchQueryResult
PropertyTypeDescription
ItemsList<UserTaskResult>The matching user tasks.
PageSearchQueryPageResponsePagination information about the search results.

UserTaskSearchQuerySortRequest​

UserTaskSearchQuerySortRequest

public sealed class UserTaskSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

UserTaskStateExactMatch​

Matches the value exactly.

public readonly record struct UserTaskStateExactMatch : ICamundaKey, IEquatable<UserTaskStateExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

UserTaskStateFilterProperty​

UserTaskStateEnum property with full advanced search capabilities.

public sealed class UserTaskStateFilterProperty

UserTaskUpdateRequest​

UserTaskUpdateRequest

public sealed class UserTaskUpdateRequest
PropertyTypeDescription
ChangesetChangesetJSON object with changed task attribute values. The following attributes can be adjusted with this endpoint, additional attributes will be ignored: _ candidateGroups - reset by providing an empty list _ candidateUsers - reset by providing an empty list _ dueDate - reset by providing an empty String _ followUpDate - reset by providing an empty String * priority - minimum 0, maximum 100, default 50 Providing any of those attributes with a null value or omitting it preserves the persisted attribute's value. The assignee cannot be adjusted with this endpoint, use the Assign task endpoint. This ensures correct event emission for assignee changes.
ActionStringA custom action value that will be accessible from user task events resulting from this endpoint invocation. If not provided, it will default to "update".

UserTaskVariableFilter​

The user task variable search filters.

public sealed class UserTaskVariableFilter
PropertyTypeDescription
NameStringFilterPropertyName of the variable.

UserTaskVariableSearchQueryRequest​

User task search query request.

public sealed class UserTaskVariableSearchQueryRequest
PropertyTypeDescription
SortList<UserTaskVariableSearchQuerySortRequest>Sort field criteria.
FilterUserTaskVariableFilterThe user task variable search filters.
PageSearchQueryPageRequestPagination criteria.

UserTaskVariableSearchQuerySortRequest​

UserTaskVariableSearchQuerySortRequest

public sealed class UserTaskVariableSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

UserUpdateRequest​

UserUpdateRequest

public sealed class UserUpdateRequest
PropertyTypeDescription
PasswordStringThe password of the user. If blank, the password is unchanged.
NameStringThe name of the user.
EmailStringThe email of the user.

UserUpdateResult​

UserUpdateResult

public sealed class UserUpdateResult
PropertyTypeDescription
UsernameNullable<Username>The unique name of a user.
NameStringThe name of the user.
EmailStringThe email of the user.

Username​

The unique name of a user.

public readonly record struct Username : ICamundaKey, IEquatable<Username>
PropertyTypeDescription
ValueStringThe underlying string value.

VariableFilter​

Variable filter request.

public sealed class VariableFilter
PropertyTypeDescription
NameStringFilterPropertyName of the variable.
ValueStringFilterPropertyThe value of the variable.
TenantIdNullable<TenantId>Tenant ID of this variable.
IsTruncatedNullable<Boolean>Whether the value is truncated or not.
VariableKeyVariableKeyFilterPropertyThe key for this variable.
ScopeKeyScopeKeyFilterPropertyThe key of the scope of this variable.
ProcessInstanceKeyProcessInstanceKeyFilterPropertyThe key of the process instance of this variable.

VariableKeyExactMatch​

Matches the value exactly.

public readonly record struct VariableKeyExactMatch : ICamundaKey, IEquatable<VariableKeyExactMatch>
PropertyTypeDescription
ValueStringThe underlying string value.

VariableKeyFilterProperty​

VariableKey property with full advanced search capabilities.

public sealed class VariableKeyFilterProperty

VariableResult​

Variable search response item.

public sealed class VariableResult
PropertyTypeDescription
ValueStringFull value of this variable.
NameStringName of this variable.
TenantIdNullable<TenantId>Tenant ID of this variable.
VariableKeyNullable<VariableKey>The key for this variable.
ScopeKeyNullable<ScopeKey>The key of the scope of this variable.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of the process instance of this variable.
RootProcessInstanceKeyNullable<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.

VariableResultBase​

Variable response item.

public sealed class VariableResultBase
PropertyTypeDescription
NameStringName of this variable.
TenantIdNullable<TenantId>Tenant ID of this variable.
VariableKeyNullable<VariableKey>The key for this variable.
ScopeKeyNullable<ScopeKey>The key of the scope of this variable.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of the process instance of this variable.
RootProcessInstanceKeyNullable<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.

VariableSearchQuery​

Variable search query request.

public sealed class VariableSearchQuery
PropertyTypeDescription
SortList<VariableSearchQuerySortRequest>Sort field criteria.
FilterVariableFilterThe variable search filters.
PageSearchQueryPageRequestPagination criteria.

VariableSearchQueryResult​

Variable search query response.

public sealed class VariableSearchQueryResult
PropertyTypeDescription
ItemsList<VariableSearchResult>The matching variables.
PageSearchQueryPageResponsePagination information about the search results.

VariableSearchQuerySortRequest​

VariableSearchQuerySortRequest

public sealed class VariableSearchQuerySortRequest
PropertyTypeDescription
FieldStringThe field to sort by.
OrderNullable<SortOrderEnum>The order in which to sort the related field.

VariableSearchResult​

Variable search response item.

public sealed class VariableSearchResult
PropertyTypeDescription
ValueStringValue of this variable. Can be truncated.
IsTruncatedNullable<Boolean>Whether the value is truncated or not.
NameStringName of this variable.
TenantIdNullable<TenantId>Tenant ID of this variable.
VariableKeyNullable<VariableKey>The key for this variable.
ScopeKeyNullable<ScopeKey>The key of the scope of this variable.
ProcessInstanceKeyNullable<ProcessInstanceKey>The key of the process instance of this variable.
RootProcessInstanceKeyNullable<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.

VariableValueFilterProperty​

VariableValueFilterProperty

public sealed class VariableValueFilterProperty
PropertyTypeDescription
NameStringName of the variable.
ValueStringFilterPropertyThe value of the variable.