For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

The Camunda Domain Type System

Technical Preview

The Rust SDK is a technical preview. Its API surface may still evolve and changes may not follow semantic versioning. Pin an exact version if you need stability.

Camunda's spec marks identifier schemas with x-semantic-type (e.g. JobKey, ProcessInstanceKey, and *ExactMatch filter variants). The SDK models each as a nominal newtype over its string value, serialized transparently:

use camunda_orchestration_sdk::models::{CamundaKey, JobKey};

let key = JobKey::try_new("2251799813653498")?; // validates pattern & length
assert_eq!(key.value(), "2251799813653498");
// Side-load without validation:
let loose = JobKey::assume_exists("123");

These types are generated by post-processing, because openapi-generator does not handle the semantic-key schemas correctly (it emits broken empty structs or drops them).