Skip to content

Return owner-scoped board data form bootstrap and current values for one readable board item.

GET
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/board-data/form
curl --request GET \
--url https://example.com/api/workspace/boards/example/items/example/board-data/form
  • None
boardIdOrKey
required
string
boardItemId
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

Owner-scoped board data form bootstrap and current Part values for one board item.

object
BoardItemId
string
nullable
DataRecordId
string
nullable
Form

Runtime form surface payload resolved for the active caller.

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
AccessModel
integer format: int32
Allowed values: 0 1 2 3
CommentsEnabled

Whether entity comments are enabled.

boolean
AttachmentsEnabled

Whether entity attachments are enabled.

boolean
TagsEnabled

Whether entity tags are enabled.

boolean
FullTextSearchAvailable

Whether runtime full-text 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
object
IsProjection

Whether the entity is an enabled Projection Entity.

boolean
Selector

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
Model

Persisted form surface.

object
Id

Surface identifier. This is empty when the model is not resolved.

string
nullable
Surface
integer format: int32
Allowed values: 0 1 2 3 4 5
MaxWidth

Maximum layout width in pixels.

integer format: int32
ColumnCount

Desktop column count.

integer format: int32
RowVersion

Concurrency token for persisted overrides.

string format: uuid
Items

Effective form items.

Array<object>
nullable

One form item.

object
Id

Stable item identifier.

string
nullable
ItemType
integer format: int32
Allowed values: 0 1 2
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
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.

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.

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.

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

Whether the caller may edit this child field.

boolean
ReferenceInputType
integer format: int32
Allowed values: 0 1 2
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
RelationDefinitionId

Relation definition id when the binding targets a record-assignment relation slot.

string
nullable
RelationDefinitionKey

Relation definition key when the binding targets a record-assignment relation slot.

string
nullable
RelationDefinitionDisplayName

Relation display name when the binding targets a record-assignment relation slot.

string
nullable
RelationCardinality
integer format: int32
Allowed values: 0 1
RelationSubjectMode
integer format: int32
Allowed values: 0 1 2
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
ObjectContextFactProviderKey

Provider key that owns the object-context fact payload.

string
nullable
ObjectContextFactTarget
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
Editor
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9
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
ReferenceInputType
integer format: int32
Allowed values: 0 1 2
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
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
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
object
MissingSurface

Machine-readable state for a reusable UI surface that is intentionally missing.

object
SurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
Reason
integer format: int32
Allowed values: 0 1
Selector

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
Instance

Detailed entity-instance response.

object
Id

Instance identifier.

string
nullable
Number

Server-generated entity number.

string
nullable
DisplayName

Resolved entity display name or fallback number.

string
nullable
Subtitle

Resolved entity subtitle from the presentation cache.

string
nullable
CreatedAt

Instance creation timestamp.

string format: date-time
CreatedByUserId

Creating user identifier when available.

string
nullable
ModifiedAt

Last modification timestamp when available.

string format: date-time
nullable
ModifiedByUserId

Last modifying user identifier when available.

string
nullable
ArchivedAt

Archive timestamp when the instance is archived.

string format: date-time
nullable
ArchivedByUserId

Archiving user identifier when available.

string
nullable
LastComment

Compact summary of the latest comment on an entity instance.

object
Id

Comment identifier.

string
nullable
CommentText

Comment text.

string
nullable
CreatedByUserId

Comment author identifier.

string
nullable
CreatedByUserName

Comment author display name.

string
nullable
CreatedAt

Comment creation timestamp.

string format: date-time
Tags

Visible tags for the instance.

Array<object>
nullable

Compact tag details for one entity instance.

object
Id

Tag identifier.

string
nullable
TagName

Tag name.

string
nullable
Color

Optional color value.

string
nullable
Category

Optional category.

string
nullable
TagCount

Total number of tags on the instance.

integer format: int32
LastActivityDateTime

Last activity timestamp for the instance.

string format: date-time
RowVersion

Runtime row-version token from the primary table.

string format: uuid
Fields

All runtime fields keyed by field key. User and role fields return compact reference models. Table fields return table metadata together with child rows.

object
key
additional properties

Field envelope for runtime entity-instance responses.

object
State
integer format: int32
Allowed values: 0 1
Value

Canonical stored value for the field when State is Moltaro.Enums.EntityInstanceFieldStateEnum.Value.

object
Predicates

Runtime-evaluated statement results keyed by statement identifier.

object
key
additional properties
boolean
Assignments

Relation assignments keyed by relation key for record-scoped entities.

object
key
additional properties
Array<object>

Assignment target in runtime entity-instance payloads.

object
SubjectType
integer format: int32
Allowed values: 0 1
SubjectId

Assigned subject identifier.

string
nullable
DisplayName

Display name resolved for the assignment subject when available.

string
nullable
Description

Optional secondary subject description.

string
nullable
Origin
integer format: int32
Allowed values: 0 1
SystemManaged

Whether the assignment row is managed by Moltaro runtime logic instead of direct user mutation.

boolean
InheritanceSource

Display-safe source metadata for a runtime assignment inherited from a parent record.

object
ParentEntityDefinitionId

Parent entity definition identifier.

string
nullable
ParentEntityDisplayName

Parent entity user-facing display name.

string
nullable
ParentRecord

Compact runtime payload for one resolved or unresolved entity reference.

object
State
integer format: int32
Allowed values: 0 1 2
Id

Linked entity identifier when resolved.

string
nullable
Number

Linked entity number when resolved.

string
nullable
DisplayName

Linked entity display name from the presentation cache when resolved.

string
nullable
Subtitle

Linked entity subtitle from the presentation cache when resolved.

string
nullable
ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object
key
additional properties
nullable
EntityDefinitionId

Linked entity definition identifier when resolved.

string
nullable
SourceRelationDefinitionId

Immediate source assignment relation identifier when available.

string
nullable
SourceRelationKey

Immediate source assignment relation key when available.

string
nullable
SourceRelationDisplayName

Immediate source assignment relation display name when available.

string
nullable
RecalculatedAtUtc

Timestamp when the inherited assignment row was last recalculated.

string format: date-time
nullable
InheritedDepth

Materialized inheritance depth.

integer format: int32
nullable
AssignmentPermissions

Per-relation assignment mutation permissions keyed by relation key.

object
key
additional properties

Server-computed mutation permissions for one relation slot on one entity instance.

object
CanUpdate

Whether the caller can replace the assignment set for the relation slot.

boolean
Permissions

Item-level permissions for one entity instance.

object
CanRead

Whether the caller can read the active instance.

boolean
CanUpdate

Whether the caller can patch the active instance.

boolean
CanArchive

Whether the caller can archive the active instance.

boolean
CanDelete

Whether the caller can permanently delete the instance after archival.

boolean
CanRestore

Whether the caller can restore the archived instance.

boolean
CanMerge

Whether the caller can merge this active instance with another active instance.

boolean
CanReadArchive

Whether the caller can read the instance while it is archived.

boolean
CanReadChangesHistory

Whether the caller can read the change history for this instance.

boolean
CanReadComments

Whether comments can be viewed for this instance.

boolean
CanCreateComments

Whether comments can be created for this instance.

boolean
CanUpdateComments

Whether comments can be updated for this instance.

boolean
CanDeleteComments

Whether comments can be deleted for this instance.

boolean
CanReadTags

Whether tags can be viewed for this instance.

boolean
CanCreateTags

Whether tags can be created for this instance.

boolean
CanUpdateTags

Whether tags can be updated for this instance.

boolean
CanDeleteTags

Whether tags can be deleted for this instance.

boolean
CanReadAttachments

Whether attachments can be viewed for this instance.

boolean
CanCreateAttachments

Whether attachments can be created for this instance.

boolean
CanUpdateAttachments

Whether attachments can be updated for this instance.

boolean
CanDeleteAttachments

Whether attachments can be deleted for this instance.

boolean
AssignmentRelations

Runtime relation metadata for record-scoped assignment sections.

Array<object>
nullable

Runtime relation slot metadata for record-scoped assignments.

object
Id

Relation definition identifier.

string
nullable
Key

Relation definition key.

string
nullable
DisplayName

Relation display name.

string
nullable
Cardinality
integer format: int32
Allowed values: 0 1
IsRequired

Whether the relation must keep at least one assignment.

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

Relation display order.

integer format: int32
Permissions

Server-computed mutation permissions for one relation slot on one entity instance.

object
CanUpdate

Whether the caller can replace the assignment set for the relation slot.

boolean
MergeState

Merge state attached to entity instance payloads.

object
IsMergedAway
boolean
MergedIntoInstanceId
string
nullable
MergeOperationId
string
nullable
DisplayFields

Display-only computed fields keyed by display-field key.

object
key
additional properties
string
ObjectContextFacts

Provider-owned object-context facts keyed by provider key.

object
key
additional properties
object
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Form": {
"Meta": {
"AccessModel": 0
},
"Selector": {
"Mode": 0
},
"Model": {
"Surface": 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,
"RelationCardinality": 0,
"RelationSubjectMode": 0
},
"Editor": 0,
"TextBlockStyle": 0,
"AlertTone": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0,
"LookupTableSelectors": [
{
"Mode": 0
}
]
}
]
},
"MissingSurface": {
"SurfaceType": 0,
"Reason": 0,
"Selector": {
"Mode": 0
}
}
},
"Instance": {
"Fields": {
"additionalProperty": {
"State": 0
}
},
"Assignments": {
"additionalProperty": [
{
"SubjectType": 0,
"Origin": 0,
"InheritanceSource": {
"ParentRecord": {
"State": 0
}
}
}
]
},
"AssignmentRelations": [
{
"Cardinality": 0,
"SubjectMode": 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

Owner-scoped board data form bootstrap and current Part values for one board item.

object
BoardItemId
string
nullable
DataRecordId
string
nullable
Form

Runtime form surface payload resolved for the active caller.

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
AccessModel
integer format: int32
Allowed values: 0 1 2 3
CommentsEnabled

Whether entity comments are enabled.

boolean
AttachmentsEnabled

Whether entity attachments are enabled.

boolean
TagsEnabled

Whether entity tags are enabled.

boolean
FullTextSearchAvailable

Whether runtime full-text 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
object
IsProjection

Whether the entity is an enabled Projection Entity.

boolean
Selector

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
Model

Persisted form surface.

object
Id

Surface identifier. This is empty when the model is not resolved.

string
nullable
Surface
integer format: int32
Allowed values: 0 1 2 3 4 5
MaxWidth

Maximum layout width in pixels.

integer format: int32
ColumnCount

Desktop column count.

integer format: int32
RowVersion

Concurrency token for persisted overrides.

string format: uuid
Items

Effective form items.

Array<object>
nullable

One form item.

object
Id

Stable item identifier.

string
nullable
ItemType
integer format: int32
Allowed values: 0 1 2
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
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.

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.

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.

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

Whether the caller may edit this child field.

boolean
ReferenceInputType
integer format: int32
Allowed values: 0 1 2
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
RelationDefinitionId

Relation definition id when the binding targets a record-assignment relation slot.

string
nullable
RelationDefinitionKey

Relation definition key when the binding targets a record-assignment relation slot.

string
nullable
RelationDefinitionDisplayName

Relation display name when the binding targets a record-assignment relation slot.

string
nullable
RelationCardinality
integer format: int32
Allowed values: 0 1
RelationSubjectMode
integer format: int32
Allowed values: 0 1 2
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
ObjectContextFactProviderKey

Provider key that owns the object-context fact payload.

string
nullable
ObjectContextFactTarget
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
Editor
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9
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
ReferenceInputType
integer format: int32
Allowed values: 0 1 2
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
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
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
object
MissingSurface

Machine-readable state for a reusable UI surface that is intentionally missing.

object
SurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
Reason
integer format: int32
Allowed values: 0 1
Selector

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
Instance

Detailed entity-instance response.

object
Id

Instance identifier.

string
nullable
Number

Server-generated entity number.

string
nullable
DisplayName

Resolved entity display name or fallback number.

string
nullable
Subtitle

Resolved entity subtitle from the presentation cache.

string
nullable
CreatedAt

Instance creation timestamp.

string format: date-time
CreatedByUserId

Creating user identifier when available.

string
nullable
ModifiedAt

Last modification timestamp when available.

string format: date-time
nullable
ModifiedByUserId

Last modifying user identifier when available.

string
nullable
ArchivedAt

Archive timestamp when the instance is archived.

string format: date-time
nullable
ArchivedByUserId

Archiving user identifier when available.

string
nullable
LastComment

Compact summary of the latest comment on an entity instance.

object
Id

Comment identifier.

string
nullable
CommentText

Comment text.

string
nullable
CreatedByUserId

Comment author identifier.

string
nullable
CreatedByUserName

Comment author display name.

string
nullable
CreatedAt

Comment creation timestamp.

string format: date-time
Tags

Visible tags for the instance.

Array<object>
nullable

Compact tag details for one entity instance.

object
Id

Tag identifier.

string
nullable
TagName

Tag name.

string
nullable
Color

Optional color value.

string
nullable
Category

Optional category.

string
nullable
TagCount

Total number of tags on the instance.

integer format: int32
LastActivityDateTime

Last activity timestamp for the instance.

string format: date-time
RowVersion

Runtime row-version token from the primary table.

string format: uuid
Fields

All runtime fields keyed by field key. User and role fields return compact reference models. Table fields return table metadata together with child rows.

object
key
additional properties

Field envelope for runtime entity-instance responses.

object
State
integer format: int32
Allowed values: 0 1
Value

Canonical stored value for the field when State is Moltaro.Enums.EntityInstanceFieldStateEnum.Value.

object
Predicates

Runtime-evaluated statement results keyed by statement identifier.

object
key
additional properties
boolean
Assignments

Relation assignments keyed by relation key for record-scoped entities.

object
key
additional properties
Array<object>

Assignment target in runtime entity-instance payloads.

object
SubjectType
integer format: int32
Allowed values: 0 1
SubjectId

Assigned subject identifier.

string
nullable
DisplayName

Display name resolved for the assignment subject when available.

string
nullable
Description

Optional secondary subject description.

string
nullable
Origin
integer format: int32
Allowed values: 0 1
SystemManaged

Whether the assignment row is managed by Moltaro runtime logic instead of direct user mutation.

boolean
InheritanceSource

Display-safe source metadata for a runtime assignment inherited from a parent record.

object
ParentEntityDefinitionId

Parent entity definition identifier.

string
nullable
ParentEntityDisplayName

Parent entity user-facing display name.

string
nullable
ParentRecord

Compact runtime payload for one resolved or unresolved entity reference.

object
State
integer format: int32
Allowed values: 0 1 2
Id

Linked entity identifier when resolved.

string
nullable
Number

Linked entity number when resolved.

string
nullable
DisplayName

Linked entity display name from the presentation cache when resolved.

string
nullable
Subtitle

Linked entity subtitle from the presentation cache when resolved.

string
nullable
ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object
key
additional properties
nullable
EntityDefinitionId

Linked entity definition identifier when resolved.

string
nullable
SourceRelationDefinitionId

Immediate source assignment relation identifier when available.

string
nullable
SourceRelationKey

Immediate source assignment relation key when available.

string
nullable
SourceRelationDisplayName

Immediate source assignment relation display name when available.

string
nullable
RecalculatedAtUtc

Timestamp when the inherited assignment row was last recalculated.

string format: date-time
nullable
InheritedDepth

Materialized inheritance depth.

integer format: int32
nullable
AssignmentPermissions

Per-relation assignment mutation permissions keyed by relation key.

object
key
additional properties

Server-computed mutation permissions for one relation slot on one entity instance.

object
CanUpdate

Whether the caller can replace the assignment set for the relation slot.

boolean
Permissions

Item-level permissions for one entity instance.

object
CanRead

Whether the caller can read the active instance.

boolean
CanUpdate

Whether the caller can patch the active instance.

boolean
CanArchive

Whether the caller can archive the active instance.

boolean
CanDelete

Whether the caller can permanently delete the instance after archival.

boolean
CanRestore

Whether the caller can restore the archived instance.

boolean
CanMerge

Whether the caller can merge this active instance with another active instance.

boolean
CanReadArchive

Whether the caller can read the instance while it is archived.

boolean
CanReadChangesHistory

Whether the caller can read the change history for this instance.

boolean
CanReadComments

Whether comments can be viewed for this instance.

boolean
CanCreateComments

Whether comments can be created for this instance.

boolean
CanUpdateComments

Whether comments can be updated for this instance.

boolean
CanDeleteComments

Whether comments can be deleted for this instance.

boolean
CanReadTags

Whether tags can be viewed for this instance.

boolean
CanCreateTags

Whether tags can be created for this instance.

boolean
CanUpdateTags

Whether tags can be updated for this instance.

boolean
CanDeleteTags

Whether tags can be deleted for this instance.

boolean
CanReadAttachments

Whether attachments can be viewed for this instance.

boolean
CanCreateAttachments

Whether attachments can be created for this instance.

boolean
CanUpdateAttachments

Whether attachments can be updated for this instance.

boolean
CanDeleteAttachments

Whether attachments can be deleted for this instance.

boolean
AssignmentRelations

Runtime relation metadata for record-scoped assignment sections.

Array<object>
nullable

Runtime relation slot metadata for record-scoped assignments.

object
Id

Relation definition identifier.

string
nullable
Key

Relation definition key.

string
nullable
DisplayName

Relation display name.

string
nullable
Cardinality
integer format: int32
Allowed values: 0 1
IsRequired

Whether the relation must keep at least one assignment.

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

Relation display order.

integer format: int32
Permissions

Server-computed mutation permissions for one relation slot on one entity instance.

object
CanUpdate

Whether the caller can replace the assignment set for the relation slot.

boolean
MergeState

Merge state attached to entity instance payloads.

object
IsMergedAway
boolean
MergedIntoInstanceId
string
nullable
MergeOperationId
string
nullable
DisplayFields

Display-only computed fields keyed by display-field key.

object
key
additional properties
string
ObjectContextFacts

Provider-owned object-context facts keyed by provider key.

object
key
additional properties
object
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Form": {
"Meta": {
"AccessModel": 0
},
"Selector": {
"Mode": 0
},
"Model": {
"Surface": 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,
"RelationCardinality": 0,
"RelationSubjectMode": 0
},
"Editor": 0,
"TextBlockStyle": 0,
"AlertTone": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0,
"LookupTableSelectors": [
{
"Mode": 0
}
]
}
]
},
"MissingSurface": {
"SurfaceType": 0,
"Reason": 0,
"Selector": {
"Mode": 0
}
}
},
"Instance": {
"Fields": {
"additionalProperty": {
"State": 0
}
},
"Assignments": {
"additionalProperty": [
{
"SubjectType": 0,
"Origin": 0,
"InheritanceSource": {
"ParentRecord": {
"State": 0
}
}
}
]
},
"AssignmentRelations": [
{
"Cardinality": 0,
"SubjectMode": 0
}
]
}
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Conflict

Media typeapplication/json
object
Data

Owner-scoped board data form bootstrap and current Part values for one board item.

object
BoardItemId
string
nullable
DataRecordId
string
nullable
Form

Runtime form surface payload resolved for the active caller.

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
AccessModel
integer format: int32
Allowed values: 0 1 2 3
CommentsEnabled

Whether entity comments are enabled.

boolean
AttachmentsEnabled

Whether entity attachments are enabled.

boolean
TagsEnabled

Whether entity tags are enabled.

boolean
FullTextSearchAvailable

Whether runtime full-text 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
object
IsProjection

Whether the entity is an enabled Projection Entity.

boolean
Selector

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
Model

Persisted form surface.

object
Id

Surface identifier. This is empty when the model is not resolved.

string
nullable
Surface
integer format: int32
Allowed values: 0 1 2 3 4 5
MaxWidth

Maximum layout width in pixels.

integer format: int32
ColumnCount

Desktop column count.

integer format: int32
RowVersion

Concurrency token for persisted overrides.

string format: uuid
Items

Effective form items.

Array<object>
nullable

One form item.

object
Id

Stable item identifier.

string
nullable
ItemType
integer format: int32
Allowed values: 0 1 2
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
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.

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.

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.

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

Whether the caller may edit this child field.

boolean
ReferenceInputType
integer format: int32
Allowed values: 0 1 2
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
RelationDefinitionId

Relation definition id when the binding targets a record-assignment relation slot.

string
nullable
RelationDefinitionKey

Relation definition key when the binding targets a record-assignment relation slot.

string
nullable
RelationDefinitionDisplayName

Relation display name when the binding targets a record-assignment relation slot.

string
nullable
RelationCardinality
integer format: int32
Allowed values: 0 1
RelationSubjectMode
integer format: int32
Allowed values: 0 1 2
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
ObjectContextFactProviderKey

Provider key that owns the object-context fact payload.

string
nullable
ObjectContextFactTarget
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
Editor
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9
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
ReferenceInputType
integer format: int32
Allowed values: 0 1 2
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
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
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
object
MissingSurface

Machine-readable state for a reusable UI surface that is intentionally missing.

object
SurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
Reason
integer format: int32
Allowed values: 0 1
Selector

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
Instance

Detailed entity-instance response.

object
Id

Instance identifier.

string
nullable
Number

Server-generated entity number.

string
nullable
DisplayName

Resolved entity display name or fallback number.

string
nullable
Subtitle

Resolved entity subtitle from the presentation cache.

string
nullable
CreatedAt

Instance creation timestamp.

string format: date-time
CreatedByUserId

Creating user identifier when available.

string
nullable
ModifiedAt

Last modification timestamp when available.

string format: date-time
nullable
ModifiedByUserId

Last modifying user identifier when available.

string
nullable
ArchivedAt

Archive timestamp when the instance is archived.

string format: date-time
nullable
ArchivedByUserId

Archiving user identifier when available.

string
nullable
LastComment

Compact summary of the latest comment on an entity instance.

object
Id

Comment identifier.

string
nullable
CommentText

Comment text.

string
nullable
CreatedByUserId

Comment author identifier.

string
nullable
CreatedByUserName

Comment author display name.

string
nullable
CreatedAt

Comment creation timestamp.

string format: date-time
Tags

Visible tags for the instance.

Array<object>
nullable

Compact tag details for one entity instance.

object
Id

Tag identifier.

string
nullable
TagName

Tag name.

string
nullable
Color

Optional color value.

string
nullable
Category

Optional category.

string
nullable
TagCount

Total number of tags on the instance.

integer format: int32
LastActivityDateTime

Last activity timestamp for the instance.

string format: date-time
RowVersion

Runtime row-version token from the primary table.

string format: uuid
Fields

All runtime fields keyed by field key. User and role fields return compact reference models. Table fields return table metadata together with child rows.

object
key
additional properties

Field envelope for runtime entity-instance responses.

object
State
integer format: int32
Allowed values: 0 1
Value

Canonical stored value for the field when State is Moltaro.Enums.EntityInstanceFieldStateEnum.Value.

object
Predicates

Runtime-evaluated statement results keyed by statement identifier.

object
key
additional properties
boolean
Assignments

Relation assignments keyed by relation key for record-scoped entities.

object
key
additional properties
Array<object>

Assignment target in runtime entity-instance payloads.

object
SubjectType
integer format: int32
Allowed values: 0 1
SubjectId

Assigned subject identifier.

string
nullable
DisplayName

Display name resolved for the assignment subject when available.

string
nullable
Description

Optional secondary subject description.

string
nullable
Origin
integer format: int32
Allowed values: 0 1
SystemManaged

Whether the assignment row is managed by Moltaro runtime logic instead of direct user mutation.

boolean
InheritanceSource

Display-safe source metadata for a runtime assignment inherited from a parent record.

object
ParentEntityDefinitionId

Parent entity definition identifier.

string
nullable
ParentEntityDisplayName

Parent entity user-facing display name.

string
nullable
ParentRecord

Compact runtime payload for one resolved or unresolved entity reference.

object
State
integer format: int32
Allowed values: 0 1 2
Id

Linked entity identifier when resolved.

string
nullable
Number

Linked entity number when resolved.

string
nullable
DisplayName

Linked entity display name from the presentation cache when resolved.

string
nullable
Subtitle

Linked entity subtitle from the presentation cache when resolved.

string
nullable
ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object
key
additional properties
nullable
EntityDefinitionId

Linked entity definition identifier when resolved.

string
nullable
SourceRelationDefinitionId

Immediate source assignment relation identifier when available.

string
nullable
SourceRelationKey

Immediate source assignment relation key when available.

string
nullable
SourceRelationDisplayName

Immediate source assignment relation display name when available.

string
nullable
RecalculatedAtUtc

Timestamp when the inherited assignment row was last recalculated.

string format: date-time
nullable
InheritedDepth

Materialized inheritance depth.

integer format: int32
nullable
AssignmentPermissions

Per-relation assignment mutation permissions keyed by relation key.

object
key
additional properties

Server-computed mutation permissions for one relation slot on one entity instance.

object
CanUpdate

Whether the caller can replace the assignment set for the relation slot.

boolean
Permissions

Item-level permissions for one entity instance.

object
CanRead

Whether the caller can read the active instance.

boolean
CanUpdate

Whether the caller can patch the active instance.

boolean
CanArchive

Whether the caller can archive the active instance.

boolean
CanDelete

Whether the caller can permanently delete the instance after archival.

boolean
CanRestore

Whether the caller can restore the archived instance.

boolean
CanMerge

Whether the caller can merge this active instance with another active instance.

boolean
CanReadArchive

Whether the caller can read the instance while it is archived.

boolean
CanReadChangesHistory

Whether the caller can read the change history for this instance.

boolean
CanReadComments

Whether comments can be viewed for this instance.

boolean
CanCreateComments

Whether comments can be created for this instance.

boolean
CanUpdateComments

Whether comments can be updated for this instance.

boolean
CanDeleteComments

Whether comments can be deleted for this instance.

boolean
CanReadTags

Whether tags can be viewed for this instance.

boolean
CanCreateTags

Whether tags can be created for this instance.

boolean
CanUpdateTags

Whether tags can be updated for this instance.

boolean
CanDeleteTags

Whether tags can be deleted for this instance.

boolean
CanReadAttachments

Whether attachments can be viewed for this instance.

boolean
CanCreateAttachments

Whether attachments can be created for this instance.

boolean
CanUpdateAttachments

Whether attachments can be updated for this instance.

boolean
CanDeleteAttachments

Whether attachments can be deleted for this instance.

boolean
AssignmentRelations

Runtime relation metadata for record-scoped assignment sections.

Array<object>
nullable

Runtime relation slot metadata for record-scoped assignments.

object
Id

Relation definition identifier.

string
nullable
Key

Relation definition key.

string
nullable
DisplayName

Relation display name.

string
nullable
Cardinality
integer format: int32
Allowed values: 0 1
IsRequired

Whether the relation must keep at least one assignment.

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

Relation display order.

integer format: int32
Permissions

Server-computed mutation permissions for one relation slot on one entity instance.

object
CanUpdate

Whether the caller can replace the assignment set for the relation slot.

boolean
MergeState

Merge state attached to entity instance payloads.

object
IsMergedAway
boolean
MergedIntoInstanceId
string
nullable
MergeOperationId
string
nullable
DisplayFields

Display-only computed fields keyed by display-field key.

object
key
additional properties
string
ObjectContextFacts

Provider-owned object-context facts keyed by provider key.

object
key
additional properties
object
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Form": {
"Meta": {
"AccessModel": 0
},
"Selector": {
"Mode": 0
},
"Model": {
"Surface": 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,
"RelationCardinality": 0,
"RelationSubjectMode": 0
},
"Editor": 0,
"TextBlockStyle": 0,
"AlertTone": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0,
"LookupTableSelectors": [
{
"Mode": 0
}
]
}
]
},
"MissingSurface": {
"SurfaceType": 0,
"Reason": 0,
"Selector": {
"Mode": 0
}
}
},
"Instance": {
"Fields": {
"additionalProperty": {
"State": 0
}
},
"Assignments": {
"additionalProperty": [
{
"SubjectType": 0,
"Origin": 0,
"InheritanceSource": {
"ParentRecord": {
"State": 0
}
}
}
]
},
"AssignmentRelations": [
{
"Cardinality": 0,
"SubjectMode": 0
}
]
}
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}