Skip to content

Replace projection-entity configuration for one entity definition.

PUT
/api/workspace/admin/entity-definitions/{entityDefinitionId}/projection
curl --request PUT \
--url https://example.com/api/workspace/admin/entity-definitions/example/projection \
--header 'Content-Type: application/json' \
--data '{ "IsEnabled": true, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Members": [ { "Id": "example", "ReferenceFieldId": "example", "MemberKey": "example", "DisplayName": "example", "SortOrder": 1, "IsEnabled": true } ], "Mappings": [ { "Id": "example", "ReferenceFieldId": "example", "TargetKind": 0, "TargetFieldId": "example", "SourcePath": [ "example" ], "TransformKind": 0, "TransformSettingsJson": "example", "SortOrder": 1 } ] }'

Replaces the full member and mapping configuration in one call. Requires at least two single-value reference members; enabling runs a preflight scan over existing rows. Concepts: projection.

  • None
entityDefinitionId
required
string
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Projection-entity configuration update request. Replaces the full member and mapping configuration in one call.

object
IsEnabled

Whether projection is enabled. Enabling requires at least two members and runs a preflight scan over existing rows.

boolean
RowVersion

Expected projection configuration row version when updating an existing configuration. Omit it for the first configuration.

string format: uuid
Members

Full replacement list of source members; one entry per participating single-value reference field.

Array<object>
nullable

Projection-entity source member update item. Each member binds one single-value reference field of the projection entity to one source entity definition.

object
Id

Existing member identifier when updating; null creates a new member.

string
nullable
ReferenceFieldId
required

Identifier of the projection entity’s single-value Reference field that links to the source rows. The field becomes projection-managed while selected.

string
MemberKey

Stable technical key of the member; derived from the reference field when omitted.

string
nullable
DisplayName

Administrative display name of the member; falls back to the source entity’s singular display name when omitted.

string
nullable
SortOrder

Member order in administrative lists.

integer format: int32
IsEnabled

Whether rows of this source participate in synchronization.

boolean
Mappings

Full replacement list of field mappings across all members.

Array<object>
nullable

Projection-entity field mapping update item. Copies one source value into a projection field or presentation value when the owning member’s row synchronizes.

object
Id

Existing mapping identifier when updating; null creates a new mapping.

string
nullable
ReferenceFieldId
required

Reference field of the member this mapping belongs to.

string
TargetKind
integer format: int32
Allowed values: 0 1 2
TargetFieldId

Target projection field identifier; required when the target kind is Field, must be omitted for DisplayName and Subtitle targets.

string
nullable
SourcePath
required

Field-key path from the source row as ordered segments, for example [“Category”, “DisplayName”]; intermediate segments must be single-value references.

Array<string>
TransformKind
integer format: int32
Allowed values: 0
TransformSettingsJson

Reserved for future transform settings; must be valid JSON when provided and is not read by the Copy transform.

string
nullable
SortOrder

Mapping order within the member.

integer format: int32

OK

Media typeapplication/json
object
Data

Full entity definition detail.

object
Id

Entity definition identifier.

string
nullable
Name

Internal entity name.

string
nullable
DisplayNameSingular

User-facing singular name.

string
nullable
DisplayNamePlural

User-facing plural name.

string
nullable
Description

Optional entity description.

string
nullable
CommentsEnabled

Whether comments are enabled.

boolean
AttachmentsEnabled

Whether attachments are enabled.

boolean
TagsEnabled

Whether tags are enabled.

boolean
AuditTrailEnabled

Whether audit trail is enabled.

boolean
AuditTrailRetentionMode
integer format: int32
Allowed values: 0 1 2
AuditTrailRetentionDays

Retention days when mode is days-based.

integer format: int32
nullable
NumberPrefix

Configured number prefix.

string
nullable
IsReadOnly

Whether runtime writes are blocked for this entity.

boolean
DisabledOperations
integer format: int32
Allowed values: 0 1 2 4 8 16 32 64 128
IsPendingDeletion

Whether the definition is frozen pending deletion.

boolean
DeletionRequestedAt

Timestamp when deferred deletion was requested.

string format: date-time
nullable
PurgeAfterUtc

Scheduled purge timestamp.

string format: date-time
nullable
Tables

Definition tables.

Array<object>
nullable

Metadata for one physical table used by an entity definition.

object
Id

Table metadata identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
Name

Logical table name.

string
nullable
SchemaName

Database schema name.

string
nullable
PhysicalTableName

Physical table name.

string
nullable
IsPrimary

Whether this is the primary entity table.

boolean
OwnerFieldId

Owner field identifier for child tables.

string
nullable
Fields

Fields that belong to the table.

Array<object>
nullable

Metadata for one entity field definition.

object
Id

Field identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
EntityDefinitionTableId

Entity definition table identifier.

string
nullable
Key

Field key.

string
nullable
DisplayName

Field display name.

string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
VisibleWhen

Visibility condition expression.

string
nullable
RequiredWhen

Requiredness condition expression.

string
nullable
BusinessRequiredWhen

Package-owned business requiredness condition expression.

string
nullable
EditableWhen

Editability condition expression.

string
nullable
IsReadOnly

Whether runtime writes should skip this field.

boolean
DecimalPrecision

Decimal precision when applicable.

integer format: int32
nullable
DecimalScale

Decimal scale when applicable.

integer format: int32
nullable
StringMaxLength

String max length when applicable.

integer format: int32
nullable
AllowMultiple

Whether multiple values are allowed.

boolean
ReferenceToEntityDefinitionId

Target entity definition identifier for reference-style fields.

string
nullable
PairedReferenceFieldId

Paired reference field identifier for inverse reference fields.

string
nullable
AllowSort

Whether root-list sorting by linked display value is allowed.

boolean
ReferenceDeleteBehavior
integer format: int32
Allowed values: 0 1 2
SortOrder

Sort order inside the owning table.

integer format: int32
Options

Select options when applicable.

Array<object>
nullable

Option metadata for select fields.

object
Id

Option identifier.

string
nullable
EntityFieldDefinitionId

Owning field identifier.

string
nullable
Key

Option key.

string
nullable
Value

Option display value.

string
nullable
SortOrder

Sort order.

integer format: int32
ChildTableId

Child table metadata identifier for table fields.

string
nullable
IsDeleted

Whether the field is soft-deleted.

boolean
DeletedAt

Deletion timestamp.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
AddressCoordinatesRequired

Whether address values must carry latitude and longitude.

boolean
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
Metadata

Owner-scoped metadata attached to this field.

Array<object>
nullable

Owner-scoped metadata attached to one entity field definition.

object
Id

Metadata row identifier.

string
nullable
EntityFieldDefinitionId

Owning field identifier.

string
nullable
OwnerModuleKey

Module that owns this metadata key.

string
nullable
Key

Metadata key inside the owner module.

string
nullable
ValueJson

Metadata value as JSON.

object
RowVersion

Concurrency token.

string format: uuid
SystemRole
integer format: int32
Allowed values: 0 1 2 3 4 5 6
VisibleWhenOperationMode
integer format: int32
Allowed values: 0 1 2
RequiredWhenOperationMode
integer format: int32
Allowed values: 0 1 2
EditableWhenOperationMode
integer format: int32
Allowed values: 0 1 2
BaseCurrencyCode

Base currency code for Money fields.

string
nullable
CalculationExpression

Stored calculated-field expression.

string
nullable
CalculationKind
integer format: int32
Allowed values: 0 1
ReferenceArchiveBehavior
integer format: int32
Allowed values: 0 1
ReferenceAuditRollupBehavior
integer format: int32
Allowed values: 0 1
SemanticRole
integer format: int32
Allowed values: 0 1 2 3
SemanticRoleScopeFieldId

Field identifier used as semantic scope, when the selected role requires one.

string
nullable
ClassifierCatalogDefinitionId

Bound Classifier Catalog Definition identifier.

string
nullable
ClassifierCatalogKey

Stable key of the bound Classifier Catalog Definition.

string
nullable
ClassifierCatalogDisplayName

Display name of the bound Classifier Catalog Definition.

string
nullable
DefaultValue

Configured default applied to an absent primary field on create or an absent child field in a new table row. It does not change existing rows.

object
Kind
integer format: int32
Allowed values: 0 1 2
Value

Canonical constant JSON value. A scalar Reference contains only the target entity-instance id string. Null for dynamic defaults.

object
IsProtected

Whether the field’s system-owned structural shape is protected while administrator-owned metadata remains editable.

boolean
IsDeleted

Whether the table metadata is soft-deleted.

boolean
DeletedAt

Deletion timestamp.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
UniqueConstraints

Configured unique constraints.

Array<object>
nullable

Unique constraint configured for one entity definition table.

object
Id

Constraint identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Fields

Ordered participating fields.

Array<object>
nullable

Field entry participating in an entity unique constraint.

object
Id

Field identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Key

Field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
RowVersion

Concurrency token.

string format: uuid
Indexes

Configured non-unique indexes.

Array<object>
nullable

Non-unique index configured for one entity definition table.

object
Id

Index identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Fields

Ordered participating fields.

Array<object>
nullable

Field participating in one definition index.

object
Id

Field identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Key

Internal field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
RowVersion

Concurrency token.

string format: uuid
Statements

Configured entity statements.

Array<object>
nullable

Administrative entity statement definition.

object
Id

Statement identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Name

Stable technical statement key.

string
nullable
DisplayName

User-facing statement label.

string
nullable
Expression

Stored SQL-like statement expression.

string
nullable
ExposeInClient

Whether runtime payloads expose this statement as a predicate flag.

boolean
SortOrder

Statement ordering inside the entity definition.

integer format: int32
IsDeleted

Whether the statement is soft-deleted.

boolean
DeletedAt

Soft-delete timestamp when deleted.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
ValidationRules

Configured entity validation rules.

Array<object>
nullable

Administrative entity validation rule definition.

object
Id

Validation rule identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Name

Stable technical validation rule key.

string
nullable
DisplayName

User-facing validation rule label.

string
nullable
Expression

Validation expression.

string
nullable
Message

User-facing validation failure message.

string
nullable
MessageTranslations

Optional localized validation failure message templates keyed by locale.

object
key
additional properties
string
Enabled

Whether this validation rule is active.

boolean
SortOrder

Validation rule ordering inside the entity definition.

integer format: int32
IsDeleted

Whether the validation rule is soft-deleted.

boolean
DeletedAt

Soft-delete timestamp when deleted.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
PresentationRules

Configured entity presentation rules.

Array<object>
nullable

Metadata for one entity presentation rule.

object
Id

Presentation rule identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Target
integer format: int32
Allowed values: 0 1
Template

Stored render template; optionLabel(SelectPath) renders a configured Select option caption.

string
nullable
Condition

Stored rule condition expression.

string
nullable
SortOrder

Stable ordering inside one presentation slot.

integer format: int32
IsDeleted

Whether the rule is soft-deleted.

boolean
DeletedAt

Soft-delete timestamp when deleted.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
UsageType
integer format: int32
Allowed values: 0 1 2
OwnerModuleKey

Owning module key when the usage type is Part.

string
nullable
OwnerAggregateType

Owning aggregate type when the usage type is Part.

string
nullable
OwnerAggregateId

Owning aggregate identifier when the usage type is Part.

string
nullable
AssociationBinding

Association endpoint and generated inverse binding metadata.

object
Id

Binding identifier.

string
nullable
EntityDefinitionId

Association entity definition identifier.

string
nullable
LeftEndpointEntityDefinitionId

Left endpoint target entity definition identifier.

string
nullable
RightEndpointEntityDefinitionId

Right endpoint target entity definition identifier.

string
nullable
LeftEndpointFieldId

Left required reference field on the association entity.

string
nullable
RightEndpointFieldId

Right required reference field on the association entity.

string
nullable
LeftInverseFieldId

Generated inverse field on the left endpoint entity.

string
nullable
RightInverseFieldId

Generated inverse field on the right endpoint entity.

string
nullable
Projection

Projection-entity configuration for one entity definition.

object
Id

Projection configuration identifier.

string
nullable
EntityDefinitionId

Projection entity definition identifier.

string
nullable
ProjectionKind
integer format: int32
Allowed values: 0
IsEnabled

Whether projection synchronization is active.

boolean
OpenBehavior
integer format: int32
Allowed values: 0
Members

Configured source members, one per member reference field.

Array<object>
nullable

Projection-entity source member configuration.

object
Id

Member identifier.

string
nullable
ProjectionDefinitionId

Owning projection configuration identifier.

string
nullable
ReferenceFieldId

Projection-managed reference field that links projection rows to source rows.

string
nullable
ReferenceFieldKey

Key of the member reference field.

string
nullable
ReferenceFieldDisplayName

Display name of the member reference field.

string
nullable
SourceEntityDefinitionId

Source entity definition identifier.

string
nullable
SourceEntityDefinitionName

Internal name of the source entity definition.

string
nullable
SourceEntityDefinitionDisplayName

Display name of the source entity definition.

string
nullable
MemberKey

Stable technical key of the member.

string
nullable
DisplayName

Administrative display name of the member.

string
nullable
SortOrder

Member order in administrative lists.

integer format: int32
IsEnabled

Whether rows of this source participate in synchronization.

boolean
RowVersion

Concurrency token.

string format: uuid
Mappings

Configured field mappings across all members.

Array<object>
nullable

Projection-entity field mapping rule.

object
Id

Mapping identifier.

string
nullable
ProjectionDefinitionId

Owning projection configuration identifier.

string
nullable
ProjectionMemberId

Member this mapping belongs to.

string
nullable
ReferenceFieldId

Reference field of the owning member.

string
nullable
TargetKind
integer format: int32
Allowed values: 0 1 2
TargetFieldId

Target projection field identifier when the target kind is Field.

string
nullable
TargetFieldKey

Key of the target projection field when the target kind is Field.

string
nullable
TargetFieldDisplayName

Display name of the target projection field when the target kind is Field.

string
nullable
SourcePath

Field-key path from the source row as ordered segments.

Array<string>
nullable
TransformKind
integer format: int32
Allowed values: 0
TransformSettingsJson

Reserved transform settings; not read by the Copy transform.

string
nullable
SortOrder

Mapping order within the member.

integer format: int32
RowVersion

Concurrency token.

string format: uuid
RowVersion

Concurrency token for the projection configuration.

string format: uuid
IsSystemDefined

Whether the platform owns this definition. It cannot be deleted or renamed, and its protected fields cannot be changed.

boolean
SystemKey

Stable platform key when the definition is system-defined.

string
nullable
SearchMaxPathDepth

Maximum configured relation transitions accepted for a search target.

integer format: int32
SearchMaxTargetsPerDefinition

Maximum number of explicit runtime search targets accepted for this definition.

integer format: int32
SearchTargets

Explicit runtime search targets.

Array<object>
nullable

Configured entity search target with resolved path metadata.

object
Id
string
nullable
Path
Array<object>
nullable

Resolved segment of a configured entity search target.

object
EntityDefinitionId
string
nullable
FieldId
string
nullable
FieldKey
string
nullable
DisplayName
string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SystemTarget
integer format: int32
Allowed values: 0 1 2 3
DefaultSort

Entity-level default runtime sort sequence.

Array<object>
nullable

Entity-level default runtime sort item.

object
Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object
Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>
nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string
nullable
FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string
nullable
Special
integer format: int32
Allowed values: 0 1
StatementId

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Direction
integer format: int32
Allowed values: 0 1
SortOrder

Default sort order.

integer format: int32
DisplayFields

Read-time display fields available to table and card surfaces.

Array<object>
nullable

Read-time display field metadata.

object
Id
string
nullable
EntityDefinitionId
string
nullable
Key
string
nullable
DisplayName
string
nullable
Rules
Array<object>
nullable

One ordered rule for a read-time display field. Templates support optionLabel(SelectPath) for configured Select option captions.

object
Id
string
nullable
EntityDisplayFieldId
string
nullable
Template
string
nullable
Condition
string
nullable
SortOrder
integer format: int32
IsDeleted
boolean
DeletedAt
string format: date-time
nullable
RowVersion
string format: uuid
SortOrder
integer format: int32
IsDeleted
boolean
DeletedAt
string format: date-time
nullable
RowVersion
string format: uuid
ObjectContextFacts

ID-only object-context facts materialized onto entity-instance read models.

Array<object>
nullable

Object-context fact configuration for one entity definition.

object
Id
string
nullable
Key
string
nullable
ProviderKey
string
nullable
Target
object
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
ResourceObjectId
string
nullable
SortOrder
integer format: int32
RowVersion
string format: uuid
ModuleEntityRoles

Built-in module roles assigned to this system Entity Definition.

Array<object>
nullable

Public module-role identity projected with Entity Definition metadata.

object
ModuleKey
string
nullable
RoleKey
string
nullable
ManualOrder

Admin-facing Manual Order capability metadata without protected rank storage details.

object
Id
string
nullable
EntityDefinitionId
string
nullable
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId
string
nullable
SourcePackageId
string
nullable
SourceStableId
string
nullable
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"AuditTrailRetentionMode": 0,
"DisabledOperations": 0,
"Tables": [
{
"Fields": [
{
"FieldType": 0,
"ReferenceDeleteBehavior": 0,
"SchemaSource": 0,
"SystemRole": 0,
"VisibleWhenOperationMode": 0,
"RequiredWhenOperationMode": 0,
"EditableWhenOperationMode": 0,
"CalculationKind": 0,
"ReferenceArchiveBehavior": 0,
"ReferenceAuditRollupBehavior": 0,
"SemanticRole": 0,
"DefaultValue": {
"Kind": 0
}
}
],
"SchemaSource": 0
}
],
"Statements": [
{
"SchemaSource": 0
}
],
"ValidationRules": [
{
"SchemaSource": 0
}
],
"PresentationRules": [
{
"Target": 0,
"SchemaSource": 0
}
],
"SchemaSource": 0,
"UsageType": 0,
"Projection": {
"ProjectionKind": 0,
"OpenBehavior": 0,
"Mappings": [
{
"TargetKind": 0,
"TransformKind": 0
}
]
},
"SearchTargets": [
{
"Path": [
{
"FieldType": 0,
"SystemTarget": 0
}
]
}
],
"DefaultSort": [
{
"Target": {
"Path": [
{
"Special": 0
}
]
},
"Direction": 0
}
],
"ManualOrder": {
"SchemaSource": 0
}
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data

Full entity definition detail.

object
Id

Entity definition identifier.

string
nullable
Name

Internal entity name.

string
nullable
DisplayNameSingular

User-facing singular name.

string
nullable
DisplayNamePlural

User-facing plural name.

string
nullable
Description

Optional entity description.

string
nullable
CommentsEnabled

Whether comments are enabled.

boolean
AttachmentsEnabled

Whether attachments are enabled.

boolean
TagsEnabled

Whether tags are enabled.

boolean
AuditTrailEnabled

Whether audit trail is enabled.

boolean
AuditTrailRetentionMode
integer format: int32
Allowed values: 0 1 2
AuditTrailRetentionDays

Retention days when mode is days-based.

integer format: int32
nullable
NumberPrefix

Configured number prefix.

string
nullable
IsReadOnly

Whether runtime writes are blocked for this entity.

boolean
DisabledOperations
integer format: int32
Allowed values: 0 1 2 4 8 16 32 64 128
IsPendingDeletion

Whether the definition is frozen pending deletion.

boolean
DeletionRequestedAt

Timestamp when deferred deletion was requested.

string format: date-time
nullable
PurgeAfterUtc

Scheduled purge timestamp.

string format: date-time
nullable
Tables

Definition tables.

Array<object>
nullable

Metadata for one physical table used by an entity definition.

object
Id

Table metadata identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
Name

Logical table name.

string
nullable
SchemaName

Database schema name.

string
nullable
PhysicalTableName

Physical table name.

string
nullable
IsPrimary

Whether this is the primary entity table.

boolean
OwnerFieldId

Owner field identifier for child tables.

string
nullable
Fields

Fields that belong to the table.

Array<object>
nullable

Metadata for one entity field definition.

object
Id

Field identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
EntityDefinitionTableId

Entity definition table identifier.

string
nullable
Key

Field key.

string
nullable
DisplayName

Field display name.

string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
VisibleWhen

Visibility condition expression.

string
nullable
RequiredWhen

Requiredness condition expression.

string
nullable
BusinessRequiredWhen

Package-owned business requiredness condition expression.

string
nullable
EditableWhen

Editability condition expression.

string
nullable
IsReadOnly

Whether runtime writes should skip this field.

boolean
DecimalPrecision

Decimal precision when applicable.

integer format: int32
nullable
DecimalScale

Decimal scale when applicable.

integer format: int32
nullable
StringMaxLength

String max length when applicable.

integer format: int32
nullable
AllowMultiple

Whether multiple values are allowed.

boolean
ReferenceToEntityDefinitionId

Target entity definition identifier for reference-style fields.

string
nullable
PairedReferenceFieldId

Paired reference field identifier for inverse reference fields.

string
nullable
AllowSort

Whether root-list sorting by linked display value is allowed.

boolean
ReferenceDeleteBehavior
integer format: int32
Allowed values: 0 1 2
SortOrder

Sort order inside the owning table.

integer format: int32
Options

Select options when applicable.

Array<object>
nullable

Option metadata for select fields.

object
Id

Option identifier.

string
nullable
EntityFieldDefinitionId

Owning field identifier.

string
nullable
Key

Option key.

string
nullable
Value

Option display value.

string
nullable
SortOrder

Sort order.

integer format: int32
ChildTableId

Child table metadata identifier for table fields.

string
nullable
IsDeleted

Whether the field is soft-deleted.

boolean
DeletedAt

Deletion timestamp.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
AddressCoordinatesRequired

Whether address values must carry latitude and longitude.

boolean
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
Metadata

Owner-scoped metadata attached to this field.

Array<object>
nullable

Owner-scoped metadata attached to one entity field definition.

object
Id

Metadata row identifier.

string
nullable
EntityFieldDefinitionId

Owning field identifier.

string
nullable
OwnerModuleKey

Module that owns this metadata key.

string
nullable
Key

Metadata key inside the owner module.

string
nullable
ValueJson

Metadata value as JSON.

object
RowVersion

Concurrency token.

string format: uuid
SystemRole
integer format: int32
Allowed values: 0 1 2 3 4 5 6
VisibleWhenOperationMode
integer format: int32
Allowed values: 0 1 2
RequiredWhenOperationMode
integer format: int32
Allowed values: 0 1 2
EditableWhenOperationMode
integer format: int32
Allowed values: 0 1 2
BaseCurrencyCode

Base currency code for Money fields.

string
nullable
CalculationExpression

Stored calculated-field expression.

string
nullable
CalculationKind
integer format: int32
Allowed values: 0 1
ReferenceArchiveBehavior
integer format: int32
Allowed values: 0 1
ReferenceAuditRollupBehavior
integer format: int32
Allowed values: 0 1
SemanticRole
integer format: int32
Allowed values: 0 1 2 3
SemanticRoleScopeFieldId

Field identifier used as semantic scope, when the selected role requires one.

string
nullable
ClassifierCatalogDefinitionId

Bound Classifier Catalog Definition identifier.

string
nullable
ClassifierCatalogKey

Stable key of the bound Classifier Catalog Definition.

string
nullable
ClassifierCatalogDisplayName

Display name of the bound Classifier Catalog Definition.

string
nullable
DefaultValue

Configured default applied to an absent primary field on create or an absent child field in a new table row. It does not change existing rows.

object
Kind
integer format: int32
Allowed values: 0 1 2
Value

Canonical constant JSON value. A scalar Reference contains only the target entity-instance id string. Null for dynamic defaults.

object
IsProtected

Whether the field’s system-owned structural shape is protected while administrator-owned metadata remains editable.

boolean
IsDeleted

Whether the table metadata is soft-deleted.

boolean
DeletedAt

Deletion timestamp.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
UniqueConstraints

Configured unique constraints.

Array<object>
nullable

Unique constraint configured for one entity definition table.

object
Id

Constraint identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Fields

Ordered participating fields.

Array<object>
nullable

Field entry participating in an entity unique constraint.

object
Id

Field identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Key

Field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
RowVersion

Concurrency token.

string format: uuid
Indexes

Configured non-unique indexes.

Array<object>
nullable

Non-unique index configured for one entity definition table.

object
Id

Index identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Fields

Ordered participating fields.

Array<object>
nullable

Field participating in one definition index.

object
Id

Field identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Key

Internal field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
RowVersion

Concurrency token.

string format: uuid
Statements

Configured entity statements.

Array<object>
nullable

Administrative entity statement definition.

object
Id

Statement identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Name

Stable technical statement key.

string
nullable
DisplayName

User-facing statement label.

string
nullable
Expression

Stored SQL-like statement expression.

string
nullable
ExposeInClient

Whether runtime payloads expose this statement as a predicate flag.

boolean
SortOrder

Statement ordering inside the entity definition.

integer format: int32
IsDeleted

Whether the statement is soft-deleted.

boolean
DeletedAt

Soft-delete timestamp when deleted.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
ValidationRules

Configured entity validation rules.

Array<object>
nullable

Administrative entity validation rule definition.

object
Id

Validation rule identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Name

Stable technical validation rule key.

string
nullable
DisplayName

User-facing validation rule label.

string
nullable
Expression

Validation expression.

string
nullable
Message

User-facing validation failure message.

string
nullable
MessageTranslations

Optional localized validation failure message templates keyed by locale.

object
key
additional properties
string
Enabled

Whether this validation rule is active.

boolean
SortOrder

Validation rule ordering inside the entity definition.

integer format: int32
IsDeleted

Whether the validation rule is soft-deleted.

boolean
DeletedAt

Soft-delete timestamp when deleted.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
PresentationRules

Configured entity presentation rules.

Array<object>
nullable

Metadata for one entity presentation rule.

object
Id

Presentation rule identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Target
integer format: int32
Allowed values: 0 1
Template

Stored render template; optionLabel(SelectPath) renders a configured Select option caption.

string
nullable
Condition

Stored rule condition expression.

string
nullable
SortOrder

Stable ordering inside one presentation slot.

integer format: int32
IsDeleted

Whether the rule is soft-deleted.

boolean
DeletedAt

Soft-delete timestamp when deleted.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
UsageType
integer format: int32
Allowed values: 0 1 2
OwnerModuleKey

Owning module key when the usage type is Part.

string
nullable
OwnerAggregateType

Owning aggregate type when the usage type is Part.

string
nullable
OwnerAggregateId

Owning aggregate identifier when the usage type is Part.

string
nullable
AssociationBinding

Association endpoint and generated inverse binding metadata.

object
Id

Binding identifier.

string
nullable
EntityDefinitionId

Association entity definition identifier.

string
nullable
LeftEndpointEntityDefinitionId

Left endpoint target entity definition identifier.

string
nullable
RightEndpointEntityDefinitionId

Right endpoint target entity definition identifier.

string
nullable
LeftEndpointFieldId

Left required reference field on the association entity.

string
nullable
RightEndpointFieldId

Right required reference field on the association entity.

string
nullable
LeftInverseFieldId

Generated inverse field on the left endpoint entity.

string
nullable
RightInverseFieldId

Generated inverse field on the right endpoint entity.

string
nullable
Projection

Projection-entity configuration for one entity definition.

object
Id

Projection configuration identifier.

string
nullable
EntityDefinitionId

Projection entity definition identifier.

string
nullable
ProjectionKind
integer format: int32
Allowed values: 0
IsEnabled

Whether projection synchronization is active.

boolean
OpenBehavior
integer format: int32
Allowed values: 0
Members

Configured source members, one per member reference field.

Array<object>
nullable

Projection-entity source member configuration.

object
Id

Member identifier.

string
nullable
ProjectionDefinitionId

Owning projection configuration identifier.

string
nullable
ReferenceFieldId

Projection-managed reference field that links projection rows to source rows.

string
nullable
ReferenceFieldKey

Key of the member reference field.

string
nullable
ReferenceFieldDisplayName

Display name of the member reference field.

string
nullable
SourceEntityDefinitionId

Source entity definition identifier.

string
nullable
SourceEntityDefinitionName

Internal name of the source entity definition.

string
nullable
SourceEntityDefinitionDisplayName

Display name of the source entity definition.

string
nullable
MemberKey

Stable technical key of the member.

string
nullable
DisplayName

Administrative display name of the member.

string
nullable
SortOrder

Member order in administrative lists.

integer format: int32
IsEnabled

Whether rows of this source participate in synchronization.

boolean
RowVersion

Concurrency token.

string format: uuid
Mappings

Configured field mappings across all members.

Array<object>
nullable

Projection-entity field mapping rule.

object
Id

Mapping identifier.

string
nullable
ProjectionDefinitionId

Owning projection configuration identifier.

string
nullable
ProjectionMemberId

Member this mapping belongs to.

string
nullable
ReferenceFieldId

Reference field of the owning member.

string
nullable
TargetKind
integer format: int32
Allowed values: 0 1 2
TargetFieldId

Target projection field identifier when the target kind is Field.

string
nullable
TargetFieldKey

Key of the target projection field when the target kind is Field.

string
nullable
TargetFieldDisplayName

Display name of the target projection field when the target kind is Field.

string
nullable
SourcePath

Field-key path from the source row as ordered segments.

Array<string>
nullable
TransformKind
integer format: int32
Allowed values: 0
TransformSettingsJson

Reserved transform settings; not read by the Copy transform.

string
nullable
SortOrder

Mapping order within the member.

integer format: int32
RowVersion

Concurrency token.

string format: uuid
RowVersion

Concurrency token for the projection configuration.

string format: uuid
IsSystemDefined

Whether the platform owns this definition. It cannot be deleted or renamed, and its protected fields cannot be changed.

boolean
SystemKey

Stable platform key when the definition is system-defined.

string
nullable
SearchMaxPathDepth

Maximum configured relation transitions accepted for a search target.

integer format: int32
SearchMaxTargetsPerDefinition

Maximum number of explicit runtime search targets accepted for this definition.

integer format: int32
SearchTargets

Explicit runtime search targets.

Array<object>
nullable

Configured entity search target with resolved path metadata.

object
Id
string
nullable
Path
Array<object>
nullable

Resolved segment of a configured entity search target.

object
EntityDefinitionId
string
nullable
FieldId
string
nullable
FieldKey
string
nullable
DisplayName
string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SystemTarget
integer format: int32
Allowed values: 0 1 2 3
DefaultSort

Entity-level default runtime sort sequence.

Array<object>
nullable

Entity-level default runtime sort item.

object
Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object
Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>
nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string
nullable
FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string
nullable
Special
integer format: int32
Allowed values: 0 1
StatementId

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Direction
integer format: int32
Allowed values: 0 1
SortOrder

Default sort order.

integer format: int32
DisplayFields

Read-time display fields available to table and card surfaces.

Array<object>
nullable

Read-time display field metadata.

object
Id
string
nullable
EntityDefinitionId
string
nullable
Key
string
nullable
DisplayName
string
nullable
Rules
Array<object>
nullable

One ordered rule for a read-time display field. Templates support optionLabel(SelectPath) for configured Select option captions.

object
Id
string
nullable
EntityDisplayFieldId
string
nullable
Template
string
nullable
Condition
string
nullable
SortOrder
integer format: int32
IsDeleted
boolean
DeletedAt
string format: date-time
nullable
RowVersion
string format: uuid
SortOrder
integer format: int32
IsDeleted
boolean
DeletedAt
string format: date-time
nullable
RowVersion
string format: uuid
ObjectContextFacts

ID-only object-context facts materialized onto entity-instance read models.

Array<object>
nullable

Object-context fact configuration for one entity definition.

object
Id
string
nullable
Key
string
nullable
ProviderKey
string
nullable
Target
object
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
ResourceObjectId
string
nullable
SortOrder
integer format: int32
RowVersion
string format: uuid
ModuleEntityRoles

Built-in module roles assigned to this system Entity Definition.

Array<object>
nullable

Public module-role identity projected with Entity Definition metadata.

object
ModuleKey
string
nullable
RoleKey
string
nullable
ManualOrder

Admin-facing Manual Order capability metadata without protected rank storage details.

object
Id
string
nullable
EntityDefinitionId
string
nullable
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId
string
nullable
SourcePackageId
string
nullable
SourceStableId
string
nullable
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"AuditTrailRetentionMode": 0,
"DisabledOperations": 0,
"Tables": [
{
"Fields": [
{
"FieldType": 0,
"ReferenceDeleteBehavior": 0,
"SchemaSource": 0,
"SystemRole": 0,
"VisibleWhenOperationMode": 0,
"RequiredWhenOperationMode": 0,
"EditableWhenOperationMode": 0,
"CalculationKind": 0,
"ReferenceArchiveBehavior": 0,
"ReferenceAuditRollupBehavior": 0,
"SemanticRole": 0,
"DefaultValue": {
"Kind": 0
}
}
],
"SchemaSource": 0
}
],
"Statements": [
{
"SchemaSource": 0
}
],
"ValidationRules": [
{
"SchemaSource": 0
}
],
"PresentationRules": [
{
"Target": 0,
"SchemaSource": 0
}
],
"SchemaSource": 0,
"UsageType": 0,
"Projection": {
"ProjectionKind": 0,
"OpenBehavior": 0,
"Mappings": [
{
"TargetKind": 0,
"TransformKind": 0
}
]
},
"SearchTargets": [
{
"Path": [
{
"FieldType": 0,
"SystemTarget": 0
}
]
}
],
"DefaultSort": [
{
"Target": {
"Path": [
{
"Special": 0
}
]
},
"Direction": 0
}
],
"ManualOrder": {
"SchemaSource": 0
}
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/json
object
Data

Full entity definition detail.

object
Id

Entity definition identifier.

string
nullable
Name

Internal entity name.

string
nullable
DisplayNameSingular

User-facing singular name.

string
nullable
DisplayNamePlural

User-facing plural name.

string
nullable
Description

Optional entity description.

string
nullable
CommentsEnabled

Whether comments are enabled.

boolean
AttachmentsEnabled

Whether attachments are enabled.

boolean
TagsEnabled

Whether tags are enabled.

boolean
AuditTrailEnabled

Whether audit trail is enabled.

boolean
AuditTrailRetentionMode
integer format: int32
Allowed values: 0 1 2
AuditTrailRetentionDays

Retention days when mode is days-based.

integer format: int32
nullable
NumberPrefix

Configured number prefix.

string
nullable
IsReadOnly

Whether runtime writes are blocked for this entity.

boolean
DisabledOperations
integer format: int32
Allowed values: 0 1 2 4 8 16 32 64 128
IsPendingDeletion

Whether the definition is frozen pending deletion.

boolean
DeletionRequestedAt

Timestamp when deferred deletion was requested.

string format: date-time
nullable
PurgeAfterUtc

Scheduled purge timestamp.

string format: date-time
nullable
Tables

Definition tables.

Array<object>
nullable

Metadata for one physical table used by an entity definition.

object
Id

Table metadata identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
Name

Logical table name.

string
nullable
SchemaName

Database schema name.

string
nullable
PhysicalTableName

Physical table name.

string
nullable
IsPrimary

Whether this is the primary entity table.

boolean
OwnerFieldId

Owner field identifier for child tables.

string
nullable
Fields

Fields that belong to the table.

Array<object>
nullable

Metadata for one entity field definition.

object
Id

Field identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
EntityDefinitionTableId

Entity definition table identifier.

string
nullable
Key

Field key.

string
nullable
DisplayName

Field display name.

string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
VisibleWhen

Visibility condition expression.

string
nullable
RequiredWhen

Requiredness condition expression.

string
nullable
BusinessRequiredWhen

Package-owned business requiredness condition expression.

string
nullable
EditableWhen

Editability condition expression.

string
nullable
IsReadOnly

Whether runtime writes should skip this field.

boolean
DecimalPrecision

Decimal precision when applicable.

integer format: int32
nullable
DecimalScale

Decimal scale when applicable.

integer format: int32
nullable
StringMaxLength

String max length when applicable.

integer format: int32
nullable
AllowMultiple

Whether multiple values are allowed.

boolean
ReferenceToEntityDefinitionId

Target entity definition identifier for reference-style fields.

string
nullable
PairedReferenceFieldId

Paired reference field identifier for inverse reference fields.

string
nullable
AllowSort

Whether root-list sorting by linked display value is allowed.

boolean
ReferenceDeleteBehavior
integer format: int32
Allowed values: 0 1 2
SortOrder

Sort order inside the owning table.

integer format: int32
Options

Select options when applicable.

Array<object>
nullable

Option metadata for select fields.

object
Id

Option identifier.

string
nullable
EntityFieldDefinitionId

Owning field identifier.

string
nullable
Key

Option key.

string
nullable
Value

Option display value.

string
nullable
SortOrder

Sort order.

integer format: int32
ChildTableId

Child table metadata identifier for table fields.

string
nullable
IsDeleted

Whether the field is soft-deleted.

boolean
DeletedAt

Deletion timestamp.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
AddressCoordinatesRequired

Whether address values must carry latitude and longitude.

boolean
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
Metadata

Owner-scoped metadata attached to this field.

Array<object>
nullable

Owner-scoped metadata attached to one entity field definition.

object
Id

Metadata row identifier.

string
nullable
EntityFieldDefinitionId

Owning field identifier.

string
nullable
OwnerModuleKey

Module that owns this metadata key.

string
nullable
Key

Metadata key inside the owner module.

string
nullable
ValueJson

Metadata value as JSON.

object
RowVersion

Concurrency token.

string format: uuid
SystemRole
integer format: int32
Allowed values: 0 1 2 3 4 5 6
VisibleWhenOperationMode
integer format: int32
Allowed values: 0 1 2
RequiredWhenOperationMode
integer format: int32
Allowed values: 0 1 2
EditableWhenOperationMode
integer format: int32
Allowed values: 0 1 2
BaseCurrencyCode

Base currency code for Money fields.

string
nullable
CalculationExpression

Stored calculated-field expression.

string
nullable
CalculationKind
integer format: int32
Allowed values: 0 1
ReferenceArchiveBehavior
integer format: int32
Allowed values: 0 1
ReferenceAuditRollupBehavior
integer format: int32
Allowed values: 0 1
SemanticRole
integer format: int32
Allowed values: 0 1 2 3
SemanticRoleScopeFieldId

Field identifier used as semantic scope, when the selected role requires one.

string
nullable
ClassifierCatalogDefinitionId

Bound Classifier Catalog Definition identifier.

string
nullable
ClassifierCatalogKey

Stable key of the bound Classifier Catalog Definition.

string
nullable
ClassifierCatalogDisplayName

Display name of the bound Classifier Catalog Definition.

string
nullable
DefaultValue

Configured default applied to an absent primary field on create or an absent child field in a new table row. It does not change existing rows.

object
Kind
integer format: int32
Allowed values: 0 1 2
Value

Canonical constant JSON value. A scalar Reference contains only the target entity-instance id string. Null for dynamic defaults.

object
IsProtected

Whether the field’s system-owned structural shape is protected while administrator-owned metadata remains editable.

boolean
IsDeleted

Whether the table metadata is soft-deleted.

boolean
DeletedAt

Deletion timestamp.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
UniqueConstraints

Configured unique constraints.

Array<object>
nullable

Unique constraint configured for one entity definition table.

object
Id

Constraint identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Fields

Ordered participating fields.

Array<object>
nullable

Field entry participating in an entity unique constraint.

object
Id

Field identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Key

Field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
RowVersion

Concurrency token.

string format: uuid
Indexes

Configured non-unique indexes.

Array<object>
nullable

Non-unique index configured for one entity definition table.

object
Id

Index identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Fields

Ordered participating fields.

Array<object>
nullable

Field participating in one definition index.

object
Id

Field identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Key

Internal field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
RowVersion

Concurrency token.

string format: uuid
Statements

Configured entity statements.

Array<object>
nullable

Administrative entity statement definition.

object
Id

Statement identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Name

Stable technical statement key.

string
nullable
DisplayName

User-facing statement label.

string
nullable
Expression

Stored SQL-like statement expression.

string
nullable
ExposeInClient

Whether runtime payloads expose this statement as a predicate flag.

boolean
SortOrder

Statement ordering inside the entity definition.

integer format: int32
IsDeleted

Whether the statement is soft-deleted.

boolean
DeletedAt

Soft-delete timestamp when deleted.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
ValidationRules

Configured entity validation rules.

Array<object>
nullable

Administrative entity validation rule definition.

object
Id

Validation rule identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Name

Stable technical validation rule key.

string
nullable
DisplayName

User-facing validation rule label.

string
nullable
Expression

Validation expression.

string
nullable
Message

User-facing validation failure message.

string
nullable
MessageTranslations

Optional localized validation failure message templates keyed by locale.

object
key
additional properties
string
Enabled

Whether this validation rule is active.

boolean
SortOrder

Validation rule ordering inside the entity definition.

integer format: int32
IsDeleted

Whether the validation rule is soft-deleted.

boolean
DeletedAt

Soft-delete timestamp when deleted.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
PresentationRules

Configured entity presentation rules.

Array<object>
nullable

Metadata for one entity presentation rule.

object
Id

Presentation rule identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Target
integer format: int32
Allowed values: 0 1
Template

Stored render template; optionLabel(SelectPath) renders a configured Select option caption.

string
nullable
Condition

Stored rule condition expression.

string
nullable
SortOrder

Stable ordering inside one presentation slot.

integer format: int32
IsDeleted

Whether the rule is soft-deleted.

boolean
DeletedAt

Soft-delete timestamp when deleted.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
UsageType
integer format: int32
Allowed values: 0 1 2
OwnerModuleKey

Owning module key when the usage type is Part.

string
nullable
OwnerAggregateType

Owning aggregate type when the usage type is Part.

string
nullable
OwnerAggregateId

Owning aggregate identifier when the usage type is Part.

string
nullable
AssociationBinding

Association endpoint and generated inverse binding metadata.

object
Id

Binding identifier.

string
nullable
EntityDefinitionId

Association entity definition identifier.

string
nullable
LeftEndpointEntityDefinitionId

Left endpoint target entity definition identifier.

string
nullable
RightEndpointEntityDefinitionId

Right endpoint target entity definition identifier.

string
nullable
LeftEndpointFieldId

Left required reference field on the association entity.

string
nullable
RightEndpointFieldId

Right required reference field on the association entity.

string
nullable
LeftInverseFieldId

Generated inverse field on the left endpoint entity.

string
nullable
RightInverseFieldId

Generated inverse field on the right endpoint entity.

string
nullable
Projection

Projection-entity configuration for one entity definition.

object
Id

Projection configuration identifier.

string
nullable
EntityDefinitionId

Projection entity definition identifier.

string
nullable
ProjectionKind
integer format: int32
Allowed values: 0
IsEnabled

Whether projection synchronization is active.

boolean
OpenBehavior
integer format: int32
Allowed values: 0
Members

Configured source members, one per member reference field.

Array<object>
nullable

Projection-entity source member configuration.

object
Id

Member identifier.

string
nullable
ProjectionDefinitionId

Owning projection configuration identifier.

string
nullable
ReferenceFieldId

Projection-managed reference field that links projection rows to source rows.

string
nullable
ReferenceFieldKey

Key of the member reference field.

string
nullable
ReferenceFieldDisplayName

Display name of the member reference field.

string
nullable
SourceEntityDefinitionId

Source entity definition identifier.

string
nullable
SourceEntityDefinitionName

Internal name of the source entity definition.

string
nullable
SourceEntityDefinitionDisplayName

Display name of the source entity definition.

string
nullable
MemberKey

Stable technical key of the member.

string
nullable
DisplayName

Administrative display name of the member.

string
nullable
SortOrder

Member order in administrative lists.

integer format: int32
IsEnabled

Whether rows of this source participate in synchronization.

boolean
RowVersion

Concurrency token.

string format: uuid
Mappings

Configured field mappings across all members.

Array<object>
nullable

Projection-entity field mapping rule.

object
Id

Mapping identifier.

string
nullable
ProjectionDefinitionId

Owning projection configuration identifier.

string
nullable
ProjectionMemberId

Member this mapping belongs to.

string
nullable
ReferenceFieldId

Reference field of the owning member.

string
nullable
TargetKind
integer format: int32
Allowed values: 0 1 2
TargetFieldId

Target projection field identifier when the target kind is Field.

string
nullable
TargetFieldKey

Key of the target projection field when the target kind is Field.

string
nullable
TargetFieldDisplayName

Display name of the target projection field when the target kind is Field.

string
nullable
SourcePath

Field-key path from the source row as ordered segments.

Array<string>
nullable
TransformKind
integer format: int32
Allowed values: 0
TransformSettingsJson

Reserved transform settings; not read by the Copy transform.

string
nullable
SortOrder

Mapping order within the member.

integer format: int32
RowVersion

Concurrency token.

string format: uuid
RowVersion

Concurrency token for the projection configuration.

string format: uuid
IsSystemDefined

Whether the platform owns this definition. It cannot be deleted or renamed, and its protected fields cannot be changed.

boolean
SystemKey

Stable platform key when the definition is system-defined.

string
nullable
SearchMaxPathDepth

Maximum configured relation transitions accepted for a search target.

integer format: int32
SearchMaxTargetsPerDefinition

Maximum number of explicit runtime search targets accepted for this definition.

integer format: int32
SearchTargets

Explicit runtime search targets.

Array<object>
nullable

Configured entity search target with resolved path metadata.

object
Id
string
nullable
Path
Array<object>
nullable

Resolved segment of a configured entity search target.

object
EntityDefinitionId
string
nullable
FieldId
string
nullable
FieldKey
string
nullable
DisplayName
string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SystemTarget
integer format: int32
Allowed values: 0 1 2 3
DefaultSort

Entity-level default runtime sort sequence.

Array<object>
nullable

Entity-level default runtime sort item.

object
Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object
Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>
nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string
nullable
FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string
nullable
Special
integer format: int32
Allowed values: 0 1
StatementId

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Direction
integer format: int32
Allowed values: 0 1
SortOrder

Default sort order.

integer format: int32
DisplayFields

Read-time display fields available to table and card surfaces.

Array<object>
nullable

Read-time display field metadata.

object
Id
string
nullable
EntityDefinitionId
string
nullable
Key
string
nullable
DisplayName
string
nullable
Rules
Array<object>
nullable

One ordered rule for a read-time display field. Templates support optionLabel(SelectPath) for configured Select option captions.

object
Id
string
nullable
EntityDisplayFieldId
string
nullable
Template
string
nullable
Condition
string
nullable
SortOrder
integer format: int32
IsDeleted
boolean
DeletedAt
string format: date-time
nullable
RowVersion
string format: uuid
SortOrder
integer format: int32
IsDeleted
boolean
DeletedAt
string format: date-time
nullable
RowVersion
string format: uuid
ObjectContextFacts

ID-only object-context facts materialized onto entity-instance read models.

Array<object>
nullable

Object-context fact configuration for one entity definition.

object
Id
string
nullable
Key
string
nullable
ProviderKey
string
nullable
Target
object
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
ResourceObjectId
string
nullable
SortOrder
integer format: int32
RowVersion
string format: uuid
ModuleEntityRoles

Built-in module roles assigned to this system Entity Definition.

Array<object>
nullable

Public module-role identity projected with Entity Definition metadata.

object
ModuleKey
string
nullable
RoleKey
string
nullable
ManualOrder

Admin-facing Manual Order capability metadata without protected rank storage details.

object
Id
string
nullable
EntityDefinitionId
string
nullable
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId
string
nullable
SourcePackageId
string
nullable
SourceStableId
string
nullable
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"AuditTrailRetentionMode": 0,
"DisabledOperations": 0,
"Tables": [
{
"Fields": [
{
"FieldType": 0,
"ReferenceDeleteBehavior": 0,
"SchemaSource": 0,
"SystemRole": 0,
"VisibleWhenOperationMode": 0,
"RequiredWhenOperationMode": 0,
"EditableWhenOperationMode": 0,
"CalculationKind": 0,
"ReferenceArchiveBehavior": 0,
"ReferenceAuditRollupBehavior": 0,
"SemanticRole": 0,
"DefaultValue": {
"Kind": 0
}
}
],
"SchemaSource": 0
}
],
"Statements": [
{
"SchemaSource": 0
}
],
"ValidationRules": [
{
"SchemaSource": 0
}
],
"PresentationRules": [
{
"Target": 0,
"SchemaSource": 0
}
],
"SchemaSource": 0,
"UsageType": 0,
"Projection": {
"ProjectionKind": 0,
"OpenBehavior": 0,
"Mappings": [
{
"TargetKind": 0,
"TransformKind": 0
}
]
},
"SearchTargets": [
{
"Path": [
{
"FieldType": 0,
"SystemTarget": 0
}
]
}
],
"DefaultSort": [
{
"Target": {
"Path": [
{
"Special": 0
}
]
},
"Direction": 0
}
],
"ManualOrder": {
"SchemaSource": 0
}
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Conflict

Media typeapplication/json
object
Data

Full entity definition detail.

object
Id

Entity definition identifier.

string
nullable
Name

Internal entity name.

string
nullable
DisplayNameSingular

User-facing singular name.

string
nullable
DisplayNamePlural

User-facing plural name.

string
nullable
Description

Optional entity description.

string
nullable
CommentsEnabled

Whether comments are enabled.

boolean
AttachmentsEnabled

Whether attachments are enabled.

boolean
TagsEnabled

Whether tags are enabled.

boolean
AuditTrailEnabled

Whether audit trail is enabled.

boolean
AuditTrailRetentionMode
integer format: int32
Allowed values: 0 1 2
AuditTrailRetentionDays

Retention days when mode is days-based.

integer format: int32
nullable
NumberPrefix

Configured number prefix.

string
nullable
IsReadOnly

Whether runtime writes are blocked for this entity.

boolean
DisabledOperations
integer format: int32
Allowed values: 0 1 2 4 8 16 32 64 128
IsPendingDeletion

Whether the definition is frozen pending deletion.

boolean
DeletionRequestedAt

Timestamp when deferred deletion was requested.

string format: date-time
nullable
PurgeAfterUtc

Scheduled purge timestamp.

string format: date-time
nullable
Tables

Definition tables.

Array<object>
nullable

Metadata for one physical table used by an entity definition.

object
Id

Table metadata identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
Name

Logical table name.

string
nullable
SchemaName

Database schema name.

string
nullable
PhysicalTableName

Physical table name.

string
nullable
IsPrimary

Whether this is the primary entity table.

boolean
OwnerFieldId

Owner field identifier for child tables.

string
nullable
Fields

Fields that belong to the table.

Array<object>
nullable

Metadata for one entity field definition.

object
Id

Field identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
EntityDefinitionTableId

Entity definition table identifier.

string
nullable
Key

Field key.

string
nullable
DisplayName

Field display name.

string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
VisibleWhen

Visibility condition expression.

string
nullable
RequiredWhen

Requiredness condition expression.

string
nullable
BusinessRequiredWhen

Package-owned business requiredness condition expression.

string
nullable
EditableWhen

Editability condition expression.

string
nullable
IsReadOnly

Whether runtime writes should skip this field.

boolean
DecimalPrecision

Decimal precision when applicable.

integer format: int32
nullable
DecimalScale

Decimal scale when applicable.

integer format: int32
nullable
StringMaxLength

String max length when applicable.

integer format: int32
nullable
AllowMultiple

Whether multiple values are allowed.

boolean
ReferenceToEntityDefinitionId

Target entity definition identifier for reference-style fields.

string
nullable
PairedReferenceFieldId

Paired reference field identifier for inverse reference fields.

string
nullable
AllowSort

Whether root-list sorting by linked display value is allowed.

boolean
ReferenceDeleteBehavior
integer format: int32
Allowed values: 0 1 2
SortOrder

Sort order inside the owning table.

integer format: int32
Options

Select options when applicable.

Array<object>
nullable

Option metadata for select fields.

object
Id

Option identifier.

string
nullable
EntityFieldDefinitionId

Owning field identifier.

string
nullable
Key

Option key.

string
nullable
Value

Option display value.

string
nullable
SortOrder

Sort order.

integer format: int32
ChildTableId

Child table metadata identifier for table fields.

string
nullable
IsDeleted

Whether the field is soft-deleted.

boolean
DeletedAt

Deletion timestamp.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
AddressCoordinatesRequired

Whether address values must carry latitude and longitude.

boolean
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
Metadata

Owner-scoped metadata attached to this field.

Array<object>
nullable

Owner-scoped metadata attached to one entity field definition.

object
Id

Metadata row identifier.

string
nullable
EntityFieldDefinitionId

Owning field identifier.

string
nullable
OwnerModuleKey

Module that owns this metadata key.

string
nullable
Key

Metadata key inside the owner module.

string
nullable
ValueJson

Metadata value as JSON.

object
RowVersion

Concurrency token.

string format: uuid
SystemRole
integer format: int32
Allowed values: 0 1 2 3 4 5 6
VisibleWhenOperationMode
integer format: int32
Allowed values: 0 1 2
RequiredWhenOperationMode
integer format: int32
Allowed values: 0 1 2
EditableWhenOperationMode
integer format: int32
Allowed values: 0 1 2
BaseCurrencyCode

Base currency code for Money fields.

string
nullable
CalculationExpression

Stored calculated-field expression.

string
nullable
CalculationKind
integer format: int32
Allowed values: 0 1
ReferenceArchiveBehavior
integer format: int32
Allowed values: 0 1
ReferenceAuditRollupBehavior
integer format: int32
Allowed values: 0 1
SemanticRole
integer format: int32
Allowed values: 0 1 2 3
SemanticRoleScopeFieldId

Field identifier used as semantic scope, when the selected role requires one.

string
nullable
ClassifierCatalogDefinitionId

Bound Classifier Catalog Definition identifier.

string
nullable
ClassifierCatalogKey

Stable key of the bound Classifier Catalog Definition.

string
nullable
ClassifierCatalogDisplayName

Display name of the bound Classifier Catalog Definition.

string
nullable
DefaultValue

Configured default applied to an absent primary field on create or an absent child field in a new table row. It does not change existing rows.

object
Kind
integer format: int32
Allowed values: 0 1 2
Value

Canonical constant JSON value. A scalar Reference contains only the target entity-instance id string. Null for dynamic defaults.

object
IsProtected

Whether the field’s system-owned structural shape is protected while administrator-owned metadata remains editable.

boolean
IsDeleted

Whether the table metadata is soft-deleted.

boolean
DeletedAt

Deletion timestamp.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
UniqueConstraints

Configured unique constraints.

Array<object>
nullable

Unique constraint configured for one entity definition table.

object
Id

Constraint identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Fields

Ordered participating fields.

Array<object>
nullable

Field entry participating in an entity unique constraint.

object
Id

Field identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Key

Field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
RowVersion

Concurrency token.

string format: uuid
Indexes

Configured non-unique indexes.

Array<object>
nullable

Non-unique index configured for one entity definition table.

object
Id

Index identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Fields

Ordered participating fields.

Array<object>
nullable

Field participating in one definition index.

object
Id

Field identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Key

Internal field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
RowVersion

Concurrency token.

string format: uuid
Statements

Configured entity statements.

Array<object>
nullable

Administrative entity statement definition.

object
Id

Statement identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Name

Stable technical statement key.

string
nullable
DisplayName

User-facing statement label.

string
nullable
Expression

Stored SQL-like statement expression.

string
nullable
ExposeInClient

Whether runtime payloads expose this statement as a predicate flag.

boolean
SortOrder

Statement ordering inside the entity definition.

integer format: int32
IsDeleted

Whether the statement is soft-deleted.

boolean
DeletedAt

Soft-delete timestamp when deleted.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
ValidationRules

Configured entity validation rules.

Array<object>
nullable

Administrative entity validation rule definition.

object
Id

Validation rule identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Name

Stable technical validation rule key.

string
nullable
DisplayName

User-facing validation rule label.

string
nullable
Expression

Validation expression.

string
nullable
Message

User-facing validation failure message.

string
nullable
MessageTranslations

Optional localized validation failure message templates keyed by locale.

object
key
additional properties
string
Enabled

Whether this validation rule is active.

boolean
SortOrder

Validation rule ordering inside the entity definition.

integer format: int32
IsDeleted

Whether the validation rule is soft-deleted.

boolean
DeletedAt

Soft-delete timestamp when deleted.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
PresentationRules

Configured entity presentation rules.

Array<object>
nullable

Metadata for one entity presentation rule.

object
Id

Presentation rule identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Target
integer format: int32
Allowed values: 0 1
Template

Stored render template; optionLabel(SelectPath) renders a configured Select option caption.

string
nullable
Condition

Stored rule condition expression.

string
nullable
SortOrder

Stable ordering inside one presentation slot.

integer format: int32
IsDeleted

Whether the rule is soft-deleted.

boolean
DeletedAt

Soft-delete timestamp when deleted.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
RowVersion

Concurrency token.

string format: uuid
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root id when package-owned.

string
nullable
SourcePackageId

NET package artifact id when package-owned.

string
nullable
SourceStableId

Stable Moltaro id when package-owned.

string
nullable
UsageType
integer format: int32
Allowed values: 0 1 2
OwnerModuleKey

Owning module key when the usage type is Part.

string
nullable
OwnerAggregateType

Owning aggregate type when the usage type is Part.

string
nullable
OwnerAggregateId

Owning aggregate identifier when the usage type is Part.

string
nullable
AssociationBinding

Association endpoint and generated inverse binding metadata.

object
Id

Binding identifier.

string
nullable
EntityDefinitionId

Association entity definition identifier.

string
nullable
LeftEndpointEntityDefinitionId

Left endpoint target entity definition identifier.

string
nullable
RightEndpointEntityDefinitionId

Right endpoint target entity definition identifier.

string
nullable
LeftEndpointFieldId

Left required reference field on the association entity.

string
nullable
RightEndpointFieldId

Right required reference field on the association entity.

string
nullable
LeftInverseFieldId

Generated inverse field on the left endpoint entity.

string
nullable
RightInverseFieldId

Generated inverse field on the right endpoint entity.

string
nullable
Projection

Projection-entity configuration for one entity definition.

object
Id

Projection configuration identifier.

string
nullable
EntityDefinitionId

Projection entity definition identifier.

string
nullable
ProjectionKind
integer format: int32
Allowed values: 0
IsEnabled

Whether projection synchronization is active.

boolean
OpenBehavior
integer format: int32
Allowed values: 0
Members

Configured source members, one per member reference field.

Array<object>
nullable

Projection-entity source member configuration.

object
Id

Member identifier.

string
nullable
ProjectionDefinitionId

Owning projection configuration identifier.

string
nullable
ReferenceFieldId

Projection-managed reference field that links projection rows to source rows.

string
nullable
ReferenceFieldKey

Key of the member reference field.

string
nullable
ReferenceFieldDisplayName

Display name of the member reference field.

string
nullable
SourceEntityDefinitionId

Source entity definition identifier.

string
nullable
SourceEntityDefinitionName

Internal name of the source entity definition.

string
nullable
SourceEntityDefinitionDisplayName

Display name of the source entity definition.

string
nullable
MemberKey

Stable technical key of the member.

string
nullable
DisplayName

Administrative display name of the member.

string
nullable
SortOrder

Member order in administrative lists.

integer format: int32
IsEnabled

Whether rows of this source participate in synchronization.

boolean
RowVersion

Concurrency token.

string format: uuid
Mappings

Configured field mappings across all members.

Array<object>
nullable

Projection-entity field mapping rule.

object
Id

Mapping identifier.

string
nullable
ProjectionDefinitionId

Owning projection configuration identifier.

string
nullable
ProjectionMemberId

Member this mapping belongs to.

string
nullable
ReferenceFieldId

Reference field of the owning member.

string
nullable
TargetKind
integer format: int32
Allowed values: 0 1 2
TargetFieldId

Target projection field identifier when the target kind is Field.

string
nullable
TargetFieldKey

Key of the target projection field when the target kind is Field.

string
nullable
TargetFieldDisplayName

Display name of the target projection field when the target kind is Field.

string
nullable
SourcePath

Field-key path from the source row as ordered segments.

Array<string>
nullable
TransformKind
integer format: int32
Allowed values: 0
TransformSettingsJson

Reserved transform settings; not read by the Copy transform.

string
nullable
SortOrder

Mapping order within the member.

integer format: int32
RowVersion

Concurrency token.

string format: uuid
RowVersion

Concurrency token for the projection configuration.

string format: uuid
IsSystemDefined

Whether the platform owns this definition. It cannot be deleted or renamed, and its protected fields cannot be changed.

boolean
SystemKey

Stable platform key when the definition is system-defined.

string
nullable
SearchMaxPathDepth

Maximum configured relation transitions accepted for a search target.

integer format: int32
SearchMaxTargetsPerDefinition

Maximum number of explicit runtime search targets accepted for this definition.

integer format: int32
SearchTargets

Explicit runtime search targets.

Array<object>
nullable

Configured entity search target with resolved path metadata.

object
Id
string
nullable
Path
Array<object>
nullable

Resolved segment of a configured entity search target.

object
EntityDefinitionId
string
nullable
FieldId
string
nullable
FieldKey
string
nullable
DisplayName
string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SystemTarget
integer format: int32
Allowed values: 0 1 2 3
DefaultSort

Entity-level default runtime sort sequence.

Array<object>
nullable

Entity-level default runtime sort item.

object
Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object
Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>
nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string
nullable
FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string
nullable
Special
integer format: int32
Allowed values: 0 1
StatementId

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Direction
integer format: int32
Allowed values: 0 1
SortOrder

Default sort order.

integer format: int32
DisplayFields

Read-time display fields available to table and card surfaces.

Array<object>
nullable

Read-time display field metadata.

object
Id
string
nullable
EntityDefinitionId
string
nullable
Key
string
nullable
DisplayName
string
nullable
Rules
Array<object>
nullable

One ordered rule for a read-time display field. Templates support optionLabel(SelectPath) for configured Select option captions.

object
Id
string
nullable
EntityDisplayFieldId
string
nullable
Template
string
nullable
Condition
string
nullable
SortOrder
integer format: int32
IsDeleted
boolean
DeletedAt
string format: date-time
nullable
RowVersion
string format: uuid
SortOrder
integer format: int32
IsDeleted
boolean
DeletedAt
string format: date-time
nullable
RowVersion
string format: uuid
ObjectContextFacts

ID-only object-context facts materialized onto entity-instance read models.

Array<object>
nullable

Object-context fact configuration for one entity definition.

object
Id
string
nullable
Key
string
nullable
ProviderKey
string
nullable
Target
object
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
ResourceObjectId
string
nullable
SortOrder
integer format: int32
RowVersion
string format: uuid
ModuleEntityRoles

Built-in module roles assigned to this system Entity Definition.

Array<object>
nullable

Public module-role identity projected with Entity Definition metadata.

object
ModuleKey
string
nullable
RoleKey
string
nullable
ManualOrder

Admin-facing Manual Order capability metadata without protected rank storage details.

object
Id
string
nullable
EntityDefinitionId
string
nullable
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId
string
nullable
SourcePackageId
string
nullable
SourceStableId
string
nullable
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"AuditTrailRetentionMode": 0,
"DisabledOperations": 0,
"Tables": [
{
"Fields": [
{
"FieldType": 0,
"ReferenceDeleteBehavior": 0,
"SchemaSource": 0,
"SystemRole": 0,
"VisibleWhenOperationMode": 0,
"RequiredWhenOperationMode": 0,
"EditableWhenOperationMode": 0,
"CalculationKind": 0,
"ReferenceArchiveBehavior": 0,
"ReferenceAuditRollupBehavior": 0,
"SemanticRole": 0,
"DefaultValue": {
"Kind": 0
}
}
],
"SchemaSource": 0
}
],
"Statements": [
{
"SchemaSource": 0
}
],
"ValidationRules": [
{
"SchemaSource": 0
}
],
"PresentationRules": [
{
"Target": 0,
"SchemaSource": 0
}
],
"SchemaSource": 0,
"UsageType": 0,
"Projection": {
"ProjectionKind": 0,
"OpenBehavior": 0,
"Mappings": [
{
"TargetKind": 0,
"TransformKind": 0
}
]
},
"SearchTargets": [
{
"Path": [
{
"FieldType": 0,
"SystemTarget": 0
}
]
}
],
"DefaultSort": [
{
"Target": {
"Path": [
{
"Special": 0
}
]
},
"Direction": 0
}
],
"ManualOrder": {
"SchemaSource": 0
}
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}