Skip to main content
This page provides a complete reference for all data models in Clearline. These models are structured for automatic generation from backend schemas. Related: Source: Feature Inventory

​
Instance

Multi-tenant configuration container. Fields:
  • id (string) - Instance identifier
  • userPoolId (string) - AWS Cognito User Pool ID (format: region_xxxxxxxx)
  • clientId (string) - Cognito OIDC client ID
  • region (string) - AWS region (extracted from userPoolId)
Source: Source: Feature Inventory

​
TWU Model

Structure definition for Trusted Work Units. 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: Source: Feature Inventory

​
Agent

AI or human agent that performs work operations. Fields:
  • id (string) - Agent identifier
  • name (string) - Agent name
  • type (string) - Agent type: “AI” or “HUMAN”
  • active (boolean) - Whether agent is active
  • capabilities (array) - Agent capabilities (varies by type)
  • model (string, AI only) - AI model identifier
  • priority (string) - Priority level: “high”, “medium”, “low”
  • metadata (object) - Additional agent metadata
Source: Source: Feature Inventory

​
Integration

Connection to external systems. Fields:
  • id (string) - Integration identifier
  • name (string) - Integration name
  • type (string) - Integration type (40+ types supported)
  • status (string) - Status: “active”, “inactive”, “connecting”, “error”
  • metadata (object) - Integration-specific configuration
  • health (object) - Health check information
    • isHealthy (boolean)
    • lastHealthCheck (timestamp)
    • metrics (object)
Source: Source: Feature Inventory

​
User

User account within an instance. Fields:
  • id (string) - User identifier
  • username (string) - Username
  • email (string) - Email address
  • name (string) - First name
  • middleName (string, optional) - Middle name
  • familyName (string, optional) - Family name
  • enabled (boolean) - Whether user is enabled
  • temporaryPassword (string, optional) - Temporary password for new users
  • roles (array, inferred) - User roles (structure not found in code)
Source: Source: Feature Inventory

​
Work Ledger Entry

Record of a TWU execution/work operation. Fields:
  • id (string) - Entry identifier
  • title (string) - Entry title
  • description (string) - Entry description
  • type (string) - Entry type (e.g., “TWU”)
  • status (string) - Execution status (e.g., “completed”, “in_progress”)
  • createdAt (timestamp) - Creation timestamp
  • updatedAt (timestamp) - Last update timestamp
  • entityId (string) - Related entity identifier
  • relatedEntity (string) - Related entity display name
  • actors (array) - Actor types: [“AI”], [“HUMAN”], or [“AI”, “HUMAN”]
  • activeTime (number) - Active time in seconds
  • cost (number) - Cost in dollars
  • policyStatus (string) - Policy compliance status: “compliant”, “non_compliant”, “review_required”
  • modelName (string) - TWU model name used
Source: Source: Feature Inventory

​
Database Schema

Source: Source: Feature Inventory

​
Type Definitions

Frontend type definitions are available in:
  • /Users/vincentgraham/clearline-ui/src/features/agents/types/agent.js
  • /Users/vincentgraham/clearline-ui/src/features/twuModel/types/twuModel.js
  • /Users/vincentgraham/clearline-ui/src/features/integrations/types/integration.js
Source: Source: Feature Inventory