API behavior for versioned use case types
Use the available APIs to create, manage, retrieve, and process versioned use case types while maintaining support for existing integrations.
Backward compatibility
The versioning framework is designed to preserve existing API behavior, allowing current integrations and workflows to continue without modification.
Existing APIs continue to work without changes.
API Operation Behavior
This table describes how each API operation behaves when versioning is enabled for use case types:
| API Operation | Behavior |
|---|---|
| Create UsecaseType | Automatically creates version 1.0.0 with the provided configuration |
| Update UsecaseType | Updates the Active version's configuration (returns error if Active version is read-only/imported) |
| Get UsecaseType by ID | Returns the Active version's configuration by default |
| Submit Document (using parent GUID) | Routes to the Active version's configuration for processing |
| List UsecaseTypes | Includes currentVersion and total version count in the response |
Version-aware enhancements
Additional API capabilities enable retrieval and management of specific use case type versions to support version tracking and administration.
- Use the optional version query parameter to retrieve the configuration for a specific version.
- Use the list versions endpoint to retrieve all versions of a use case type, including status, version number, and metadata.