Module models 

Models module for the SDK

Defines core data structures used by the SDK for import/export operations. These models are simplified versions focused on the SDK’s needs.

Modules

cads

CADS (Compute Asset Description Specification) models

column

Column model for the SDK

cross_domain

Cross-domain reference models

data_model

DataModel for the SDK

decision

Decision model for MADR-compliant decision records

domain

Business Domain schema models

domain_config

Domain configuration model

enums

Enums for data modeling

knowledge

Knowledge Base model for domain-partitioned knowledge articles

odcs

ODCS Native Data Structures

odps

ODPS (Open Data Product Standard) models

relationship

Relationship model for the SDK

table

Table model for the SDK

tag

Enhanced tag support with Simple, Pair, and List formats

workspace

Workspace model

Structs

AssetLink

Link to an asset (table, relationship, product, etc.)

AuthoritativeDefinition

Authoritative definition reference (ODCS v3.1.0)

CADSAsset

CADS Asset - main structure

CADSBPMNModel

BPMN model reference

CADSCompliance

CADS compliance

CADSComplianceControl

Compliance control

CADSComplianceFramework

Compliance framework

CADSDMNModel

DMN model reference

CADSDescription

CADS description object

CADSExternalLink

External link in CADS description

CADSNode

CADSNode - Reference to a CADS asset

CADSOpenAPISpec

OpenAPI spec reference

CADSPricing

CADS pricing model

CADSRisk

CADS risk management

CADSRiskAssessment

Risk assessment

CADSRiskMitigation

Risk mitigation

CADSRuntime

CADS runtime configuration

CADSRuntimeContainer

Container configuration

CADSRuntimeResources

Resource requirements

CADSSLA

CADS SLA properties

CADSSLAProperty

SLA property

CADSTeamMember

Team member

CADSValidationProfile

Validation profile

CADSValidationProfileAppliesTo

Validation profile applies to

Column

Column model representing a field in a table

ComplianceAssessment

Compliance assessment for the decision

ConnectionPoint

Connection point coordinates for relationship visualization

ContactDetails

Contact details for Data Flow node/relationship owners/responsible parties

CrossDomainConfig

The cross-domain configuration for a domain

CrossDomainRelationshipRef

A reference to a relationship from another domain

CrossDomainTableRef

A reference to a table from another domain

DataModel

Data model representing a complete data model with tables and relationships

Decision

MADR-compliant Decision Record

DecisionDriver

Driver/reason for the decision

DecisionIndex

Decision log index (decisions.yaml)

DecisionIndexEntry

Decision index entry for the decisions.yaml file

DecisionOption

Option considered during decision making

Domain

Domain - Top-level container for a business domain

DomainConfig

DomainConfig - Configuration file for a domain (domain.yaml)

DomainOwner

Owner information for a domain

DomainReference

Domain reference within a workspace

ETLJobMetadata

ETL job metadata for data flow relationships

ForeignKey

Foreign key reference to another table’s column

ForeignKeyDetails

Foreign key column mapping details

KnowledgeArticle

Knowledge Base Article

KnowledgeIndex

Knowledge base index (knowledge.yaml)

KnowledgeIndexEntry

Knowledge article index entry for the knowledge.yaml file

LogicalTypeOptions

ODCS v3.1.0 logicalTypeOptions for additional type metadata

ModelReference

Model reference for CADS assets

NodeConnection

NodeConnection - Crowsfeet notation relationship between ODCS nodes

ODCSNode

ODCSNode - Reference to an ODCS Table

ODPSAuthoritativeDefinition

Authoritative definition

ODPSCustomProperty

Custom property

ODPSDataProduct

Data Product - main structure

ODPSDescription

ODPS description

ODPSInputContract

Input contract dependency

ODPSInputPort

Input port

ODPSManagementPort

Management port

ODPSOutputPort

Output port

ODPSSBOM

SBOM (Software Bill of Materials)

ODPSSupport

Support channel

ODPSTeam

Team

ODPSTeamMember

Team member

Position

Position coordinates for table placement on canvas

PropertyRelationship

ODCS v3.1.0 Relationship at property level

RelatedArticle

Reference to a related article

Relationship

Relationship model representing a connection between two tables

SharedNodeReference

Shared node reference

SlaProperty

SLA (Service Level Agreement) property following ODCS-inspired structure

System

System - Physical infrastructure entity

SystemConnection

SystemConnection - ERD-style connection between systems

Table

Table model representing a database table or data contract

ViewPosition

Position on canvas for view rendering

VisualMetadata

Visual metadata for relationship rendering on canvas

Workspace

Workspace - Top-level container for domains, assets, and relationships

Enums

ArticleRelationship

Relationship type between articles

AssetRelationship

Relationship type between a decision and an asset

CADSBPMNFormat

BPMN model format

CADSComplianceStatus

Compliance status

CADSDMNFormat

DMN model format

CADSImpactArea

Impact area

CADSKind

CADS asset kinds

CADSMitigationStatus

Mitigation status

CADSOpenAPIFormat

OpenAPI spec format

CADSPricingModel

Pricing model enum

CADSRiskClassification

Risk classification

CADSStatus

CADS asset status

Cardinality

Legacy cardinality enum (for backward compatibility) Consider using EndpointCardinality for more precise crow’s feet notation

ConnectionHandle

Edge attachment point positions on a node

CrowsfeetCardinality

Cardinality for Crowsfeet notation relationships between ODCS nodes

DataVaultClassification

DatabaseType

DecisionCategory

Decision category

DecisionStatus

Decision status in lifecycle

DriverPriority

Priority level for decision drivers

EndpointCardinality

Crow’s feet notation endpoint cardinality

FlowDirection

Flow direction for data flow relationships

InfrastructureType

Infrastructure type for Data Flow nodes and relationships

KnowledgeStatus

Knowledge article status

KnowledgeType

Knowledge article type

MedallionLayer

ModelType

Model type for references

ModelingLevel

ODPSApiVersion

ODPS API version

ODPSStatus

ODPS status

RelationshipType

ReviewFrequency

Review frequency for knowledge articles

SCDPattern

SkillLevel

Skill level required for the article

Tag

Tag enum supporting Simple, Pair, and List formats