Skip to main content

@ODM

STABLE This annotation can be used productively.

Introduction

Annotations of the one domain model allow specifying entities and their elements to make them ODM compliant accordingly to ODM Compliance rules.

🔗 For more background, see blog post: Harnessing Half a Century of Knowledge: SAP's Journey of Enriching APIs with Business Metadata

Schema Definitions

Annotations Overview

AnnotationScopeDescription
@ODM.entityNameEntityThe entity represents an ODM Entity with this official name.
@ODM.oidEntityThe annotation references the element which contains the oid.
@ODM.oidReference.entityNameTypeThe property contains an OID for the ODM Entity with this official name

@ODM.entityName

The entity represents an ODM Entity with this official name.

Scope: Entity
Extending: EntityDefinition
Type: string
Regex Pattern: ^[a-zA-Z0-9._\-]+$

@ODM.oid

The annotation references the element which contains the oid.

Scope: Entity
Extending: EntityDefinition
External Type: Element Reference

@ODM.oidReference.entityName

The property contains an OID for the ODM Entity with this official name

Scope: Type
Extending: BooleanType, StringType, LargeStringType, IntegerType, Integer64Type, DecimalType, DoubleType, DateType, TimeType, DateTimeType, TimestampType, UUIDType, AssociationType, CompositionType, CustomType, TypeDefinition, BooleanTypeDefinition, StringTypeDefinition, LargeStringTypeDefinition, IntegerTypeDefinition, Integer64TypeDefinition, DecimalTypeDefinition, DoubleTypeDefinition, DateTypeDefinition, TimeTypeDefinition, DateTimeTypeDefinition, TimestampTypeDefinition, UUIDTypeDefinition, AssociationTypeDefinition, CompositionTypeDefinition
Type: string
Regex Pattern: ^[a-zA-Z0-9._\-]+$