Skip to content

Delete the explicit form surface configuration for one form surface.

DELETE
/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/form-surfaces/{surfaceKey}/configuration
curl --request DELETE \
--url https://example.com/api/workspace/admin/entity-definitions/example/ui/form-surfaces/example/configuration \
--header 'Authorization: Bearer <token>'
entityDefinitionId
required
string
surfaceKey
required
string
access_token
string

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

OK

Media typeapplication/json
object
Data

Admin-facing form surface configuration.

object
Meta

Minimal runtime entity metadata used by explicit UI surfaces.

object
EntityDefinitionId

Entity definition identifier.

string
nullable
Name

Internal entity key used by runtime routes.

string
nullable
DisplayNameSingular

User-facing singular name.

string
nullable
DisplayNamePlural

User-facing plural name.

string
nullable
CommentsEnabled

Whether entity comments are enabled.

boolean
AttachmentsEnabled

Whether entity attachments are enabled.

boolean
TagsEnabled

Whether entity tags are enabled.

boolean
FullTextSearchAvailable

Whether runtime configured search is available for the definition.

boolean
Statements

Runtime-exposed statements for this entity.

Array<object>
nullable

Runtime statement descriptor exposed to clients together with predicate payloads.

object
Id

Statement identifier.

string
nullable
Name

Stable technical statement key.

string
nullable
DisplayName

User-facing statement label.

string
nullable
RuleEvaluationContext

Rule evaluation context shared with fast UI runtime evaluation.

object
CurrentUserId

Current workspace user identifier.

string
nullable
CurrentLocalDate

Workspace-local current date in ISO format.

string
nullable
TimeZone

Workspace time zone identifier.

string
nullable
GeneratedAtUtc

UTC instant when the context was generated.

string format: date-time
nullable
NextLocalMidnightUtc

UTC instant for the next midnight in the workspace time zone.

string format: date-time
nullable
ContextValues

Owner-scoped runtime values available to rule plans.

object
key
additional properties
IsProjection

Whether the entity is an enabled Projection Entity.

boolean
UsageType
integer format: int32
Allowed values: 0 1 2
SemanticType

Data specialization key; null for Part and Association.

string
nullable
SemanticPresentations

Explicit presentation registrations; missing bindings must not select a generic fallback.

Array<object>
nullable

Explicit standard-host or specialized component registration for one slot.

object
Slot

An Entity object presentation slot, distinct from field editors and renderers.

integer format: int32
Allowed values: 0 1 2 3 4 5 6
RegistrationKey
string
nullable
SurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
SurfaceId

Persisted form surface identifier.

string
nullable
Name

Custom form surface name.

string
nullable
Key

Custom form surface key.

string
nullable
IsDefault

Whether this form surface is the current default form.

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

Stable NET package root id when this form surface is package-owned.

string
nullable
SourcePackageId

NET package artifact id when this form surface is package-owned.

string
nullable
SourceStableId

Stable package surface id when this form surface is package-owned.

string
nullable
MaxWidth

Maximum layout width in pixels.

integer format: int32
nullable
ColumnCount

Desktop column count.

integer format: int32
nullable
Items

Configured form items.

Array<object>
nullable

One form item.

object
Id

Stable item identifier.

string
nullable
ItemType
integer format: int32
Allowed values: 0 1 2 3 4
SortOrder

Display order.

integer format: int32
Column

Preferred desktop column.

integer format: int32
Label

Optional overridden label.

string
nullable
Hint

Optional hint text.

string
nullable
Binding

Resolved binding metadata for one UI field reference.

object
RefKind
integer format: int32
Allowed values: 0 1 2 3 4
FieldId

Field identifier when the binding points to an entity field.

string
nullable
FieldKey

Runtime field key when the binding points to an entity field.

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

Whether the bound field is always required.

boolean
VisibleWhen

Visibility condition expression for draft-aware UI evaluation.

string
nullable
RequiredWhen

Requiredness condition expression for draft-aware UI evaluation.

string
nullable
EditableWhen

Editability condition expression for draft-aware UI evaluation.

string
nullable
VisibleWhenPlan

Compiled rule expression plan used by Moltaro runtime surfaces.

object
RuleEngineVersion

Stable rule engine version used to compile this plan.

string
nullable
Root

Compiled rule expression node.

object
Kind

Node kind, for example literal, path, eq, and, or.

string
nullable
Operator

Optional operator metadata.

string
nullable
Path

Field path for path nodes.

string
nullable
LiteralKind

Literal family for literal nodes.

string
nullable
Text

Text value or variable name.

string
nullable
Number

Numeric literal value, serialized as an invariant string to preserve decimal precision.

number format: double
nullable
Bool

Boolean literal value.

boolean
nullable
OffsetDays

Date variable day offset.

integer format: int32
nullable
Left
object recursive
Right
object recursive
Items
Array<object> recursive
ResultFamily

Typed result family resolved by the backend binder.

string
nullable
SourceFamily

Backend source family for lookup-like or complex fields.

string
nullable
ResolvedPath

Canonical field path resolved by the backend binder.

string
nullable
RequiredWhenPlan

Compiled rule expression plan used by Moltaro runtime surfaces.

object
RuleEngineVersion

Stable rule engine version used to compile this plan.

string
nullable
Root

Compiled rule expression node.

object
Kind

Node kind, for example literal, path, eq, and, or.

string
nullable
Operator

Optional operator metadata.

string
nullable
Path

Field path for path nodes.

string
nullable
LiteralKind

Literal family for literal nodes.

string
nullable
Text

Text value or variable name.

string
nullable
Number

Numeric literal value, serialized as an invariant string to preserve decimal precision.

number format: double
nullable
Bool

Boolean literal value.

boolean
nullable
OffsetDays

Date variable day offset.

integer format: int32
nullable
Left
object recursive
Right
object recursive
Items
Array<object> recursive
ResultFamily

Typed result family resolved by the backend binder.

string
nullable
SourceFamily

Backend source family for lookup-like or complex fields.

string
nullable
ResolvedPath

Canonical field path resolved by the backend binder.

string
nullable
EditableWhenPlan

Compiled rule expression plan used by Moltaro runtime surfaces.

object
RuleEngineVersion

Stable rule engine version used to compile this plan.

string
nullable
Root

Compiled rule expression node.

object
Kind

Node kind, for example literal, path, eq, and, or.

string
nullable
Operator

Optional operator metadata.

string
nullable
Path

Field path for path nodes.

string
nullable
LiteralKind

Literal family for literal nodes.

string
nullable
Text

Text value or variable name.

string
nullable
Number

Numeric literal value, serialized as an invariant string to preserve decimal precision.

number format: double
nullable
Bool

Boolean literal value.

boolean
nullable
OffsetDays

Date variable day offset.

integer format: int32
nullable
Left
object recursive
Right
object recursive
Items
Array<object> recursive
ResultFamily

Typed result family resolved by the backend binder.

string
nullable
SourceFamily

Backend source family for lookup-like or complex fields.

string
nullable
ResolvedPath

Canonical field path resolved by the backend binder.

string
nullable
AllowMultiple

Whether the bound field allows multiple values.

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
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
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
TableFields

Access-shaped child-table fields when the binding targets a table field.

Array<object>
nullable

One access-shaped child-table field for runtime UI rendering.

object
Id

Child field identifier.

string
nullable
Label

Display label for the child field.

string
nullable
Binding
object recursive
Editor
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10
Editable

Whether the caller may edit this child field.

boolean
ReferenceInputType
integer format: int32
Allowed values: 0 1 2 3
ReferenceRendererType
integer format: int32
Allowed values: 0 1
ReferenceLookupRenderType
integer format: int32
Allowed values: 0 1
ReferencePath

Reference path configured for breadcrumb rendering.

Array<string>
nullable
HasAccessibleChildFields

Whether the caller can access at least one child-table field.

boolean
HasNestedAccessibleTableFields

Whether the caller can access nested table child fields.

boolean
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
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.

nullable
ResponsibilityKey

Stable key when the binding targets a unified responsibility.

string
nullable
ResponsibilityDisplayName

Display name when the binding targets a unified responsibility.

string
nullable
DisplayFieldId

Display field identifier when the binding targets a display-only computed field.

string
nullable
DisplayFieldKey

Display field key when the binding targets a display-only computed field.

string
nullable
DisplayFieldDisplayName

Display field display name when the binding targets a display-only computed field.

string
nullable
ObjectContextFactId

Object-context fact configuration id when the binding targets a contextual fact.

string
nullable
ObjectContextFactDisplayName

Safe source display name from the actor-shaped provider catalog.

string
nullable
ObjectContextFactMemberKey

Stable member key; null selects the existing whole-fact presentation.

string
nullable
ObjectContextFactMember

Provider-owned member metadata. A source field retains its existing Entity metadata and stable identity; system members use a provider-owned key. An editor key identifies a registered domain editor, not a setter.

object
MemberKey
string
nullable
DisplayName
string
nullable
ValueType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
Nullable
boolean
Capabilities

Explicit capabilities; absence of a capability never selects a fallback mutation.

object
Read
boolean
Create
boolean
Edit
boolean
InlineEdit
boolean
EditorKey
string
nullable
SourceField

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.

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.

nullable
IsProtected

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

boolean
EditorConfiguration

Opaque configuration interpreted only by the registered domain editor.

nullable
PortabilityKey

Provider-owned stable YAML identity when the runtime member key contains workspace-local identifiers.

string
nullable
ObjectContextFactProviderKey

Provider key that owns the object-context fact payload.

string
nullable
ObjectContextFactTarget

Stable identity of one Moltaro resource instance.

object
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
ResourceObjectId
string
nullable
AddressCoordinatesRequired

Whether an address field must be captured through a coordinate-aware editor.

boolean
ClassifierCatalogDefinitionId

Bound Classifier Catalog Definition identifier.

string
nullable
ClassifierCatalogKey

Bound Classifier Catalog Definition key.

string
nullable
ClassifierCatalogDisplayName

Bound Classifier Catalog Definition display name.

string
nullable
SemanticRole
integer format: int32
Allowed values: 0 1 2 3
EntityDefinitionId

Owning entity definition identifier used by destination-scoped field capabilities.

string
nullable
EntityDefinitionTableId

Owning entity definition table identifier used by destination-scoped field capabilities.

string
nullable
Editor
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10
Editable

Whether field editing is enabled.

boolean
EditorRows

Configured row count for textarea-style editors.

integer format: int32
nullable
TextBlockStyle
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8
TextBlockText

Text-block content when the item is a text block.

string
nullable
AlertTone
integer format: int32
Allowed values: 0 1 2 3
AlertTitle

Optional alert title.

string
nullable
AlertText

Alert body.

string
nullable
MarginTop

Optional top margin in pixels.

integer format: int32
nullable
MarginBottom

Optional bottom margin in pixels.

integer format: int32
nullable
PaddingTop

Optional top padding in pixels.

integer format: int32
nullable
PaddingBottom

Optional bottom padding in pixels.

integer format: int32
nullable
PaddingLeft

Optional left padding in pixels.

integer format: int32
nullable
PaddingRight

Optional right padding in pixels.

integer format: int32
nullable
Visible

Whether the item remains visible in the effective runtime model.

boolean
ColumnSpan

Desktop column span.

integer format: int32
DatePickerAnchorMode
integer format: int32
Allowed values: 0 1 2
DatePickerAnchorValue

Fixed year or relative year offset selected by Moltaro.Entity.Ui.Models.Form.EntityFormUiItemModel.DatePickerAnchorMode.

integer format: int32
nullable
ReferenceInputType
integer format: int32
Allowed values: 0 1 2 3
ReferenceRendererType
integer format: int32
Allowed values: 0 1
ReferenceLookupRenderType
integer format: int32
Allowed values: 0 1
ReferencePath

Reference path configured for breadcrumb rendering.

Array<string>
nullable
HierarchySourceKind
integer format: int32
Allowed values: 0 1
ReferenceHierarchy

Saved relationship shape for one hierarchy reference input.

object
SourceKind
integer format: int32
Allowed values: 0 1
ParentFieldDefinitionId

Recursive parent field identifier, or null for explicit-path mode.

string
nullable
ParentFieldKey

Recursive parent stable field key used by portable configuration.

string
nullable
LookupTableSelectors

Role-aware table selectors for lookup dialogs.

Array<object>
nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object
Id

Persisted selector row id. New client rows may send null.

string
nullable
Priority

Higher values are evaluated first.

integer format: int32
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string
nullable
RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>
nullable
CreateFormSelector

Selector for resolving an entity UI surface by default pointer or custom key.

object
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey
string
nullable
CreateFormSelectors

Role-aware create-form overrides used by admin authoring; an empty list inherits from the lookup table.

Array<object>
nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object
Id

Persisted selector row id. New client rows may send null.

string
nullable
Priority

Higher values are evaluated first.

integer format: int32
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string
nullable
RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>
nullable
ShowRelatedTableSaveNotice

Show the independent-save notice for a RelatedTable item; enabled by default.

boolean
RelatedTableSelector

Selector for resolving an entity UI surface by default pointer or custom key.

object
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey
string
nullable
RelatedTableSelectors

Role-aware child table surface selectors used by related-table admin authoring.

Array<object>
nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object
Id

Persisted selector row id. New client rows may send null.

string
nullable
Priority

Higher values are evaluated first.

integer format: int32
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string
nullable
RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>
nullable
RelatedSaveMode
required
integer format: int32
Allowed values: 0 1
RelatedPresentation
integer format: int32
Allowed values: 0 1
RelatedVisibleWhen

Field Behavior DSL condition over the parent Form draft that shows a WithParent section; null always shows it.

string
nullable
RelatedRequiredWhen

Field Behavior DSL condition over the parent Form draft that requires an active child record; null never does.

string
nullable
RelatedHiddenPolicy
integer format: int32
Allowed values: 0 1 2
RelatedFormSelectors

Role-aware child Form surface selectors of a WithParent item used by admin authoring; null reads as empty.

Array<object>
nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object
Id

Persisted selector row id. New client rows may send null.

string
nullable
Priority

Higher values are evaluated first.

integer format: int32
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string
nullable
RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>
nullable
RelatedVisibleWhenPlan

Compiled rule expression plan used by Moltaro runtime surfaces.

object
RuleEngineVersion

Stable rule engine version used to compile this plan.

string
nullable
Root

Compiled rule expression node.

object
Kind

Node kind, for example literal, path, eq, and, or.

string
nullable
Operator

Optional operator metadata.

string
nullable
Path

Field path for path nodes.

string
nullable
LiteralKind

Literal family for literal nodes.

string
nullable
Text

Text value or variable name.

string
nullable
Number

Numeric literal value, serialized as an invariant string to preserve decimal precision.

number format: double
nullable
Bool

Boolean literal value.

boolean
nullable
OffsetDays

Date variable day offset.

integer format: int32
nullable
Left
object recursive
Right
object recursive
Items
Array<object> recursive
ResultFamily

Typed result family resolved by the backend binder.

string
nullable
SourceFamily

Backend source family for lookup-like or complex fields.

string
nullable
ResolvedPath

Canonical field path resolved by the backend binder.

string
nullable
RelatedRequiredWhenPlan

Compiled rule expression plan used by Moltaro runtime surfaces.

object
RuleEngineVersion

Stable rule engine version used to compile this plan.

string
nullable
Root

Compiled rule expression node.

object
Kind

Node kind, for example literal, path, eq, and, or.

string
nullable
Operator

Optional operator metadata.

string
nullable
Path

Field path for path nodes.

string
nullable
LiteralKind

Literal family for literal nodes.

string
nullable
Text

Text value or variable name.

string
nullable
Number

Numeric literal value, serialized as an invariant string to preserve decimal precision.

number format: double
nullable
Bool

Boolean literal value.

boolean
nullable
OffsetDays

Date variable day offset.

integer format: int32
nullable
Left
object recursive
Right
object recursive
Items
Array<object> recursive
ResultFamily

Typed result family resolved by the backend binder.

string
nullable
SourceFamily

Backend source family for lookup-like or complex fields.

string
nullable
ResolvedPath

Canonical field path resolved by the backend binder.

string
nullable
RelatedChild

The child side of a WithParent related-table item for the current actor. The server sets the child Reference to the parent on save; a client names it only to leave it out of child values.

object
EntityDefinitionId

Child Entity definition identifier.

string
nullable
DisplayNameSingular

Child definition singular display name.

string
nullable
DisplayNamePlural

Child definition plural display name.

string
nullable
Cardinality

Cardinality of a WithParent relation as proven by metadata.

integer format: int32
Allowed values: 0 1
SingleChildScope
integer format: int32
Allowed values: 1 2
Capabilities

Potential rights of the current actor on child records of a WithParent item; final checks run in SQL at save.

object
View

The actor can read child records of the definition.

boolean
Create

The actor can potentially create child records.

boolean
Update

The actor can potentially update child records.

boolean
Archive

The actor can potentially archive child records.

boolean
Delete

The actor can potentially delete archived child records.

boolean
Form

The resolved child Form of a WithParent item.

object
State

Availability of the child Form surface of a WithParent item for the current actor.

integer format: int32
Allowed values: 0 1 2
FormSurfaceId

Resolved child Form surface identifier when State is Ready.

string
nullable
FormSurfaceKey

Resolved child Form surface key when State is Ready.

string
nullable
RowVersion

Row version of the resolved child Form surface.

string format: uuid
nullable
ParentReferenceFieldKey

Key of the child Reference to the parent, which a child value never carries.

string
nullable
SectionItemId
required

The item that owns the one child draft of this relation: the first WithParent item of the same relation in Form order. Every WithParent item of the relation names it (always present, never null); a client stages each child change once under it, and a Form submission names it as Sections[].ItemId.

string
PreauthorizationParentFieldKeys
required

The keys of the parent field items of this Form whose values the pre-authorization of a new child reads: a File-field upload (ParentContext) and a Markdown attachment scope (ProviderContextJson) of a new child. They are the fields the child’s Create, Attachments:Create and Field:CreateWrite rights read one hop away through the parent Reference, and the fields the parent’s own Create and Field:CreateWrite rights read for an unsaved parent; every parent field item when such a right reads a parent field the parent Form computes. Send exactly these keys in ParentContext.ParentFields, each with its full value; the server refuses a context over its limit with moltaro.ui.form.parentContext.tooLarge instead of shortening it. Empty when no such right reads the parent; never null.

Array<string>
ReferenceEligibility

Non-executable dependency metadata for one Reference field.

object
TargetFieldId

Dependent scalar Reference field identifier.

string
nullable
DriverFieldIds

Direct source-field identifiers required to build selection context.

Array<string>
nullable
Enabled

Whether the persisted rule currently participates in runtime selection and mutation.

boolean
ReferenceContext

Actor-shaped Form context required by one scalar Reference field.

object
TargetFieldId

Reference field identifier represented by the Form item.

string
nullable
CurrentValueInputs

Explicit allow-lists for client-owned Form Reference context values.

object
CreateDraftFieldIds

Fields whose user-owned, currently editable create-draft values may be sent. A possible mutation-effect target remains listed because ownership is draft-specific.

Array<string>
nullable
UpdateDraftFieldIds

Fields whose editable update-draft values may be sent.

Array<string>
nullable
LockedCreateFieldIds

Fields whose server-owned related-create locks may be sent.

Array<string>
nullable
ProjectedTargetFieldIds

Target scalar or Money owner field identifiers required by one-hop Form field behavior plans.

Array<string>
nullable
RequiresTargetValues

Whether the Form must materialize the referenced target for system, scalar, or Money target values.

boolean
WorkspaceUiComponentKey

Registered Workspace UI component key for a WorkspaceUiComponent item; null for other item types.

string
nullable
WorkspaceUiComponentBindings

Declared-binding-name → field mappings of a WorkspaceUiComponent item. The runtime model carries only bindings the actor may at least read, each with its shaped Moltaro.Entity.Ui.Models.Form.EntityFormUiWorkspaceUiComponentBindingModel.Access.

Array<object>
nullable

One mapped binding of a Workspace UI form component item: the binding name the component declared and the primary-table field Constructor mapped it to. Runtime shaping adds the resolved field key, field type and the actor-shaped access; the admin document carries the name and field id only.

object
Name

Binding name declared by the component (lowercase kebab-case).

string
nullable
FieldId

Mapped primary-table field identifier.

string
nullable
FieldKey

Resolved field key; null in the admin document.

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
Access
integer format: int32
Allowed values: 0 1
Optional

Whether the component declared the binding optional; null in the admin document.

boolean
nullable
Required

Whether the mapped field is required by the definition; null in the admin document.

boolean
nullable
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": {
"Meta": {
"UsageType": 0,
"SemanticPresentations": [
{
"Slot": 0
}
]
},
"SurfaceType": 0,
"Source": 0,
"Items": [
{
"ItemType": 0,
"Binding": {
"RefKind": 0,
"SystemField": 0,
"FieldType": 0,
"ReferenceDeleteBehavior": 0,
"TableFields": [
{
"Editor": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0
}
],
"VisibleWhenOperationMode": 0,
"RequiredWhenOperationMode": 0,
"EditableWhenOperationMode": 0,
"DefaultValue": {
"Kind": 0
},
"ObjectContextFactMember": {
"ValueType": 0,
"SourceField": {
"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
}
}
},
"SemanticRole": 0
},
"Editor": 0,
"TextBlockStyle": 0,
"AlertTone": 0,
"DatePickerAnchorMode": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0,
"HierarchySourceKind": 0,
"ReferenceHierarchy": {
"SourceKind": 0
},
"LookupTableSelectors": [
{
"Mode": 0
}
],
"CreateFormSelector": {
"Mode": 0
},
"CreateFormSelectors": [
{
"Mode": 0
}
],
"RelatedTableSelector": {
"Mode": 0
},
"RelatedTableSelectors": [
{
"Mode": 0
}
],
"RelatedSaveMode": 0,
"RelatedPresentation": 0,
"RelatedHiddenPolicy": 0,
"RelatedFormSelectors": [
{
"Mode": 0
}
],
"RelatedChild": {
"Cardinality": 0,
"SingleChildScope": 1,
"Form": {
"State": 0
}
},
"WorkspaceUiComponentBindings": [
{
"FieldType": 0,
"Access": 0
}
]
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data

Admin-facing form surface configuration.

object
Meta

Minimal runtime entity metadata used by explicit UI surfaces.

object
EntityDefinitionId

Entity definition identifier.

string
nullable
Name

Internal entity key used by runtime routes.

string
nullable
DisplayNameSingular

User-facing singular name.

string
nullable
DisplayNamePlural

User-facing plural name.

string
nullable
CommentsEnabled

Whether entity comments are enabled.

boolean
AttachmentsEnabled

Whether entity attachments are enabled.

boolean
TagsEnabled

Whether entity tags are enabled.

boolean
FullTextSearchAvailable

Whether runtime configured search is available for the definition.

boolean
Statements

Runtime-exposed statements for this entity.

Array<object>
nullable

Runtime statement descriptor exposed to clients together with predicate payloads.

object
Id

Statement identifier.

string
nullable
Name

Stable technical statement key.

string
nullable
DisplayName

User-facing statement label.

string
nullable
RuleEvaluationContext

Rule evaluation context shared with fast UI runtime evaluation.

object
CurrentUserId

Current workspace user identifier.

string
nullable
CurrentLocalDate

Workspace-local current date in ISO format.

string
nullable
TimeZone

Workspace time zone identifier.

string
nullable
GeneratedAtUtc

UTC instant when the context was generated.

string format: date-time
nullable
NextLocalMidnightUtc

UTC instant for the next midnight in the workspace time zone.

string format: date-time
nullable
ContextValues

Owner-scoped runtime values available to rule plans.

object
key
additional properties
IsProjection

Whether the entity is an enabled Projection Entity.

boolean
UsageType
integer format: int32
Allowed values: 0 1 2
SemanticType

Data specialization key; null for Part and Association.

string
nullable
SemanticPresentations

Explicit presentation registrations; missing bindings must not select a generic fallback.

Array<object>
nullable

Explicit standard-host or specialized component registration for one slot.

object
Slot

An Entity object presentation slot, distinct from field editors and renderers.

integer format: int32
Allowed values: 0 1 2 3 4 5 6
RegistrationKey
string
nullable
SurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
SurfaceId

Persisted form surface identifier.

string
nullable
Name

Custom form surface name.

string
nullable
Key

Custom form surface key.

string
nullable
IsDefault

Whether this form surface is the current default form.

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

Stable NET package root id when this form surface is package-owned.

string
nullable
SourcePackageId

NET package artifact id when this form surface is package-owned.

string
nullable
SourceStableId

Stable package surface id when this form surface is package-owned.

string
nullable
MaxWidth

Maximum layout width in pixels.

integer format: int32
nullable
ColumnCount

Desktop column count.

integer format: int32
nullable
Items

Configured form items.

Array<object>
nullable

One form item.

object
Id

Stable item identifier.

string
nullable
ItemType
integer format: int32
Allowed values: 0 1 2 3 4
SortOrder

Display order.

integer format: int32
Column

Preferred desktop column.

integer format: int32
Label

Optional overridden label.

string
nullable
Hint

Optional hint text.

string
nullable
Binding

Resolved binding metadata for one UI field reference.

object
RefKind
integer format: int32
Allowed values: 0 1 2 3 4
FieldId

Field identifier when the binding points to an entity field.

string
nullable
FieldKey

Runtime field key when the binding points to an entity field.

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

Whether the bound field is always required.

boolean
VisibleWhen

Visibility condition expression for draft-aware UI evaluation.

string
nullable
RequiredWhen

Requiredness condition expression for draft-aware UI evaluation.

string
nullable
EditableWhen

Editability condition expression for draft-aware UI evaluation.

string
nullable
VisibleWhenPlan

Compiled rule expression plan used by Moltaro runtime surfaces.

object
RuleEngineVersion

Stable rule engine version used to compile this plan.

string
nullable
Root

Compiled rule expression node.

object
Kind

Node kind, for example literal, path, eq, and, or.

string
nullable
Operator

Optional operator metadata.

string
nullable
Path

Field path for path nodes.

string
nullable
LiteralKind

Literal family for literal nodes.

string
nullable
Text

Text value or variable name.

string
nullable
Number

Numeric literal value, serialized as an invariant string to preserve decimal precision.

number format: double
nullable
Bool

Boolean literal value.

boolean
nullable
OffsetDays

Date variable day offset.

integer format: int32
nullable
Left
object recursive
Right
object recursive
Items
Array<object> recursive
ResultFamily

Typed result family resolved by the backend binder.

string
nullable
SourceFamily

Backend source family for lookup-like or complex fields.

string
nullable
ResolvedPath

Canonical field path resolved by the backend binder.

string
nullable
RequiredWhenPlan

Compiled rule expression plan used by Moltaro runtime surfaces.

object
RuleEngineVersion

Stable rule engine version used to compile this plan.

string
nullable
Root

Compiled rule expression node.

object
Kind

Node kind, for example literal, path, eq, and, or.

string
nullable
Operator

Optional operator metadata.

string
nullable
Path

Field path for path nodes.

string
nullable
LiteralKind

Literal family for literal nodes.

string
nullable
Text

Text value or variable name.

string
nullable
Number

Numeric literal value, serialized as an invariant string to preserve decimal precision.

number format: double
nullable
Bool

Boolean literal value.

boolean
nullable
OffsetDays

Date variable day offset.

integer format: int32
nullable
Left
object recursive
Right
object recursive
Items
Array<object> recursive
ResultFamily

Typed result family resolved by the backend binder.

string
nullable
SourceFamily

Backend source family for lookup-like or complex fields.

string
nullable
ResolvedPath

Canonical field path resolved by the backend binder.

string
nullable
EditableWhenPlan

Compiled rule expression plan used by Moltaro runtime surfaces.

object
RuleEngineVersion

Stable rule engine version used to compile this plan.

string
nullable
Root

Compiled rule expression node.

object
Kind

Node kind, for example literal, path, eq, and, or.

string
nullable
Operator

Optional operator metadata.

string
nullable
Path

Field path for path nodes.

string
nullable
LiteralKind

Literal family for literal nodes.

string
nullable
Text

Text value or variable name.

string
nullable
Number

Numeric literal value, serialized as an invariant string to preserve decimal precision.

number format: double
nullable
Bool

Boolean literal value.

boolean
nullable
OffsetDays

Date variable day offset.

integer format: int32
nullable
Left
object recursive
Right
object recursive
Items
Array<object> recursive
ResultFamily

Typed result family resolved by the backend binder.

string
nullable
SourceFamily

Backend source family for lookup-like or complex fields.

string
nullable
ResolvedPath

Canonical field path resolved by the backend binder.

string
nullable
AllowMultiple

Whether the bound field allows multiple values.

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
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
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
TableFields

Access-shaped child-table fields when the binding targets a table field.

Array<object>
nullable

One access-shaped child-table field for runtime UI rendering.

object
Id

Child field identifier.

string
nullable
Label

Display label for the child field.

string
nullable
Binding
object recursive
Editor
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10
Editable

Whether the caller may edit this child field.

boolean
ReferenceInputType
integer format: int32
Allowed values: 0 1 2 3
ReferenceRendererType
integer format: int32
Allowed values: 0 1
ReferenceLookupRenderType
integer format: int32
Allowed values: 0 1
ReferencePath

Reference path configured for breadcrumb rendering.

Array<string>
nullable
HasAccessibleChildFields

Whether the caller can access at least one child-table field.

boolean
HasNestedAccessibleTableFields

Whether the caller can access nested table child fields.

boolean
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
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.

nullable
ResponsibilityKey

Stable key when the binding targets a unified responsibility.

string
nullable
ResponsibilityDisplayName

Display name when the binding targets a unified responsibility.

string
nullable
DisplayFieldId

Display field identifier when the binding targets a display-only computed field.

string
nullable
DisplayFieldKey

Display field key when the binding targets a display-only computed field.

string
nullable
DisplayFieldDisplayName

Display field display name when the binding targets a display-only computed field.

string
nullable
ObjectContextFactId

Object-context fact configuration id when the binding targets a contextual fact.

string
nullable
ObjectContextFactDisplayName

Safe source display name from the actor-shaped provider catalog.

string
nullable
ObjectContextFactMemberKey

Stable member key; null selects the existing whole-fact presentation.

string
nullable
ObjectContextFactMember

Provider-owned member metadata. A source field retains its existing Entity metadata and stable identity; system members use a provider-owned key. An editor key identifies a registered domain editor, not a setter.

object
MemberKey
string
nullable
DisplayName
string
nullable
ValueType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
Nullable
boolean
Capabilities

Explicit capabilities; absence of a capability never selects a fallback mutation.

object
Read
boolean
Create
boolean
Edit
boolean
InlineEdit
boolean
EditorKey
string
nullable
SourceField

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.

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.

nullable
IsProtected

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

boolean
EditorConfiguration

Opaque configuration interpreted only by the registered domain editor.

nullable
PortabilityKey

Provider-owned stable YAML identity when the runtime member key contains workspace-local identifiers.

string
nullable
ObjectContextFactProviderKey

Provider key that owns the object-context fact payload.

string
nullable
ObjectContextFactTarget

Stable identity of one Moltaro resource instance.

object
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
ResourceObjectId
string
nullable
AddressCoordinatesRequired

Whether an address field must be captured through a coordinate-aware editor.

boolean
ClassifierCatalogDefinitionId

Bound Classifier Catalog Definition identifier.

string
nullable
ClassifierCatalogKey

Bound Classifier Catalog Definition key.

string
nullable
ClassifierCatalogDisplayName

Bound Classifier Catalog Definition display name.

string
nullable
SemanticRole
integer format: int32
Allowed values: 0 1 2 3
EntityDefinitionId

Owning entity definition identifier used by destination-scoped field capabilities.

string
nullable
EntityDefinitionTableId

Owning entity definition table identifier used by destination-scoped field capabilities.

string
nullable
Editor
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10
Editable

Whether field editing is enabled.

boolean
EditorRows

Configured row count for textarea-style editors.

integer format: int32
nullable
TextBlockStyle
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8
TextBlockText

Text-block content when the item is a text block.

string
nullable
AlertTone
integer format: int32
Allowed values: 0 1 2 3
AlertTitle

Optional alert title.

string
nullable
AlertText

Alert body.

string
nullable
MarginTop

Optional top margin in pixels.

integer format: int32
nullable
MarginBottom

Optional bottom margin in pixels.

integer format: int32
nullable
PaddingTop

Optional top padding in pixels.

integer format: int32
nullable
PaddingBottom

Optional bottom padding in pixels.

integer format: int32
nullable
PaddingLeft

Optional left padding in pixels.

integer format: int32
nullable
PaddingRight

Optional right padding in pixels.

integer format: int32
nullable
Visible

Whether the item remains visible in the effective runtime model.

boolean
ColumnSpan

Desktop column span.

integer format: int32
DatePickerAnchorMode
integer format: int32
Allowed values: 0 1 2
DatePickerAnchorValue

Fixed year or relative year offset selected by Moltaro.Entity.Ui.Models.Form.EntityFormUiItemModel.DatePickerAnchorMode.

integer format: int32
nullable
ReferenceInputType
integer format: int32
Allowed values: 0 1 2 3
ReferenceRendererType
integer format: int32
Allowed values: 0 1
ReferenceLookupRenderType
integer format: int32
Allowed values: 0 1
ReferencePath

Reference path configured for breadcrumb rendering.

Array<string>
nullable
HierarchySourceKind
integer format: int32
Allowed values: 0 1
ReferenceHierarchy

Saved relationship shape for one hierarchy reference input.

object
SourceKind
integer format: int32
Allowed values: 0 1
ParentFieldDefinitionId

Recursive parent field identifier, or null for explicit-path mode.

string
nullable
ParentFieldKey

Recursive parent stable field key used by portable configuration.

string
nullable
LookupTableSelectors

Role-aware table selectors for lookup dialogs.

Array<object>
nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object
Id

Persisted selector row id. New client rows may send null.

string
nullable
Priority

Higher values are evaluated first.

integer format: int32
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string
nullable
RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>
nullable
CreateFormSelector

Selector for resolving an entity UI surface by default pointer or custom key.

object
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey
string
nullable
CreateFormSelectors

Role-aware create-form overrides used by admin authoring; an empty list inherits from the lookup table.

Array<object>
nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object
Id

Persisted selector row id. New client rows may send null.

string
nullable
Priority

Higher values are evaluated first.

integer format: int32
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string
nullable
RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>
nullable
ShowRelatedTableSaveNotice

Show the independent-save notice for a RelatedTable item; enabled by default.

boolean
RelatedTableSelector

Selector for resolving an entity UI surface by default pointer or custom key.

object
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey
string
nullable
RelatedTableSelectors

Role-aware child table surface selectors used by related-table admin authoring.

Array<object>
nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object
Id

Persisted selector row id. New client rows may send null.

string
nullable
Priority

Higher values are evaluated first.

integer format: int32
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string
nullable
RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>
nullable
RelatedSaveMode
required
integer format: int32
Allowed values: 0 1
RelatedPresentation
integer format: int32
Allowed values: 0 1
RelatedVisibleWhen

Field Behavior DSL condition over the parent Form draft that shows a WithParent section; null always shows it.

string
nullable
RelatedRequiredWhen

Field Behavior DSL condition over the parent Form draft that requires an active child record; null never does.

string
nullable
RelatedHiddenPolicy
integer format: int32
Allowed values: 0 1 2
RelatedFormSelectors

Role-aware child Form surface selectors of a WithParent item used by admin authoring; null reads as empty.

Array<object>
nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object
Id

Persisted selector row id. New client rows may send null.

string
nullable
Priority

Higher values are evaluated first.

integer format: int32
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string
nullable
RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>
nullable
RelatedVisibleWhenPlan

Compiled rule expression plan used by Moltaro runtime surfaces.

object
RuleEngineVersion

Stable rule engine version used to compile this plan.

string
nullable
Root

Compiled rule expression node.

object
Kind

Node kind, for example literal, path, eq, and, or.

string
nullable
Operator

Optional operator metadata.

string
nullable
Path

Field path for path nodes.

string
nullable
LiteralKind

Literal family for literal nodes.

string
nullable
Text

Text value or variable name.

string
nullable
Number

Numeric literal value, serialized as an invariant string to preserve decimal precision.

number format: double
nullable
Bool

Boolean literal value.

boolean
nullable
OffsetDays

Date variable day offset.

integer format: int32
nullable
Left
object recursive
Right
object recursive
Items
Array<object> recursive
ResultFamily

Typed result family resolved by the backend binder.

string
nullable
SourceFamily

Backend source family for lookup-like or complex fields.

string
nullable
ResolvedPath

Canonical field path resolved by the backend binder.

string
nullable
RelatedRequiredWhenPlan

Compiled rule expression plan used by Moltaro runtime surfaces.

object
RuleEngineVersion

Stable rule engine version used to compile this plan.

string
nullable
Root

Compiled rule expression node.

object
Kind

Node kind, for example literal, path, eq, and, or.

string
nullable
Operator

Optional operator metadata.

string
nullable
Path

Field path for path nodes.

string
nullable
LiteralKind

Literal family for literal nodes.

string
nullable
Text

Text value or variable name.

string
nullable
Number

Numeric literal value, serialized as an invariant string to preserve decimal precision.

number format: double
nullable
Bool

Boolean literal value.

boolean
nullable
OffsetDays

Date variable day offset.

integer format: int32
nullable
Left
object recursive
Right
object recursive
Items
Array<object> recursive
ResultFamily

Typed result family resolved by the backend binder.

string
nullable
SourceFamily

Backend source family for lookup-like or complex fields.

string
nullable
ResolvedPath

Canonical field path resolved by the backend binder.

string
nullable
RelatedChild

The child side of a WithParent related-table item for the current actor. The server sets the child Reference to the parent on save; a client names it only to leave it out of child values.

object
EntityDefinitionId

Child Entity definition identifier.

string
nullable
DisplayNameSingular

Child definition singular display name.

string
nullable
DisplayNamePlural

Child definition plural display name.

string
nullable
Cardinality

Cardinality of a WithParent relation as proven by metadata.

integer format: int32
Allowed values: 0 1
SingleChildScope
integer format: int32
Allowed values: 1 2
Capabilities

Potential rights of the current actor on child records of a WithParent item; final checks run in SQL at save.

object
View

The actor can read child records of the definition.

boolean
Create

The actor can potentially create child records.

boolean
Update

The actor can potentially update child records.

boolean
Archive

The actor can potentially archive child records.

boolean
Delete

The actor can potentially delete archived child records.

boolean
Form

The resolved child Form of a WithParent item.

object
State

Availability of the child Form surface of a WithParent item for the current actor.

integer format: int32
Allowed values: 0 1 2
FormSurfaceId

Resolved child Form surface identifier when State is Ready.

string
nullable
FormSurfaceKey

Resolved child Form surface key when State is Ready.

string
nullable
RowVersion

Row version of the resolved child Form surface.

string format: uuid
nullable
ParentReferenceFieldKey

Key of the child Reference to the parent, which a child value never carries.

string
nullable
SectionItemId
required

The item that owns the one child draft of this relation: the first WithParent item of the same relation in Form order. Every WithParent item of the relation names it (always present, never null); a client stages each child change once under it, and a Form submission names it as Sections[].ItemId.

string
PreauthorizationParentFieldKeys
required

The keys of the parent field items of this Form whose values the pre-authorization of a new child reads: a File-field upload (ParentContext) and a Markdown attachment scope (ProviderContextJson) of a new child. They are the fields the child’s Create, Attachments:Create and Field:CreateWrite rights read one hop away through the parent Reference, and the fields the parent’s own Create and Field:CreateWrite rights read for an unsaved parent; every parent field item when such a right reads a parent field the parent Form computes. Send exactly these keys in ParentContext.ParentFields, each with its full value; the server refuses a context over its limit with moltaro.ui.form.parentContext.tooLarge instead of shortening it. Empty when no such right reads the parent; never null.

Array<string>
ReferenceEligibility

Non-executable dependency metadata for one Reference field.

object
TargetFieldId

Dependent scalar Reference field identifier.

string
nullable
DriverFieldIds

Direct source-field identifiers required to build selection context.

Array<string>
nullable
Enabled

Whether the persisted rule currently participates in runtime selection and mutation.

boolean
ReferenceContext

Actor-shaped Form context required by one scalar Reference field.

object
TargetFieldId

Reference field identifier represented by the Form item.

string
nullable
CurrentValueInputs

Explicit allow-lists for client-owned Form Reference context values.

object
CreateDraftFieldIds

Fields whose user-owned, currently editable create-draft values may be sent. A possible mutation-effect target remains listed because ownership is draft-specific.

Array<string>
nullable
UpdateDraftFieldIds

Fields whose editable update-draft values may be sent.

Array<string>
nullable
LockedCreateFieldIds

Fields whose server-owned related-create locks may be sent.

Array<string>
nullable
ProjectedTargetFieldIds

Target scalar or Money owner field identifiers required by one-hop Form field behavior plans.

Array<string>
nullable
RequiresTargetValues

Whether the Form must materialize the referenced target for system, scalar, or Money target values.

boolean
WorkspaceUiComponentKey

Registered Workspace UI component key for a WorkspaceUiComponent item; null for other item types.

string
nullable
WorkspaceUiComponentBindings

Declared-binding-name → field mappings of a WorkspaceUiComponent item. The runtime model carries only bindings the actor may at least read, each with its shaped Moltaro.Entity.Ui.Models.Form.EntityFormUiWorkspaceUiComponentBindingModel.Access.

Array<object>
nullable

One mapped binding of a Workspace UI form component item: the binding name the component declared and the primary-table field Constructor mapped it to. Runtime shaping adds the resolved field key, field type and the actor-shaped access; the admin document carries the name and field id only.

object
Name

Binding name declared by the component (lowercase kebab-case).

string
nullable
FieldId

Mapped primary-table field identifier.

string
nullable
FieldKey

Resolved field key; null in the admin document.

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
Access
integer format: int32
Allowed values: 0 1
Optional

Whether the component declared the binding optional; null in the admin document.

boolean
nullable
Required

Whether the mapped field is required by the definition; null in the admin document.

boolean
nullable
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": {
"Meta": {
"UsageType": 0,
"SemanticPresentations": [
{
"Slot": 0
}
]
},
"SurfaceType": 0,
"Source": 0,
"Items": [
{
"ItemType": 0,
"Binding": {
"RefKind": 0,
"SystemField": 0,
"FieldType": 0,
"ReferenceDeleteBehavior": 0,
"TableFields": [
{
"Editor": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0
}
],
"VisibleWhenOperationMode": 0,
"RequiredWhenOperationMode": 0,
"EditableWhenOperationMode": 0,
"DefaultValue": {
"Kind": 0
},
"ObjectContextFactMember": {
"ValueType": 0,
"SourceField": {
"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
}
}
},
"SemanticRole": 0
},
"Editor": 0,
"TextBlockStyle": 0,
"AlertTone": 0,
"DatePickerAnchorMode": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0,
"HierarchySourceKind": 0,
"ReferenceHierarchy": {
"SourceKind": 0
},
"LookupTableSelectors": [
{
"Mode": 0
}
],
"CreateFormSelector": {
"Mode": 0
},
"CreateFormSelectors": [
{
"Mode": 0
}
],
"RelatedTableSelector": {
"Mode": 0
},
"RelatedTableSelectors": [
{
"Mode": 0
}
],
"RelatedSaveMode": 0,
"RelatedPresentation": 0,
"RelatedHiddenPolicy": 0,
"RelatedFormSelectors": [
{
"Mode": 0
}
],
"RelatedChild": {
"Cardinality": 0,
"SingleChildScope": 1,
"Form": {
"State": 0
}
},
"WorkspaceUiComponentBindings": [
{
"FieldType": 0,
"Access": 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

Admin-facing form surface configuration.

object
Meta

Minimal runtime entity metadata used by explicit UI surfaces.

object
EntityDefinitionId

Entity definition identifier.

string
nullable
Name

Internal entity key used by runtime routes.

string
nullable
DisplayNameSingular

User-facing singular name.

string
nullable
DisplayNamePlural

User-facing plural name.

string
nullable
CommentsEnabled

Whether entity comments are enabled.

boolean
AttachmentsEnabled

Whether entity attachments are enabled.

boolean
TagsEnabled

Whether entity tags are enabled.

boolean
FullTextSearchAvailable

Whether runtime configured search is available for the definition.

boolean
Statements

Runtime-exposed statements for this entity.

Array<object>
nullable

Runtime statement descriptor exposed to clients together with predicate payloads.

object
Id

Statement identifier.

string
nullable
Name

Stable technical statement key.

string
nullable
DisplayName

User-facing statement label.

string
nullable
RuleEvaluationContext

Rule evaluation context shared with fast UI runtime evaluation.

object
CurrentUserId

Current workspace user identifier.

string
nullable
CurrentLocalDate

Workspace-local current date in ISO format.

string
nullable
TimeZone

Workspace time zone identifier.

string
nullable
GeneratedAtUtc

UTC instant when the context was generated.

string format: date-time
nullable
NextLocalMidnightUtc

UTC instant for the next midnight in the workspace time zone.

string format: date-time
nullable
ContextValues

Owner-scoped runtime values available to rule plans.

object
key
additional properties
IsProjection

Whether the entity is an enabled Projection Entity.

boolean
UsageType
integer format: int32
Allowed values: 0 1 2
SemanticType

Data specialization key; null for Part and Association.

string
nullable
SemanticPresentations

Explicit presentation registrations; missing bindings must not select a generic fallback.

Array<object>
nullable

Explicit standard-host or specialized component registration for one slot.

object
Slot

An Entity object presentation slot, distinct from field editors and renderers.

integer format: int32
Allowed values: 0 1 2 3 4 5 6
RegistrationKey
string
nullable
SurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
SurfaceId

Persisted form surface identifier.

string
nullable
Name

Custom form surface name.

string
nullable
Key

Custom form surface key.

string
nullable
IsDefault

Whether this form surface is the current default form.

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

Stable NET package root id when this form surface is package-owned.

string
nullable
SourcePackageId

NET package artifact id when this form surface is package-owned.

string
nullable
SourceStableId

Stable package surface id when this form surface is package-owned.

string
nullable
MaxWidth

Maximum layout width in pixels.

integer format: int32
nullable
ColumnCount

Desktop column count.

integer format: int32
nullable
Items

Configured form items.

Array<object>
nullable

One form item.

object
Id

Stable item identifier.

string
nullable
ItemType
integer format: int32
Allowed values: 0 1 2 3 4
SortOrder

Display order.

integer format: int32
Column

Preferred desktop column.

integer format: int32
Label

Optional overridden label.

string
nullable
Hint

Optional hint text.

string
nullable
Binding

Resolved binding metadata for one UI field reference.

object
RefKind
integer format: int32
Allowed values: 0 1 2 3 4
FieldId

Field identifier when the binding points to an entity field.

string
nullable
FieldKey

Runtime field key when the binding points to an entity field.

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

Whether the bound field is always required.

boolean
VisibleWhen

Visibility condition expression for draft-aware UI evaluation.

string
nullable
RequiredWhen

Requiredness condition expression for draft-aware UI evaluation.

string
nullable
EditableWhen

Editability condition expression for draft-aware UI evaluation.

string
nullable
VisibleWhenPlan

Compiled rule expression plan used by Moltaro runtime surfaces.

object
RuleEngineVersion

Stable rule engine version used to compile this plan.

string
nullable
Root

Compiled rule expression node.

object
Kind

Node kind, for example literal, path, eq, and, or.

string
nullable
Operator

Optional operator metadata.

string
nullable
Path

Field path for path nodes.

string
nullable
LiteralKind

Literal family for literal nodes.

string
nullable
Text

Text value or variable name.

string
nullable
Number

Numeric literal value, serialized as an invariant string to preserve decimal precision.

number format: double
nullable
Bool

Boolean literal value.

boolean
nullable
OffsetDays

Date variable day offset.

integer format: int32
nullable
Left
object recursive
Right
object recursive
Items
Array<object> recursive
ResultFamily

Typed result family resolved by the backend binder.

string
nullable
SourceFamily

Backend source family for lookup-like or complex fields.

string
nullable
ResolvedPath

Canonical field path resolved by the backend binder.

string
nullable
RequiredWhenPlan

Compiled rule expression plan used by Moltaro runtime surfaces.

object
RuleEngineVersion

Stable rule engine version used to compile this plan.

string
nullable
Root

Compiled rule expression node.

object
Kind

Node kind, for example literal, path, eq, and, or.

string
nullable
Operator

Optional operator metadata.

string
nullable
Path

Field path for path nodes.

string
nullable
LiteralKind

Literal family for literal nodes.

string
nullable
Text

Text value or variable name.

string
nullable
Number

Numeric literal value, serialized as an invariant string to preserve decimal precision.

number format: double
nullable
Bool

Boolean literal value.

boolean
nullable
OffsetDays

Date variable day offset.

integer format: int32
nullable
Left
object recursive
Right
object recursive
Items
Array<object> recursive
ResultFamily

Typed result family resolved by the backend binder.

string
nullable
SourceFamily

Backend source family for lookup-like or complex fields.

string
nullable
ResolvedPath

Canonical field path resolved by the backend binder.

string
nullable
EditableWhenPlan

Compiled rule expression plan used by Moltaro runtime surfaces.

object
RuleEngineVersion

Stable rule engine version used to compile this plan.

string
nullable
Root

Compiled rule expression node.

object
Kind

Node kind, for example literal, path, eq, and, or.

string
nullable
Operator

Optional operator metadata.

string
nullable
Path

Field path for path nodes.

string
nullable
LiteralKind

Literal family for literal nodes.

string
nullable
Text

Text value or variable name.

string
nullable
Number

Numeric literal value, serialized as an invariant string to preserve decimal precision.

number format: double
nullable
Bool

Boolean literal value.

boolean
nullable
OffsetDays

Date variable day offset.

integer format: int32
nullable
Left
object recursive
Right
object recursive
Items
Array<object> recursive
ResultFamily

Typed result family resolved by the backend binder.

string
nullable
SourceFamily

Backend source family for lookup-like or complex fields.

string
nullable
ResolvedPath

Canonical field path resolved by the backend binder.

string
nullable
AllowMultiple

Whether the bound field allows multiple values.

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
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
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
TableFields

Access-shaped child-table fields when the binding targets a table field.

Array<object>
nullable

One access-shaped child-table field for runtime UI rendering.

object
Id

Child field identifier.

string
nullable
Label

Display label for the child field.

string
nullable
Binding
object recursive
Editor
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10
Editable

Whether the caller may edit this child field.

boolean
ReferenceInputType
integer format: int32
Allowed values: 0 1 2 3
ReferenceRendererType
integer format: int32
Allowed values: 0 1
ReferenceLookupRenderType
integer format: int32
Allowed values: 0 1
ReferencePath

Reference path configured for breadcrumb rendering.

Array<string>
nullable
HasAccessibleChildFields

Whether the caller can access at least one child-table field.

boolean
HasNestedAccessibleTableFields

Whether the caller can access nested table child fields.

boolean
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
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.

nullable
ResponsibilityKey

Stable key when the binding targets a unified responsibility.

string
nullable
ResponsibilityDisplayName

Display name when the binding targets a unified responsibility.

string
nullable
DisplayFieldId

Display field identifier when the binding targets a display-only computed field.

string
nullable
DisplayFieldKey

Display field key when the binding targets a display-only computed field.

string
nullable
DisplayFieldDisplayName

Display field display name when the binding targets a display-only computed field.

string
nullable
ObjectContextFactId

Object-context fact configuration id when the binding targets a contextual fact.

string
nullable
ObjectContextFactDisplayName

Safe source display name from the actor-shaped provider catalog.

string
nullable
ObjectContextFactMemberKey

Stable member key; null selects the existing whole-fact presentation.

string
nullable
ObjectContextFactMember

Provider-owned member metadata. A source field retains its existing Entity metadata and stable identity; system members use a provider-owned key. An editor key identifies a registered domain editor, not a setter.

object
MemberKey
string
nullable
DisplayName
string
nullable
ValueType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
Nullable
boolean
Capabilities

Explicit capabilities; absence of a capability never selects a fallback mutation.

object
Read
boolean
Create
boolean
Edit
boolean
InlineEdit
boolean
EditorKey
string
nullable
SourceField

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.

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.

nullable
IsProtected

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

boolean
EditorConfiguration

Opaque configuration interpreted only by the registered domain editor.

nullable
PortabilityKey

Provider-owned stable YAML identity when the runtime member key contains workspace-local identifiers.

string
nullable
ObjectContextFactProviderKey

Provider key that owns the object-context fact payload.

string
nullable
ObjectContextFactTarget

Stable identity of one Moltaro resource instance.

object
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
ResourceObjectId
string
nullable
AddressCoordinatesRequired

Whether an address field must be captured through a coordinate-aware editor.

boolean
ClassifierCatalogDefinitionId

Bound Classifier Catalog Definition identifier.

string
nullable
ClassifierCatalogKey

Bound Classifier Catalog Definition key.

string
nullable
ClassifierCatalogDisplayName

Bound Classifier Catalog Definition display name.

string
nullable
SemanticRole
integer format: int32
Allowed values: 0 1 2 3
EntityDefinitionId

Owning entity definition identifier used by destination-scoped field capabilities.

string
nullable
EntityDefinitionTableId

Owning entity definition table identifier used by destination-scoped field capabilities.

string
nullable
Editor
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10
Editable

Whether field editing is enabled.

boolean
EditorRows

Configured row count for textarea-style editors.

integer format: int32
nullable
TextBlockStyle
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8
TextBlockText

Text-block content when the item is a text block.

string
nullable
AlertTone
integer format: int32
Allowed values: 0 1 2 3
AlertTitle

Optional alert title.

string
nullable
AlertText

Alert body.

string
nullable
MarginTop

Optional top margin in pixels.

integer format: int32
nullable
MarginBottom

Optional bottom margin in pixels.

integer format: int32
nullable
PaddingTop

Optional top padding in pixels.

integer format: int32
nullable
PaddingBottom

Optional bottom padding in pixels.

integer format: int32
nullable
PaddingLeft

Optional left padding in pixels.

integer format: int32
nullable
PaddingRight

Optional right padding in pixels.

integer format: int32
nullable
Visible

Whether the item remains visible in the effective runtime model.

boolean
ColumnSpan

Desktop column span.

integer format: int32
DatePickerAnchorMode
integer format: int32
Allowed values: 0 1 2
DatePickerAnchorValue

Fixed year or relative year offset selected by Moltaro.Entity.Ui.Models.Form.EntityFormUiItemModel.DatePickerAnchorMode.

integer format: int32
nullable
ReferenceInputType
integer format: int32
Allowed values: 0 1 2 3
ReferenceRendererType
integer format: int32
Allowed values: 0 1
ReferenceLookupRenderType
integer format: int32
Allowed values: 0 1
ReferencePath

Reference path configured for breadcrumb rendering.

Array<string>
nullable
HierarchySourceKind
integer format: int32
Allowed values: 0 1
ReferenceHierarchy

Saved relationship shape for one hierarchy reference input.

object
SourceKind
integer format: int32
Allowed values: 0 1
ParentFieldDefinitionId

Recursive parent field identifier, or null for explicit-path mode.

string
nullable
ParentFieldKey

Recursive parent stable field key used by portable configuration.

string
nullable
LookupTableSelectors

Role-aware table selectors for lookup dialogs.

Array<object>
nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object
Id

Persisted selector row id. New client rows may send null.

string
nullable
Priority

Higher values are evaluated first.

integer format: int32
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string
nullable
RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>
nullable
CreateFormSelector

Selector for resolving an entity UI surface by default pointer or custom key.

object
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey
string
nullable
CreateFormSelectors

Role-aware create-form overrides used by admin authoring; an empty list inherits from the lookup table.

Array<object>
nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object
Id

Persisted selector row id. New client rows may send null.

string
nullable
Priority

Higher values are evaluated first.

integer format: int32
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string
nullable
RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>
nullable
ShowRelatedTableSaveNotice

Show the independent-save notice for a RelatedTable item; enabled by default.

boolean
RelatedTableSelector

Selector for resolving an entity UI surface by default pointer or custom key.

object
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey
string
nullable
RelatedTableSelectors

Role-aware child table surface selectors used by related-table admin authoring.

Array<object>
nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object
Id

Persisted selector row id. New client rows may send null.

string
nullable
Priority

Higher values are evaluated first.

integer format: int32
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string
nullable
RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>
nullable
RelatedSaveMode
required
integer format: int32
Allowed values: 0 1
RelatedPresentation
integer format: int32
Allowed values: 0 1
RelatedVisibleWhen

Field Behavior DSL condition over the parent Form draft that shows a WithParent section; null always shows it.

string
nullable
RelatedRequiredWhen

Field Behavior DSL condition over the parent Form draft that requires an active child record; null never does.

string
nullable
RelatedHiddenPolicy
integer format: int32
Allowed values: 0 1 2
RelatedFormSelectors

Role-aware child Form surface selectors of a WithParent item used by admin authoring; null reads as empty.

Array<object>
nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object
Id

Persisted selector row id. New client rows may send null.

string
nullable
Priority

Higher values are evaluated first.

integer format: int32
Mode
integer format: int32
Allowed values: 0 1
SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string
nullable
RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>
nullable
RelatedVisibleWhenPlan

Compiled rule expression plan used by Moltaro runtime surfaces.

object
RuleEngineVersion

Stable rule engine version used to compile this plan.

string
nullable
Root

Compiled rule expression node.

object
Kind

Node kind, for example literal, path, eq, and, or.

string
nullable
Operator

Optional operator metadata.

string
nullable
Path

Field path for path nodes.

string
nullable
LiteralKind

Literal family for literal nodes.

string
nullable
Text

Text value or variable name.

string
nullable
Number

Numeric literal value, serialized as an invariant string to preserve decimal precision.

number format: double
nullable
Bool

Boolean literal value.

boolean
nullable
OffsetDays

Date variable day offset.

integer format: int32
nullable
Left
object recursive
Right
object recursive
Items
Array<object> recursive
ResultFamily

Typed result family resolved by the backend binder.

string
nullable
SourceFamily

Backend source family for lookup-like or complex fields.

string
nullable
ResolvedPath

Canonical field path resolved by the backend binder.

string
nullable
RelatedRequiredWhenPlan

Compiled rule expression plan used by Moltaro runtime surfaces.

object
RuleEngineVersion

Stable rule engine version used to compile this plan.

string
nullable
Root

Compiled rule expression node.

object
Kind

Node kind, for example literal, path, eq, and, or.

string
nullable
Operator

Optional operator metadata.

string
nullable
Path

Field path for path nodes.

string
nullable
LiteralKind

Literal family for literal nodes.

string
nullable
Text

Text value or variable name.

string
nullable
Number

Numeric literal value, serialized as an invariant string to preserve decimal precision.

number format: double
nullable
Bool

Boolean literal value.

boolean
nullable
OffsetDays

Date variable day offset.

integer format: int32
nullable
Left
object recursive
Right
object recursive
Items
Array<object> recursive
ResultFamily

Typed result family resolved by the backend binder.

string
nullable
SourceFamily

Backend source family for lookup-like or complex fields.

string
nullable
ResolvedPath

Canonical field path resolved by the backend binder.

string
nullable
RelatedChild

The child side of a WithParent related-table item for the current actor. The server sets the child Reference to the parent on save; a client names it only to leave it out of child values.

object
EntityDefinitionId

Child Entity definition identifier.

string
nullable
DisplayNameSingular

Child definition singular display name.

string
nullable
DisplayNamePlural

Child definition plural display name.

string
nullable
Cardinality

Cardinality of a WithParent relation as proven by metadata.

integer format: int32
Allowed values: 0 1
SingleChildScope
integer format: int32
Allowed values: 1 2
Capabilities

Potential rights of the current actor on child records of a WithParent item; final checks run in SQL at save.

object
View

The actor can read child records of the definition.

boolean
Create

The actor can potentially create child records.

boolean
Update

The actor can potentially update child records.

boolean
Archive

The actor can potentially archive child records.

boolean
Delete

The actor can potentially delete archived child records.

boolean
Form

The resolved child Form of a WithParent item.

object
State

Availability of the child Form surface of a WithParent item for the current actor.

integer format: int32
Allowed values: 0 1 2
FormSurfaceId

Resolved child Form surface identifier when State is Ready.

string
nullable
FormSurfaceKey

Resolved child Form surface key when State is Ready.

string
nullable
RowVersion

Row version of the resolved child Form surface.

string format: uuid
nullable
ParentReferenceFieldKey

Key of the child Reference to the parent, which a child value never carries.

string
nullable
SectionItemId
required

The item that owns the one child draft of this relation: the first WithParent item of the same relation in Form order. Every WithParent item of the relation names it (always present, never null); a client stages each child change once under it, and a Form submission names it as Sections[].ItemId.

string
PreauthorizationParentFieldKeys
required

The keys of the parent field items of this Form whose values the pre-authorization of a new child reads: a File-field upload (ParentContext) and a Markdown attachment scope (ProviderContextJson) of a new child. They are the fields the child’s Create, Attachments:Create and Field:CreateWrite rights read one hop away through the parent Reference, and the fields the parent’s own Create and Field:CreateWrite rights read for an unsaved parent; every parent field item when such a right reads a parent field the parent Form computes. Send exactly these keys in ParentContext.ParentFields, each with its full value; the server refuses a context over its limit with moltaro.ui.form.parentContext.tooLarge instead of shortening it. Empty when no such right reads the parent; never null.

Array<string>
ReferenceEligibility

Non-executable dependency metadata for one Reference field.

object
TargetFieldId

Dependent scalar Reference field identifier.

string
nullable
DriverFieldIds

Direct source-field identifiers required to build selection context.

Array<string>
nullable
Enabled

Whether the persisted rule currently participates in runtime selection and mutation.

boolean
ReferenceContext

Actor-shaped Form context required by one scalar Reference field.

object
TargetFieldId

Reference field identifier represented by the Form item.

string
nullable
CurrentValueInputs

Explicit allow-lists for client-owned Form Reference context values.

object
CreateDraftFieldIds

Fields whose user-owned, currently editable create-draft values may be sent. A possible mutation-effect target remains listed because ownership is draft-specific.

Array<string>
nullable
UpdateDraftFieldIds

Fields whose editable update-draft values may be sent.

Array<string>
nullable
LockedCreateFieldIds

Fields whose server-owned related-create locks may be sent.

Array<string>
nullable
ProjectedTargetFieldIds

Target scalar or Money owner field identifiers required by one-hop Form field behavior plans.

Array<string>
nullable
RequiresTargetValues

Whether the Form must materialize the referenced target for system, scalar, or Money target values.

boolean
WorkspaceUiComponentKey

Registered Workspace UI component key for a WorkspaceUiComponent item; null for other item types.

string
nullable
WorkspaceUiComponentBindings

Declared-binding-name → field mappings of a WorkspaceUiComponent item. The runtime model carries only bindings the actor may at least read, each with its shaped Moltaro.Entity.Ui.Models.Form.EntityFormUiWorkspaceUiComponentBindingModel.Access.

Array<object>
nullable

One mapped binding of a Workspace UI form component item: the binding name the component declared and the primary-table field Constructor mapped it to. Runtime shaping adds the resolved field key, field type and the actor-shaped access; the admin document carries the name and field id only.

object
Name

Binding name declared by the component (lowercase kebab-case).

string
nullable
FieldId

Mapped primary-table field identifier.

string
nullable
FieldKey

Resolved field key; null in the admin document.

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
Access
integer format: int32
Allowed values: 0 1
Optional

Whether the component declared the binding optional; null in the admin document.

boolean
nullable
Required

Whether the mapped field is required by the definition; null in the admin document.

boolean
nullable
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": {
"Meta": {
"UsageType": 0,
"SemanticPresentations": [
{
"Slot": 0
}
]
},
"SurfaceType": 0,
"Source": 0,
"Items": [
{
"ItemType": 0,
"Binding": {
"RefKind": 0,
"SystemField": 0,
"FieldType": 0,
"ReferenceDeleteBehavior": 0,
"TableFields": [
{
"Editor": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0
}
],
"VisibleWhenOperationMode": 0,
"RequiredWhenOperationMode": 0,
"EditableWhenOperationMode": 0,
"DefaultValue": {
"Kind": 0
},
"ObjectContextFactMember": {
"ValueType": 0,
"SourceField": {
"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
}
}
},
"SemanticRole": 0
},
"Editor": 0,
"TextBlockStyle": 0,
"AlertTone": 0,
"DatePickerAnchorMode": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0,
"HierarchySourceKind": 0,
"ReferenceHierarchy": {
"SourceKind": 0
},
"LookupTableSelectors": [
{
"Mode": 0
}
],
"CreateFormSelector": {
"Mode": 0
},
"CreateFormSelectors": [
{
"Mode": 0
}
],
"RelatedTableSelector": {
"Mode": 0
},
"RelatedTableSelectors": [
{
"Mode": 0
}
],
"RelatedSaveMode": 0,
"RelatedPresentation": 0,
"RelatedHiddenPolicy": 0,
"RelatedFormSelectors": [
{
"Mode": 0
}
],
"RelatedChild": {
"Cardinality": 0,
"SingleChildScope": 1,
"Form": {
"State": 0
}
},
"WorkspaceUiComponentBindings": [
{
"FieldType": 0,
"Access": 0
}
]
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}