Skip to content

Return the drawer bootstrap payload for one entity instance.

GET
/api/workspace/entity/{entityIdOrKey}/ui/drawer
curl --request GET \
--url https://example.com/api/workspace/entity/example/ui/drawer
  • None
entityIdOrKey
required
string
instanceId
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

Runtime bootstrap payload for the drawer surface.

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
Model

Resolved drawer orchestration model.

object
SummaryCard

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
Form

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
Sections
Array<object>
nullable

One related-section definition on the drawer surface.

object
SourceEntityDefinitionId
string
nullable
SourceReferenceFieldId
string
nullable
Label
string
nullable
SortOrder
integer format: int32
Visible
boolean
TableBinding

Resolved table usage context for a hosted table surface.

object
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
PageSize
integer format: int32
nullable
LockedFilters
Array<object>
nullable

One host-level table filter preset.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
FieldId
string
nullable
FieldKey
string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Operator
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
ValueSource
integer format: int32
Allowed values: 0 1
Value
object
InitialFilters
Array<object>
nullable

One host-level table filter preset.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
FieldId
string
nullable
FieldKey
string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Operator
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
ValueSource
integer format: int32
Allowed values: 0 1
Value
object
InitialSort
Array<object>
nullable

One host-level initial sort preset for an embedded table binding.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
FieldId
string
nullable
FieldKey
string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Direction
integer format: int32
Allowed values: 0 1
LayoutMode
integer format: int32
Allowed values: 0 1
ObjectHostedLayout

Object-hosted layout for a single record details page or drawer.

object
Surface
integer format: int32
Allowed values: 0 1 2 3 4 5
Items
Array<object>
nullable

One entry in an object-hosted layout for a single record surface.

object
Id
string
nullable
ItemKind
integer format: int32
Allowed values: 0 1
BlockKind
integer format: int32
Allowed values: 0 1 2 3
StandardBlock
integer format: int32
Allowed values: 0 1 2 3 4
BindingPath

Structured binding path for special host-layout blocks.

object
RootEntityDefinitionId
string
nullable
TargetEntityDefinitionId
string
nullable
Label
string
nullable
Steps
Array<object>
nullable

One reverse-reference hop used by a special host-layout block.

object
Direction
integer format: int32
Allowed values: 0 1
SourceEntityDefinitionId
string
nullable
SourceReferenceFieldId
string
nullable
SourceReferenceFieldKey
string
nullable
TargetEntityDefinitionId
string
nullable
SourceEntityDisplayNamePlural
string
nullable
SourceReferenceFieldDisplayName
string
nullable
TargetEntityDisplayNameSingular
string
nullable
Settings
object
SettingsVersion
integer format: int32
Title
string
nullable
Subtitle
string
nullable
SortOrder
integer format: int32
Visible
boolean
CollapsedByDefault
boolean
RibbonBarLayout

Ribbon-bar signal layout for a single record details page or drawer.

object
Surface
integer format: int32
Allowed values: 0 1 2 3 4 5
Items
Array<object>
nullable

One configured ribbon-bar signal placement.

object
Id
string
nullable
SignalKey
string
nullable
Settings
object
SettingsVersion
integer format: int32
SortOrder
integer format: int32
Visible
boolean
WorkContext

Server-computed enrichment context for one entity details page.

object
Providers
Array<object>
nullable

Disclosure state and optional signal for one work-context provider.

object
ProviderKey
string
nullable
State
integer format: int32
Allowed values: 0 1 2
Signal

Compact provider signal rendered in the entity details signal strip.

object
Key
string
nullable
ProviderKey
string
nullable
TestKey
string
nullable
Icon
string
nullable
LabelText

Provider-specific compact label.

string
nullable
Title

Main signal value.

string
nullable
Subtitle

Secondary signal text.

string
nullable
Meta

Tertiary compact text.

string
nullable
Color

Theme or raw display color for the signal icon.

string
nullable
Tone

Signal tone understood by the WebApp presentation layer.

string
nullable
Count

Optional visible item count. Restricted providers must leave this null.

integer format: int32
nullable
Actions

Provider-specific action descriptors. Restricted providers must return an empty list.

Array<object>
nullable

One server-approved action attached to a work-context signal.

object
Key
string
nullable
BadgeCount

Optional badge count for this action. Restricted providers must leave this null.

integer format: int32
nullable
Data

Provider-specific public action data.

object
key
additional properties
string
nullable
Data

Provider-specific public data needed to execute signal actions.

object
key
additional properties
string
nullable
ErrorCode
string
nullable
ObjectHostedLayoutBlocks

Runtime payloads for special blocks used by Moltaro.Entity.Ui.Models.Drawer.EntityDrawerBootstrapModel.ObjectHostedLayout.

Array<object>
nullable

Runtime payload for a custom host-layout block.

object
BlockId
string
nullable
BlockKind
integer format: int32
Allowed values: 0 1 2 3
State
integer format: int32
Allowed values: 0 1 2
BindingPath

Structured binding path for special host-layout blocks.

object
RootEntityDefinitionId
string
nullable
TargetEntityDefinitionId
string
nullable
Label
string
nullable
Steps
Array<object>
nullable

One reverse-reference hop used by a special host-layout block.

object
Direction
integer format: int32
Allowed values: 0 1
SourceEntityDefinitionId
string
nullable
SourceReferenceFieldId
string
nullable
SourceReferenceFieldKey
string
nullable
TargetEntityDefinitionId
string
nullable
SourceEntityDisplayNamePlural
string
nullable
SourceReferenceFieldDisplayName
string
nullable
TargetEntityDisplayNameSingular
string
nullable
Table

Persisted table 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
DefaultPageSize

Default page size.

integer format: int32
RowVersion

Concurrency token for persisted overrides.

string format: uuid
Columns

Effective columns.

Array<object>
nullable

One persisted table column.

object
Id

Stable column identifier.

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
Label

Column label.

string
nullable
Hint

Optional user hint.

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

Whether the column should render.

boolean
Editable

Whether inline editing is enabled for the column.

boolean
Width

Preferred width in pixels.

integer format: int32
SortOrder

Display order.

integer format: int32
Projection

Read-only field projection backed by a materialized related-field path.

object
Path

Runtime field-key path from the root entity to the projected terminal field.

Array<string>
nullable
IncludePath

Runtime reference path required for materialization.

Array<string>
nullable
RootEntityFieldDefinitionId

First primary-table reference field identifier.

string
nullable
PathEntityFieldDefinitionId2

Second reference field identifier inside the first target definition when configured.

string
nullable
PathEntityFieldDefinitionId3

Third reference field identifier inside the second target definition when configured.

string
nullable
TerminalEntityFieldDefinitionId

Projected terminal field identifier inside the final target definition.

string
nullable
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
Actions

Effective row actions.

Array<object>
nullable

One table-row action configuration.

object
Id

Stable action identifier.

string
nullable
Action
integer format: int32
Allowed values: 0 1 2 3 4 5 6
Placement
integer format: int32
Allowed values: 0 1 2
SortOrder

Explicit order within the placement bucket.

integer format: int32
FormSelectors

Role-aware form selectors used by edit actions in admin configuration.

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
FormSelector

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
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
AfterCreateNavigation
integer format: int32
Allowed values: 0 1 2
AfterUpdateNavigation
integer format: int32
Allowed values: 0 1 2
RowRules

Ordered row appearance rules for explicit surfaces.

Array<object>
nullable

Runtime table row appearance rule.

object
StatementId

Statement identifier used against instance predicates.

string
nullable
SortOrder

Stable evaluation order; the first matching rule wins.

integer format: int32
FontColor

Optional CSS font color applied to the whole row.

string
nullable
BackgroundColor

Optional CSS background color applied to the whole row.

string
nullable
Filters

Filter targets and their table-surface placement.

Array<object>
nullable

One table-surface filter target exposed to the web client.

object
Id
string
nullable
Label
string
nullable
Reference

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Placement
integer format: int32
Allowed values: 0 1 2
Sorting

Table-surface sorting capabilities exposed to the web client.

object
AllowMultiSort
boolean
SortableTargets
Array<object>
nullable

One table-surface sort target exposed to the web client.

object
Id
string
nullable
Label
string
nullable
Reference

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
DefaultSort
Array<object>
nullable

One sort item in the runtime list query.

object
Field

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Target

Typed target path for a runtime list query sort item.

object
Path

Reference path from the queried entity to the sortable terminal field or system field.

Array<object>
nullable

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

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

Paginated entity-instance response for one runtime entity definition.

object
Items

Current page of instance summaries.

Array<object>
nullable

List item for one entity instance.

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. List payloads include the first few tags only.

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

Primary-table scalar fields keyed by field key. User and role fields return compact reference models. Restricted fields are returned with Moltaro.Enums.EntityInstanceFieldStateEnum.Restricted.

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

Display-only source member metadata for a projection row.

object
ProjectionMemberId
string
nullable
ReferenceFieldId
string
nullable
SourceEntityDefinitionId
string
nullable
Label
string
nullable
SourceEntityDisplayNameSingular
string
nullable
SourceEntityDisplayNamePlural
string
nullable
ObjectContextFacts

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

object
key
additional properties
object
TotalCount

Total accessible instance count for the active page filter.

integer format: int32
Page

One-based page number.

integer format: int32
PageSize

Requested page size after normalization.

integer format: int32
Permissions

Page-level permissions for entity instances.

object
CanCreate

Whether the caller can create a new instance for this entity definition.

boolean
CanReadActive

Whether the caller can read active instances for this entity definition.

boolean
CanReadArchive

Whether the caller can read archived instances for this entity definition.

boolean
CanReadChangesHistory

Whether the caller can read change history for this entity definition.

boolean
CanMerge

Whether the caller can potentially merge records for this entity definition.

boolean
AssignmentRelations

Runtime relation metadata for record-scoped assignment columns.

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
ArchiveMode
integer format: int32
Allowed values: 0 1 2
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
ErrorCode
string
nullable
CreateAction

Server-computed contextual create action for a direct related-data section.

object
CanCreate
boolean
TargetEntityDefinitionId
string
nullable
TargetEntityDisplayNameSingular
string
nullable
LockedFields
object
key
additional properties
string
Entitlements

Owner-side runtime entitlement payload for an object-hosted layout block.

object
OwnerEntityDefinitionId
string
nullable
OwnerEntityDisplayName
string
nullable
OwnerInstanceCount
integer format: int32
Items
Array<object>
nullable

Compact entitlement row rendered inside an object-hosted layout block.

object
Id
string
nullable
EntitlementNumber
integer format: int64
EntitlementModelId
string
nullable
EntitlementModelDisplayName
string
nullable
ModelType
string
nullable
EntitlementPlanId
string
nullable
EntitlementPlanDisplayName
string
nullable
OwnerEntityDefinitionId
string
nullable
OwnerEntityDisplayName
string
nullable
OwnerEntityInstanceId
string
nullable
OwnerDisplayName
string
nullable
Status
string
nullable
EffectiveState
string
nullable
StartsAtUtc
string format: date-time
EndsAtUtc
string format: date-time
nullable
IssuedAtUtc
string format: date-time
TotalCount
integer format: int32
PageSize
integer format: int32
HasRestrictedItems
boolean
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": {
"AccessModel": 0
},
"Model": {
"SummaryCard": {
"Mode": 0
},
"Form": {
"Mode": 0
},
"Sections": [
{
"TableBinding": {
"Selector": {
"Mode": 0
},
"LockedFilters": [
{
"TargetKind": 0,
"SystemField": 0,
"Operator": 0,
"ValueSource": 0
}
],
"InitialFilters": [
{
"TargetKind": 0,
"SystemField": 0,
"Operator": 0,
"ValueSource": 0
}
],
"InitialSort": [
{
"TargetKind": 0,
"SystemField": 0,
"Direction": 0
}
]
}
}
]
},
"LayoutMode": 0,
"ObjectHostedLayout": {
"Surface": 0,
"Items": [
{
"ItemKind": 0,
"BlockKind": 0,
"StandardBlock": 0,
"BindingPath": {
"Steps": [
{
"Direction": 0
}
]
}
}
]
},
"RibbonBarLayout": {
"Surface": 0
},
"WorkContext": {
"Providers": [
{
"State": 0
}
]
},
"ObjectHostedLayoutBlocks": [
{
"BlockKind": 0,
"State": 0,
"BindingPath": {
"Steps": [
{
"Direction": 0
}
]
},
"Table": {
"Surface": 0,
"Columns": [
{
"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
},
"Renderer": 0,
"Editor": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0
}
],
"Actions": [
{
"Action": 0,
"Placement": 0,
"FormSelectors": [
{
"Mode": 0
}
],
"FormSelector": {
"Mode": 0
}
}
],
"AfterCreateNavigation": 0,
"AfterUpdateNavigation": 0,
"Filters": [
{
"Reference": {
"Special": 0
},
"Placement": 0
}
],
"Sorting": {
"SortableTargets": [
{
"Reference": {
"Special": 0
}
}
],
"DefaultSort": [
{
"Field": {
"Special": 0
},
"Target": {
"Path": [
{
"Special": 0
}
]
},
"Direction": 0
}
]
}
},
"Page": {
"Items": [
{
"Fields": {
"additionalProperty": {
"State": 0
}
},
"Assignments": {
"additionalProperty": [
{
"SubjectType": 0,
"Origin": 0,
"InheritanceSource": {
"ParentRecord": {
"State": 0
}
}
}
]
}
}
],
"AssignmentRelations": [
{
"Cardinality": 0,
"SubjectMode": 0
}
]
},
"ArchiveMode": 0,
"MissingSurface": {
"SurfaceType": 0,
"Reason": 0,
"Selector": {
"Mode": 0
}
}
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data

Runtime bootstrap payload for the drawer surface.

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
Model

Resolved drawer orchestration model.

object
SummaryCard

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
Form

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
Sections
Array<object>
nullable

One related-section definition on the drawer surface.

object
SourceEntityDefinitionId
string
nullable
SourceReferenceFieldId
string
nullable
Label
string
nullable
SortOrder
integer format: int32
Visible
boolean
TableBinding

Resolved table usage context for a hosted table surface.

object
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
PageSize
integer format: int32
nullable
LockedFilters
Array<object>
nullable

One host-level table filter preset.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
FieldId
string
nullable
FieldKey
string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Operator
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
ValueSource
integer format: int32
Allowed values: 0 1
Value
object
InitialFilters
Array<object>
nullable

One host-level table filter preset.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
FieldId
string
nullable
FieldKey
string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Operator
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
ValueSource
integer format: int32
Allowed values: 0 1
Value
object
InitialSort
Array<object>
nullable

One host-level initial sort preset for an embedded table binding.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
FieldId
string
nullable
FieldKey
string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Direction
integer format: int32
Allowed values: 0 1
LayoutMode
integer format: int32
Allowed values: 0 1
ObjectHostedLayout

Object-hosted layout for a single record details page or drawer.

object
Surface
integer format: int32
Allowed values: 0 1 2 3 4 5
Items
Array<object>
nullable

One entry in an object-hosted layout for a single record surface.

object
Id
string
nullable
ItemKind
integer format: int32
Allowed values: 0 1
BlockKind
integer format: int32
Allowed values: 0 1 2 3
StandardBlock
integer format: int32
Allowed values: 0 1 2 3 4
BindingPath

Structured binding path for special host-layout blocks.

object
RootEntityDefinitionId
string
nullable
TargetEntityDefinitionId
string
nullable
Label
string
nullable
Steps
Array<object>
nullable

One reverse-reference hop used by a special host-layout block.

object
Direction
integer format: int32
Allowed values: 0 1
SourceEntityDefinitionId
string
nullable
SourceReferenceFieldId
string
nullable
SourceReferenceFieldKey
string
nullable
TargetEntityDefinitionId
string
nullable
SourceEntityDisplayNamePlural
string
nullable
SourceReferenceFieldDisplayName
string
nullable
TargetEntityDisplayNameSingular
string
nullable
Settings
object
SettingsVersion
integer format: int32
Title
string
nullable
Subtitle
string
nullable
SortOrder
integer format: int32
Visible
boolean
CollapsedByDefault
boolean
RibbonBarLayout

Ribbon-bar signal layout for a single record details page or drawer.

object
Surface
integer format: int32
Allowed values: 0 1 2 3 4 5
Items
Array<object>
nullable

One configured ribbon-bar signal placement.

object
Id
string
nullable
SignalKey
string
nullable
Settings
object
SettingsVersion
integer format: int32
SortOrder
integer format: int32
Visible
boolean
WorkContext

Server-computed enrichment context for one entity details page.

object
Providers
Array<object>
nullable

Disclosure state and optional signal for one work-context provider.

object
ProviderKey
string
nullable
State
integer format: int32
Allowed values: 0 1 2
Signal

Compact provider signal rendered in the entity details signal strip.

object
Key
string
nullable
ProviderKey
string
nullable
TestKey
string
nullable
Icon
string
nullable
LabelText

Provider-specific compact label.

string
nullable
Title

Main signal value.

string
nullable
Subtitle

Secondary signal text.

string
nullable
Meta

Tertiary compact text.

string
nullable
Color

Theme or raw display color for the signal icon.

string
nullable
Tone

Signal tone understood by the WebApp presentation layer.

string
nullable
Count

Optional visible item count. Restricted providers must leave this null.

integer format: int32
nullable
Actions

Provider-specific action descriptors. Restricted providers must return an empty list.

Array<object>
nullable

One server-approved action attached to a work-context signal.

object
Key
string
nullable
BadgeCount

Optional badge count for this action. Restricted providers must leave this null.

integer format: int32
nullable
Data

Provider-specific public action data.

object
key
additional properties
string
nullable
Data

Provider-specific public data needed to execute signal actions.

object
key
additional properties
string
nullable
ErrorCode
string
nullable
ObjectHostedLayoutBlocks

Runtime payloads for special blocks used by Moltaro.Entity.Ui.Models.Drawer.EntityDrawerBootstrapModel.ObjectHostedLayout.

Array<object>
nullable

Runtime payload for a custom host-layout block.

object
BlockId
string
nullable
BlockKind
integer format: int32
Allowed values: 0 1 2 3
State
integer format: int32
Allowed values: 0 1 2
BindingPath

Structured binding path for special host-layout blocks.

object
RootEntityDefinitionId
string
nullable
TargetEntityDefinitionId
string
nullable
Label
string
nullable
Steps
Array<object>
nullable

One reverse-reference hop used by a special host-layout block.

object
Direction
integer format: int32
Allowed values: 0 1
SourceEntityDefinitionId
string
nullable
SourceReferenceFieldId
string
nullable
SourceReferenceFieldKey
string
nullable
TargetEntityDefinitionId
string
nullable
SourceEntityDisplayNamePlural
string
nullable
SourceReferenceFieldDisplayName
string
nullable
TargetEntityDisplayNameSingular
string
nullable
Table

Persisted table 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
DefaultPageSize

Default page size.

integer format: int32
RowVersion

Concurrency token for persisted overrides.

string format: uuid
Columns

Effective columns.

Array<object>
nullable

One persisted table column.

object
Id

Stable column identifier.

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
Label

Column label.

string
nullable
Hint

Optional user hint.

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

Whether the column should render.

boolean
Editable

Whether inline editing is enabled for the column.

boolean
Width

Preferred width in pixels.

integer format: int32
SortOrder

Display order.

integer format: int32
Projection

Read-only field projection backed by a materialized related-field path.

object
Path

Runtime field-key path from the root entity to the projected terminal field.

Array<string>
nullable
IncludePath

Runtime reference path required for materialization.

Array<string>
nullable
RootEntityFieldDefinitionId

First primary-table reference field identifier.

string
nullable
PathEntityFieldDefinitionId2

Second reference field identifier inside the first target definition when configured.

string
nullable
PathEntityFieldDefinitionId3

Third reference field identifier inside the second target definition when configured.

string
nullable
TerminalEntityFieldDefinitionId

Projected terminal field identifier inside the final target definition.

string
nullable
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
Actions

Effective row actions.

Array<object>
nullable

One table-row action configuration.

object
Id

Stable action identifier.

string
nullable
Action
integer format: int32
Allowed values: 0 1 2 3 4 5 6
Placement
integer format: int32
Allowed values: 0 1 2
SortOrder

Explicit order within the placement bucket.

integer format: int32
FormSelectors

Role-aware form selectors used by edit actions in admin configuration.

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
FormSelector

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
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
AfterCreateNavigation
integer format: int32
Allowed values: 0 1 2
AfterUpdateNavigation
integer format: int32
Allowed values: 0 1 2
RowRules

Ordered row appearance rules for explicit surfaces.

Array<object>
nullable

Runtime table row appearance rule.

object
StatementId

Statement identifier used against instance predicates.

string
nullable
SortOrder

Stable evaluation order; the first matching rule wins.

integer format: int32
FontColor

Optional CSS font color applied to the whole row.

string
nullable
BackgroundColor

Optional CSS background color applied to the whole row.

string
nullable
Filters

Filter targets and their table-surface placement.

Array<object>
nullable

One table-surface filter target exposed to the web client.

object
Id
string
nullable
Label
string
nullable
Reference

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Placement
integer format: int32
Allowed values: 0 1 2
Sorting

Table-surface sorting capabilities exposed to the web client.

object
AllowMultiSort
boolean
SortableTargets
Array<object>
nullable

One table-surface sort target exposed to the web client.

object
Id
string
nullable
Label
string
nullable
Reference

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
DefaultSort
Array<object>
nullable

One sort item in the runtime list query.

object
Field

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Target

Typed target path for a runtime list query sort item.

object
Path

Reference path from the queried entity to the sortable terminal field or system field.

Array<object>
nullable

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

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

Paginated entity-instance response for one runtime entity definition.

object
Items

Current page of instance summaries.

Array<object>
nullable

List item for one entity instance.

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. List payloads include the first few tags only.

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

Primary-table scalar fields keyed by field key. User and role fields return compact reference models. Restricted fields are returned with Moltaro.Enums.EntityInstanceFieldStateEnum.Restricted.

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

Display-only source member metadata for a projection row.

object
ProjectionMemberId
string
nullable
ReferenceFieldId
string
nullable
SourceEntityDefinitionId
string
nullable
Label
string
nullable
SourceEntityDisplayNameSingular
string
nullable
SourceEntityDisplayNamePlural
string
nullable
ObjectContextFacts

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

object
key
additional properties
object
TotalCount

Total accessible instance count for the active page filter.

integer format: int32
Page

One-based page number.

integer format: int32
PageSize

Requested page size after normalization.

integer format: int32
Permissions

Page-level permissions for entity instances.

object
CanCreate

Whether the caller can create a new instance for this entity definition.

boolean
CanReadActive

Whether the caller can read active instances for this entity definition.

boolean
CanReadArchive

Whether the caller can read archived instances for this entity definition.

boolean
CanReadChangesHistory

Whether the caller can read change history for this entity definition.

boolean
CanMerge

Whether the caller can potentially merge records for this entity definition.

boolean
AssignmentRelations

Runtime relation metadata for record-scoped assignment columns.

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
ArchiveMode
integer format: int32
Allowed values: 0 1 2
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
ErrorCode
string
nullable
CreateAction

Server-computed contextual create action for a direct related-data section.

object
CanCreate
boolean
TargetEntityDefinitionId
string
nullable
TargetEntityDisplayNameSingular
string
nullable
LockedFields
object
key
additional properties
string
Entitlements

Owner-side runtime entitlement payload for an object-hosted layout block.

object
OwnerEntityDefinitionId
string
nullable
OwnerEntityDisplayName
string
nullable
OwnerInstanceCount
integer format: int32
Items
Array<object>
nullable

Compact entitlement row rendered inside an object-hosted layout block.

object
Id
string
nullable
EntitlementNumber
integer format: int64
EntitlementModelId
string
nullable
EntitlementModelDisplayName
string
nullable
ModelType
string
nullable
EntitlementPlanId
string
nullable
EntitlementPlanDisplayName
string
nullable
OwnerEntityDefinitionId
string
nullable
OwnerEntityDisplayName
string
nullable
OwnerEntityInstanceId
string
nullable
OwnerDisplayName
string
nullable
Status
string
nullable
EffectiveState
string
nullable
StartsAtUtc
string format: date-time
EndsAtUtc
string format: date-time
nullable
IssuedAtUtc
string format: date-time
TotalCount
integer format: int32
PageSize
integer format: int32
HasRestrictedItems
boolean
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": {
"AccessModel": 0
},
"Model": {
"SummaryCard": {
"Mode": 0
},
"Form": {
"Mode": 0
},
"Sections": [
{
"TableBinding": {
"Selector": {
"Mode": 0
},
"LockedFilters": [
{
"TargetKind": 0,
"SystemField": 0,
"Operator": 0,
"ValueSource": 0
}
],
"InitialFilters": [
{
"TargetKind": 0,
"SystemField": 0,
"Operator": 0,
"ValueSource": 0
}
],
"InitialSort": [
{
"TargetKind": 0,
"SystemField": 0,
"Direction": 0
}
]
}
}
]
},
"LayoutMode": 0,
"ObjectHostedLayout": {
"Surface": 0,
"Items": [
{
"ItemKind": 0,
"BlockKind": 0,
"StandardBlock": 0,
"BindingPath": {
"Steps": [
{
"Direction": 0
}
]
}
}
]
},
"RibbonBarLayout": {
"Surface": 0
},
"WorkContext": {
"Providers": [
{
"State": 0
}
]
},
"ObjectHostedLayoutBlocks": [
{
"BlockKind": 0,
"State": 0,
"BindingPath": {
"Steps": [
{
"Direction": 0
}
]
},
"Table": {
"Surface": 0,
"Columns": [
{
"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
},
"Renderer": 0,
"Editor": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0
}
],
"Actions": [
{
"Action": 0,
"Placement": 0,
"FormSelectors": [
{
"Mode": 0
}
],
"FormSelector": {
"Mode": 0
}
}
],
"AfterCreateNavigation": 0,
"AfterUpdateNavigation": 0,
"Filters": [
{
"Reference": {
"Special": 0
},
"Placement": 0
}
],
"Sorting": {
"SortableTargets": [
{
"Reference": {
"Special": 0
}
}
],
"DefaultSort": [
{
"Field": {
"Special": 0
},
"Target": {
"Path": [
{
"Special": 0
}
]
},
"Direction": 0
}
]
}
},
"Page": {
"Items": [
{
"Fields": {
"additionalProperty": {
"State": 0
}
},
"Assignments": {
"additionalProperty": [
{
"SubjectType": 0,
"Origin": 0,
"InheritanceSource": {
"ParentRecord": {
"State": 0
}
}
}
]
}
}
],
"AssignmentRelations": [
{
"Cardinality": 0,
"SubjectMode": 0
}
]
},
"ArchiveMode": 0,
"MissingSurface": {
"SurfaceType": 0,
"Reason": 0,
"Selector": {
"Mode": 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

Runtime bootstrap payload for the drawer surface.

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
Model

Resolved drawer orchestration model.

object
SummaryCard

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
Form

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
Sections
Array<object>
nullable

One related-section definition on the drawer surface.

object
SourceEntityDefinitionId
string
nullable
SourceReferenceFieldId
string
nullable
Label
string
nullable
SortOrder
integer format: int32
Visible
boolean
TableBinding

Resolved table usage context for a hosted table surface.

object
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
PageSize
integer format: int32
nullable
LockedFilters
Array<object>
nullable

One host-level table filter preset.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
FieldId
string
nullable
FieldKey
string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Operator
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
ValueSource
integer format: int32
Allowed values: 0 1
Value
object
InitialFilters
Array<object>
nullable

One host-level table filter preset.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
FieldId
string
nullable
FieldKey
string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Operator
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
ValueSource
integer format: int32
Allowed values: 0 1
Value
object
InitialSort
Array<object>
nullable

One host-level initial sort preset for an embedded table binding.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
FieldId
string
nullable
FieldKey
string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Direction
integer format: int32
Allowed values: 0 1
LayoutMode
integer format: int32
Allowed values: 0 1
ObjectHostedLayout

Object-hosted layout for a single record details page or drawer.

object
Surface
integer format: int32
Allowed values: 0 1 2 3 4 5
Items
Array<object>
nullable

One entry in an object-hosted layout for a single record surface.

object
Id
string
nullable
ItemKind
integer format: int32
Allowed values: 0 1
BlockKind
integer format: int32
Allowed values: 0 1 2 3
StandardBlock
integer format: int32
Allowed values: 0 1 2 3 4
BindingPath

Structured binding path for special host-layout blocks.

object
RootEntityDefinitionId
string
nullable
TargetEntityDefinitionId
string
nullable
Label
string
nullable
Steps
Array<object>
nullable

One reverse-reference hop used by a special host-layout block.

object
Direction
integer format: int32
Allowed values: 0 1
SourceEntityDefinitionId
string
nullable
SourceReferenceFieldId
string
nullable
SourceReferenceFieldKey
string
nullable
TargetEntityDefinitionId
string
nullable
SourceEntityDisplayNamePlural
string
nullable
SourceReferenceFieldDisplayName
string
nullable
TargetEntityDisplayNameSingular
string
nullable
Settings
object
SettingsVersion
integer format: int32
Title
string
nullable
Subtitle
string
nullable
SortOrder
integer format: int32
Visible
boolean
CollapsedByDefault
boolean
RibbonBarLayout

Ribbon-bar signal layout for a single record details page or drawer.

object
Surface
integer format: int32
Allowed values: 0 1 2 3 4 5
Items
Array<object>
nullable

One configured ribbon-bar signal placement.

object
Id
string
nullable
SignalKey
string
nullable
Settings
object
SettingsVersion
integer format: int32
SortOrder
integer format: int32
Visible
boolean
WorkContext

Server-computed enrichment context for one entity details page.

object
Providers
Array<object>
nullable

Disclosure state and optional signal for one work-context provider.

object
ProviderKey
string
nullable
State
integer format: int32
Allowed values: 0 1 2
Signal

Compact provider signal rendered in the entity details signal strip.

object
Key
string
nullable
ProviderKey
string
nullable
TestKey
string
nullable
Icon
string
nullable
LabelText

Provider-specific compact label.

string
nullable
Title

Main signal value.

string
nullable
Subtitle

Secondary signal text.

string
nullable
Meta

Tertiary compact text.

string
nullable
Color

Theme or raw display color for the signal icon.

string
nullable
Tone

Signal tone understood by the WebApp presentation layer.

string
nullable
Count

Optional visible item count. Restricted providers must leave this null.

integer format: int32
nullable
Actions

Provider-specific action descriptors. Restricted providers must return an empty list.

Array<object>
nullable

One server-approved action attached to a work-context signal.

object
Key
string
nullable
BadgeCount

Optional badge count for this action. Restricted providers must leave this null.

integer format: int32
nullable
Data

Provider-specific public action data.

object
key
additional properties
string
nullable
Data

Provider-specific public data needed to execute signal actions.

object
key
additional properties
string
nullable
ErrorCode
string
nullable
ObjectHostedLayoutBlocks

Runtime payloads for special blocks used by Moltaro.Entity.Ui.Models.Drawer.EntityDrawerBootstrapModel.ObjectHostedLayout.

Array<object>
nullable

Runtime payload for a custom host-layout block.

object
BlockId
string
nullable
BlockKind
integer format: int32
Allowed values: 0 1 2 3
State
integer format: int32
Allowed values: 0 1 2
BindingPath

Structured binding path for special host-layout blocks.

object
RootEntityDefinitionId
string
nullable
TargetEntityDefinitionId
string
nullable
Label
string
nullable
Steps
Array<object>
nullable

One reverse-reference hop used by a special host-layout block.

object
Direction
integer format: int32
Allowed values: 0 1
SourceEntityDefinitionId
string
nullable
SourceReferenceFieldId
string
nullable
SourceReferenceFieldKey
string
nullable
TargetEntityDefinitionId
string
nullable
SourceEntityDisplayNamePlural
string
nullable
SourceReferenceFieldDisplayName
string
nullable
TargetEntityDisplayNameSingular
string
nullable
Table

Persisted table 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
DefaultPageSize

Default page size.

integer format: int32
RowVersion

Concurrency token for persisted overrides.

string format: uuid
Columns

Effective columns.

Array<object>
nullable

One persisted table column.

object
Id

Stable column identifier.

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
Label

Column label.

string
nullable
Hint

Optional user hint.

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

Whether the column should render.

boolean
Editable

Whether inline editing is enabled for the column.

boolean
Width

Preferred width in pixels.

integer format: int32
SortOrder

Display order.

integer format: int32
Projection

Read-only field projection backed by a materialized related-field path.

object
Path

Runtime field-key path from the root entity to the projected terminal field.

Array<string>
nullable
IncludePath

Runtime reference path required for materialization.

Array<string>
nullable
RootEntityFieldDefinitionId

First primary-table reference field identifier.

string
nullable
PathEntityFieldDefinitionId2

Second reference field identifier inside the first target definition when configured.

string
nullable
PathEntityFieldDefinitionId3

Third reference field identifier inside the second target definition when configured.

string
nullable
TerminalEntityFieldDefinitionId

Projected terminal field identifier inside the final target definition.

string
nullable
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
Actions

Effective row actions.

Array<object>
nullable

One table-row action configuration.

object
Id

Stable action identifier.

string
nullable
Action
integer format: int32
Allowed values: 0 1 2 3 4 5 6
Placement
integer format: int32
Allowed values: 0 1 2
SortOrder

Explicit order within the placement bucket.

integer format: int32
FormSelectors

Role-aware form selectors used by edit actions in admin configuration.

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
FormSelector

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
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
AfterCreateNavigation
integer format: int32
Allowed values: 0 1 2
AfterUpdateNavigation
integer format: int32
Allowed values: 0 1 2
RowRules

Ordered row appearance rules for explicit surfaces.

Array<object>
nullable

Runtime table row appearance rule.

object
StatementId

Statement identifier used against instance predicates.

string
nullable
SortOrder

Stable evaluation order; the first matching rule wins.

integer format: int32
FontColor

Optional CSS font color applied to the whole row.

string
nullable
BackgroundColor

Optional CSS background color applied to the whole row.

string
nullable
Filters

Filter targets and their table-surface placement.

Array<object>
nullable

One table-surface filter target exposed to the web client.

object
Id
string
nullable
Label
string
nullable
Reference

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Placement
integer format: int32
Allowed values: 0 1 2
Sorting

Table-surface sorting capabilities exposed to the web client.

object
AllowMultiSort
boolean
SortableTargets
Array<object>
nullable

One table-surface sort target exposed to the web client.

object
Id
string
nullable
Label
string
nullable
Reference

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
DefaultSort
Array<object>
nullable

One sort item in the runtime list query.

object
Field

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Target

Typed target path for a runtime list query sort item.

object
Path

Reference path from the queried entity to the sortable terminal field or system field.

Array<object>
nullable

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

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

Paginated entity-instance response for one runtime entity definition.

object
Items

Current page of instance summaries.

Array<object>
nullable

List item for one entity instance.

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. List payloads include the first few tags only.

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

Primary-table scalar fields keyed by field key. User and role fields return compact reference models. Restricted fields are returned with Moltaro.Enums.EntityInstanceFieldStateEnum.Restricted.

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

Display-only source member metadata for a projection row.

object
ProjectionMemberId
string
nullable
ReferenceFieldId
string
nullable
SourceEntityDefinitionId
string
nullable
Label
string
nullable
SourceEntityDisplayNameSingular
string
nullable
SourceEntityDisplayNamePlural
string
nullable
ObjectContextFacts

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

object
key
additional properties
object
TotalCount

Total accessible instance count for the active page filter.

integer format: int32
Page

One-based page number.

integer format: int32
PageSize

Requested page size after normalization.

integer format: int32
Permissions

Page-level permissions for entity instances.

object
CanCreate

Whether the caller can create a new instance for this entity definition.

boolean
CanReadActive

Whether the caller can read active instances for this entity definition.

boolean
CanReadArchive

Whether the caller can read archived instances for this entity definition.

boolean
CanReadChangesHistory

Whether the caller can read change history for this entity definition.

boolean
CanMerge

Whether the caller can potentially merge records for this entity definition.

boolean
AssignmentRelations

Runtime relation metadata for record-scoped assignment columns.

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
ArchiveMode
integer format: int32
Allowed values: 0 1 2
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
ErrorCode
string
nullable
CreateAction

Server-computed contextual create action for a direct related-data section.

object
CanCreate
boolean
TargetEntityDefinitionId
string
nullable
TargetEntityDisplayNameSingular
string
nullable
LockedFields
object
key
additional properties
string
Entitlements

Owner-side runtime entitlement payload for an object-hosted layout block.

object
OwnerEntityDefinitionId
string
nullable
OwnerEntityDisplayName
string
nullable
OwnerInstanceCount
integer format: int32
Items
Array<object>
nullable

Compact entitlement row rendered inside an object-hosted layout block.

object
Id
string
nullable
EntitlementNumber
integer format: int64
EntitlementModelId
string
nullable
EntitlementModelDisplayName
string
nullable
ModelType
string
nullable
EntitlementPlanId
string
nullable
EntitlementPlanDisplayName
string
nullable
OwnerEntityDefinitionId
string
nullable
OwnerEntityDisplayName
string
nullable
OwnerEntityInstanceId
string
nullable
OwnerDisplayName
string
nullable
Status
string
nullable
EffectiveState
string
nullable
StartsAtUtc
string format: date-time
EndsAtUtc
string format: date-time
nullable
IssuedAtUtc
string format: date-time
TotalCount
integer format: int32
PageSize
integer format: int32
HasRestrictedItems
boolean
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": {
"AccessModel": 0
},
"Model": {
"SummaryCard": {
"Mode": 0
},
"Form": {
"Mode": 0
},
"Sections": [
{
"TableBinding": {
"Selector": {
"Mode": 0
},
"LockedFilters": [
{
"TargetKind": 0,
"SystemField": 0,
"Operator": 0,
"ValueSource": 0
}
],
"InitialFilters": [
{
"TargetKind": 0,
"SystemField": 0,
"Operator": 0,
"ValueSource": 0
}
],
"InitialSort": [
{
"TargetKind": 0,
"SystemField": 0,
"Direction": 0
}
]
}
}
]
},
"LayoutMode": 0,
"ObjectHostedLayout": {
"Surface": 0,
"Items": [
{
"ItemKind": 0,
"BlockKind": 0,
"StandardBlock": 0,
"BindingPath": {
"Steps": [
{
"Direction": 0
}
]
}
}
]
},
"RibbonBarLayout": {
"Surface": 0
},
"WorkContext": {
"Providers": [
{
"State": 0
}
]
},
"ObjectHostedLayoutBlocks": [
{
"BlockKind": 0,
"State": 0,
"BindingPath": {
"Steps": [
{
"Direction": 0
}
]
},
"Table": {
"Surface": 0,
"Columns": [
{
"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
},
"Renderer": 0,
"Editor": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0
}
],
"Actions": [
{
"Action": 0,
"Placement": 0,
"FormSelectors": [
{
"Mode": 0
}
],
"FormSelector": {
"Mode": 0
}
}
],
"AfterCreateNavigation": 0,
"AfterUpdateNavigation": 0,
"Filters": [
{
"Reference": {
"Special": 0
},
"Placement": 0
}
],
"Sorting": {
"SortableTargets": [
{
"Reference": {
"Special": 0
}
}
],
"DefaultSort": [
{
"Field": {
"Special": 0
},
"Target": {
"Path": [
{
"Special": 0
}
]
},
"Direction": 0
}
]
}
},
"Page": {
"Items": [
{
"Fields": {
"additionalProperty": {
"State": 0
}
},
"Assignments": {
"additionalProperty": [
{
"SubjectType": 0,
"Origin": 0,
"InheritanceSource": {
"ParentRecord": {
"State": 0
}
}
}
]
}
}
],
"AssignmentRelations": [
{
"Cardinality": 0,
"SubjectMode": 0
}
]
},
"ArchiveMode": 0,
"MissingSurface": {
"SurfaceType": 0,
"Reason": 0,
"Selector": {
"Mode": 0
}
}
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Conflict

Media typeapplication/json
object
Data

Runtime bootstrap payload for the drawer surface.

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
Model

Resolved drawer orchestration model.

object
SummaryCard

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
Form

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
Sections
Array<object>
nullable

One related-section definition on the drawer surface.

object
SourceEntityDefinitionId
string
nullable
SourceReferenceFieldId
string
nullable
Label
string
nullable
SortOrder
integer format: int32
Visible
boolean
TableBinding

Resolved table usage context for a hosted table surface.

object
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
PageSize
integer format: int32
nullable
LockedFilters
Array<object>
nullable

One host-level table filter preset.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
FieldId
string
nullable
FieldKey
string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Operator
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
ValueSource
integer format: int32
Allowed values: 0 1
Value
object
InitialFilters
Array<object>
nullable

One host-level table filter preset.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
FieldId
string
nullable
FieldKey
string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Operator
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
ValueSource
integer format: int32
Allowed values: 0 1
Value
object
InitialSort
Array<object>
nullable

One host-level initial sort preset for an embedded table binding.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
FieldId
string
nullable
FieldKey
string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Direction
integer format: int32
Allowed values: 0 1
LayoutMode
integer format: int32
Allowed values: 0 1
ObjectHostedLayout

Object-hosted layout for a single record details page or drawer.

object
Surface
integer format: int32
Allowed values: 0 1 2 3 4 5
Items
Array<object>
nullable

One entry in an object-hosted layout for a single record surface.

object
Id
string
nullable
ItemKind
integer format: int32
Allowed values: 0 1
BlockKind
integer format: int32
Allowed values: 0 1 2 3
StandardBlock
integer format: int32
Allowed values: 0 1 2 3 4
BindingPath

Structured binding path for special host-layout blocks.

object
RootEntityDefinitionId
string
nullable
TargetEntityDefinitionId
string
nullable
Label
string
nullable
Steps
Array<object>
nullable

One reverse-reference hop used by a special host-layout block.

object
Direction
integer format: int32
Allowed values: 0 1
SourceEntityDefinitionId
string
nullable
SourceReferenceFieldId
string
nullable
SourceReferenceFieldKey
string
nullable
TargetEntityDefinitionId
string
nullable
SourceEntityDisplayNamePlural
string
nullable
SourceReferenceFieldDisplayName
string
nullable
TargetEntityDisplayNameSingular
string
nullable
Settings
object
SettingsVersion
integer format: int32
Title
string
nullable
Subtitle
string
nullable
SortOrder
integer format: int32
Visible
boolean
CollapsedByDefault
boolean
RibbonBarLayout

Ribbon-bar signal layout for a single record details page or drawer.

object
Surface
integer format: int32
Allowed values: 0 1 2 3 4 5
Items
Array<object>
nullable

One configured ribbon-bar signal placement.

object
Id
string
nullable
SignalKey
string
nullable
Settings
object
SettingsVersion
integer format: int32
SortOrder
integer format: int32
Visible
boolean
WorkContext

Server-computed enrichment context for one entity details page.

object
Providers
Array<object>
nullable

Disclosure state and optional signal for one work-context provider.

object
ProviderKey
string
nullable
State
integer format: int32
Allowed values: 0 1 2
Signal

Compact provider signal rendered in the entity details signal strip.

object
Key
string
nullable
ProviderKey
string
nullable
TestKey
string
nullable
Icon
string
nullable
LabelText

Provider-specific compact label.

string
nullable
Title

Main signal value.

string
nullable
Subtitle

Secondary signal text.

string
nullable
Meta

Tertiary compact text.

string
nullable
Color

Theme or raw display color for the signal icon.

string
nullable
Tone

Signal tone understood by the WebApp presentation layer.

string
nullable
Count

Optional visible item count. Restricted providers must leave this null.

integer format: int32
nullable
Actions

Provider-specific action descriptors. Restricted providers must return an empty list.

Array<object>
nullable

One server-approved action attached to a work-context signal.

object
Key
string
nullable
BadgeCount

Optional badge count for this action. Restricted providers must leave this null.

integer format: int32
nullable
Data

Provider-specific public action data.

object
key
additional properties
string
nullable
Data

Provider-specific public data needed to execute signal actions.

object
key
additional properties
string
nullable
ErrorCode
string
nullable
ObjectHostedLayoutBlocks

Runtime payloads for special blocks used by Moltaro.Entity.Ui.Models.Drawer.EntityDrawerBootstrapModel.ObjectHostedLayout.

Array<object>
nullable

Runtime payload for a custom host-layout block.

object
BlockId
string
nullable
BlockKind
integer format: int32
Allowed values: 0 1 2 3
State
integer format: int32
Allowed values: 0 1 2
BindingPath

Structured binding path for special host-layout blocks.

object
RootEntityDefinitionId
string
nullable
TargetEntityDefinitionId
string
nullable
Label
string
nullable
Steps
Array<object>
nullable

One reverse-reference hop used by a special host-layout block.

object
Direction
integer format: int32
Allowed values: 0 1
SourceEntityDefinitionId
string
nullable
SourceReferenceFieldId
string
nullable
SourceReferenceFieldKey
string
nullable
TargetEntityDefinitionId
string
nullable
SourceEntityDisplayNamePlural
string
nullable
SourceReferenceFieldDisplayName
string
nullable
TargetEntityDisplayNameSingular
string
nullable
Table

Persisted table 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
DefaultPageSize

Default page size.

integer format: int32
RowVersion

Concurrency token for persisted overrides.

string format: uuid
Columns

Effective columns.

Array<object>
nullable

One persisted table column.

object
Id

Stable column identifier.

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
Label

Column label.

string
nullable
Hint

Optional user hint.

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

Whether the column should render.

boolean
Editable

Whether inline editing is enabled for the column.

boolean
Width

Preferred width in pixels.

integer format: int32
SortOrder

Display order.

integer format: int32
Projection

Read-only field projection backed by a materialized related-field path.

object
Path

Runtime field-key path from the root entity to the projected terminal field.

Array<string>
nullable
IncludePath

Runtime reference path required for materialization.

Array<string>
nullable
RootEntityFieldDefinitionId

First primary-table reference field identifier.

string
nullable
PathEntityFieldDefinitionId2

Second reference field identifier inside the first target definition when configured.

string
nullable
PathEntityFieldDefinitionId3

Third reference field identifier inside the second target definition when configured.

string
nullable
TerminalEntityFieldDefinitionId

Projected terminal field identifier inside the final target definition.

string
nullable
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
Actions

Effective row actions.

Array<object>
nullable

One table-row action configuration.

object
Id

Stable action identifier.

string
nullable
Action
integer format: int32
Allowed values: 0 1 2 3 4 5 6
Placement
integer format: int32
Allowed values: 0 1 2
SortOrder

Explicit order within the placement bucket.

integer format: int32
FormSelectors

Role-aware form selectors used by edit actions in admin configuration.

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
FormSelector

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
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
AfterCreateNavigation
integer format: int32
Allowed values: 0 1 2
AfterUpdateNavigation
integer format: int32
Allowed values: 0 1 2
RowRules

Ordered row appearance rules for explicit surfaces.

Array<object>
nullable

Runtime table row appearance rule.

object
StatementId

Statement identifier used against instance predicates.

string
nullable
SortOrder

Stable evaluation order; the first matching rule wins.

integer format: int32
FontColor

Optional CSS font color applied to the whole row.

string
nullable
BackgroundColor

Optional CSS background color applied to the whole row.

string
nullable
Filters

Filter targets and their table-surface placement.

Array<object>
nullable

One table-surface filter target exposed to the web client.

object
Id
string
nullable
Label
string
nullable
Reference

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Placement
integer format: int32
Allowed values: 0 1 2
Sorting

Table-surface sorting capabilities exposed to the web client.

object
AllowMultiSort
boolean
SortableTargets
Array<object>
nullable

One table-surface sort target exposed to the web client.

object
Id
string
nullable
Label
string
nullable
Reference

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
DefaultSort
Array<object>
nullable

One sort item in the runtime list query.

object
Field

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Target

Typed target path for a runtime list query sort item.

object
Path

Reference path from the queried entity to the sortable terminal field or system field.

Array<object>
nullable

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

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

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

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

Paginated entity-instance response for one runtime entity definition.

object
Items

Current page of instance summaries.

Array<object>
nullable

List item for one entity instance.

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. List payloads include the first few tags only.

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

Primary-table scalar fields keyed by field key. User and role fields return compact reference models. Restricted fields are returned with Moltaro.Enums.EntityInstanceFieldStateEnum.Restricted.

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

Display-only source member metadata for a projection row.

object
ProjectionMemberId
string
nullable
ReferenceFieldId
string
nullable
SourceEntityDefinitionId
string
nullable
Label
string
nullable
SourceEntityDisplayNameSingular
string
nullable
SourceEntityDisplayNamePlural
string
nullable
ObjectContextFacts

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

object
key
additional properties
object
TotalCount

Total accessible instance count for the active page filter.

integer format: int32
Page

One-based page number.

integer format: int32
PageSize

Requested page size after normalization.

integer format: int32
Permissions

Page-level permissions for entity instances.

object
CanCreate

Whether the caller can create a new instance for this entity definition.

boolean
CanReadActive

Whether the caller can read active instances for this entity definition.

boolean
CanReadArchive

Whether the caller can read archived instances for this entity definition.

boolean
CanReadChangesHistory

Whether the caller can read change history for this entity definition.

boolean
CanMerge

Whether the caller can potentially merge records for this entity definition.

boolean
AssignmentRelations

Runtime relation metadata for record-scoped assignment columns.

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
ArchiveMode
integer format: int32
Allowed values: 0 1 2
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
ErrorCode
string
nullable
CreateAction

Server-computed contextual create action for a direct related-data section.

object
CanCreate
boolean
TargetEntityDefinitionId
string
nullable
TargetEntityDisplayNameSingular
string
nullable
LockedFields
object
key
additional properties
string
Entitlements

Owner-side runtime entitlement payload for an object-hosted layout block.

object
OwnerEntityDefinitionId
string
nullable
OwnerEntityDisplayName
string
nullable
OwnerInstanceCount
integer format: int32
Items
Array<object>
nullable

Compact entitlement row rendered inside an object-hosted layout block.

object
Id
string
nullable
EntitlementNumber
integer format: int64
EntitlementModelId
string
nullable
EntitlementModelDisplayName
string
nullable
ModelType
string
nullable
EntitlementPlanId
string
nullable
EntitlementPlanDisplayName
string
nullable
OwnerEntityDefinitionId
string
nullable
OwnerEntityDisplayName
string
nullable
OwnerEntityInstanceId
string
nullable
OwnerDisplayName
string
nullable
Status
string
nullable
EffectiveState
string
nullable
StartsAtUtc
string format: date-time
EndsAtUtc
string format: date-time
nullable
IssuedAtUtc
string format: date-time
TotalCount
integer format: int32
PageSize
integer format: int32
HasRestrictedItems
boolean
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": {
"AccessModel": 0
},
"Model": {
"SummaryCard": {
"Mode": 0
},
"Form": {
"Mode": 0
},
"Sections": [
{
"TableBinding": {
"Selector": {
"Mode": 0
},
"LockedFilters": [
{
"TargetKind": 0,
"SystemField": 0,
"Operator": 0,
"ValueSource": 0
}
],
"InitialFilters": [
{
"TargetKind": 0,
"SystemField": 0,
"Operator": 0,
"ValueSource": 0
}
],
"InitialSort": [
{
"TargetKind": 0,
"SystemField": 0,
"Direction": 0
}
]
}
}
]
},
"LayoutMode": 0,
"ObjectHostedLayout": {
"Surface": 0,
"Items": [
{
"ItemKind": 0,
"BlockKind": 0,
"StandardBlock": 0,
"BindingPath": {
"Steps": [
{
"Direction": 0
}
]
}
}
]
},
"RibbonBarLayout": {
"Surface": 0
},
"WorkContext": {
"Providers": [
{
"State": 0
}
]
},
"ObjectHostedLayoutBlocks": [
{
"BlockKind": 0,
"State": 0,
"BindingPath": {
"Steps": [
{
"Direction": 0
}
]
},
"Table": {
"Surface": 0,
"Columns": [
{
"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
},
"Renderer": 0,
"Editor": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0
}
],
"Actions": [
{
"Action": 0,
"Placement": 0,
"FormSelectors": [
{
"Mode": 0
}
],
"FormSelector": {
"Mode": 0
}
}
],
"AfterCreateNavigation": 0,
"AfterUpdateNavigation": 0,
"Filters": [
{
"Reference": {
"Special": 0
},
"Placement": 0
}
],
"Sorting": {
"SortableTargets": [
{
"Reference": {
"Special": 0
}
}
],
"DefaultSort": [
{
"Field": {
"Special": 0
},
"Target": {
"Path": [
{
"Special": 0
}
]
},
"Direction": 0
}
]
}
},
"Page": {
"Items": [
{
"Fields": {
"additionalProperty": {
"State": 0
}
},
"Assignments": {
"additionalProperty": [
{
"SubjectType": 0,
"Origin": 0,
"InheritanceSource": {
"ParentRecord": {
"State": 0
}
}
}
]
}
}
],
"AssignmentRelations": [
{
"Cardinality": 0,
"SubjectMode": 0
}
]
},
"ArchiveMode": 0,
"MissingSurface": {
"SurfaceType": 0,
"Reason": 0,
"Selector": {
"Mode": 0
}
}
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}