Skip to main contentA TWU Model defines the structure for Trusted Work Units. Models specify entities, actions, events, and outcomes that describe work operations.
Fields
id / modelId (string) - Model identifier
name (string) - Model name
description (string) - Model description
status (string) - Model status: DRAFT, PUBLISHED, ARCHIVED
entities (array) - List of entity definitions
actions (array) - List of action definitions
events (array) - List of event definitions
outcomes (array) - List of outcome definitions with expressions
version (number) - Version number
createdAt (timestamp) - Creation timestamp
updatedAt (timestamp) - Last update timestamp
Source: Feature Inventory - Core Objects (TWU Model)
Versions
TWU models support versioning:
- DRAFT - Work in progress, not yet published
- PUBLISHED - Active version available for use
- ARCHIVED - Deprecated version
Source: Feature Inventory - API Surface (TWU Models API)
Components
Entities
Objects that work operates on. Define the data structure for entities in your model.
Actions
Operations performed on entities. Actions define what work can be done.
Events
State changes or occurrences. Events track what happens during work execution.
Outcomes
Results with expressions. Outcomes define how to compute results from work operations.
Lifecycle
- Create model with draft version
- Edit draft version (entities, actions, events, outcomes)
- Publish draft to make it available
- Create new version for changes (maintains history)
- Archive old versions when deprecated
Source: Feature Inventory - API Surface (TWU Models API)