Skip to content
MoltaroMoltaroMoltaro Docs

Replace the explicit table surface configuration for one table surface.

PUT
/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/table-surfaces/{surfaceKey}/configuration
curl --request PUT \
  --url https://example.com/api/workspace/admin/entity-definitions/example/ui/table-surfaces/example/configuration \
  --header 'Content-Type: application/json' \
  --data '{ "CreateFormSelectors": [ { "Id": "example", "Priority": 1, "Mode": 0, "SurfaceKey": "example", "RoleIds": [ "example" ] } ], "EditFormSelectors": [ { "Id": "example", "Priority": 1, "Mode": 0, "SurfaceKey": "example", "RoleIds": [ "example" ] } ], "DrawerSelectors": [ { "Id": "example", "Priority": 1, "Mode": 0, "SurfaceKey": "example", "RoleIds": [ "example" ] } ], "DetailsPageSelectors": [ { "Id": "example", "Priority": 1, "Mode": 0, "SurfaceKey": "example", "RoleIds": [ "example" ] } ], "AfterCreateNavigation": 0, "AfterUpdateNavigation": 0, "Actions": [ { "Id": "example", "Action": 0, "Placement": 0, "SortOrder": 1, "FormSelectors": [ { "Id": "example", "Priority": 1, "Mode": 0, "SurfaceKey": "example", "RoleIds": [ "example" ] } ], "FormSelector": { "Mode": 0, "SurfaceKey": "example" } } ], "Columns": [ { "Target": { "TargetKind": 0, "EntityFieldDefinitionId": "example", "DisplayFieldId": "example", "ObjectContextFactId": "example", "SystemField": 0, "ResponsibilityKey": "example" }, "Label": "example", "SortOrder": 1, "Visible": true, "Width": 1, "Renderer": 0, "ReferenceInputType": 0, "ReferenceRendererType": 0, "ReferenceLookupRenderType": 0, "ReferencePath": [ "example" ], "ReferenceOpenTarget": { "Target": 0, "SurfaceSelectors": [ { "Id": "example", "Priority": 1, "Mode": 0, "SurfaceKey": "example", "RoleIds": [ "example" ] } ] } } ], "ProjectionColumns": [ { "RootEntityFieldDefinitionId": "example", "PathEntityFieldDefinitionId2": "example", "PathEntityFieldDefinitionId3": "example", "TerminalEntityFieldDefinitionId": "example", "Label": "example", "SortOrder": 1, "Visible": true, "Width": 1, "Renderer": 0 } ], "RowRules": [ { "StatementId": "example", "SortOrder": 1, "FontColor": "example", "BackgroundColor": "example" } ], "FilterItems": [ { "Target": { "TargetKind": 0, "Path": [ { "EntityFieldDefinitionId": "example", "EntityFieldKey": "example", "SystemField": 0, "Special": 0 } ], "StatementId": "example", "StatementName": "example", "ObjectContextFactId": "example", "ObjectContextFactFilterKey": "example" }, "Label": "example", "Visible": true, "VisibleByDefault": true, "ReferenceInputType": 0, "ReferenceRendererType": 0, "ReferenceLookupRenderType": 0, "ReferencePath": [ "example" ], "ReferenceHierarchy": { "SourceKind": 0, "ParentFieldDefinitionId": "example", "ParentFieldKey": "example" }, "SortOrder": 1 } ], "SortItems": [ { "Target": { "Path": [ { "EntityFieldDefinitionId": "example", "EntityFieldKey": "example", "SystemField": 0, "Special": 0 } ] }, "Label": "example", "Visible": true, "SortOrder": 1 } ], "DefaultSort": [ { "Target": { "Path": [ { "EntityFieldDefinitionId": "example", "EntityFieldKey": "example", "SystemField": 0, "Special": 0 } ] }, "Direction": 0, "SortOrder": 1 } ], "TreeView": { "ParentFieldDefinitionId": "example", "ParentFieldKey": "example", "SortFieldDefinitionId": "example", "SortFieldKey": "example", "SortSpecial": 0, "SortDirection": 0 } }'

Authorizations

Section titled “Authorizations”
  • None

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
entityDefinitionId
required
string
surfaceKey
required
string

Query Parameters

Section titled “Query Parameters”
access_token
string

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

Request Body

Section titled “Request Body”

Request payload to replace the table surface configuration.

object
CreateFormSelectors

Role-aware form selectors used by table-scoped create flows.

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
EditFormSelectors

Role-aware default form selectors used by table edit actions without an override.

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
DrawerSelectors

Role-aware drawer selectors used by preview actions and post-form navigation.

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
DetailsPageSelectors

Role-aware details-page selectors used by open actions and post-form navigation.

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

Explicit row actions available on this table surface.

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
Columns

Explicit column configuration keyed by stable target anchors.

Array<object>
nullable

Explicit table column override keyed by a stable target anchor.

object
Target

Stable field, system-field, or relation target for table column configuration.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
EntityFieldDefinitionId

Entity field id when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.EntityField.

string
nullable
DisplayFieldId

Display field id when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.DisplayField.

string
nullable
ObjectContextFactId

Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.ObjectContextFact.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
ResponsibilityKey

Stable responsibility key when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Responsibility.

string
nullable
Label

Override label, or null to use the surface default.

string
nullable
SortOrder

Override sort order, or null to use the surface default.

integer format: int32
nullable
Visible

Override visibility, or null to use the surface default.

boolean
nullable
Width

Override width, or null to use the surface default.

integer format: int32
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
ReferenceInputType
integer format: int32
Allowed values: 0 1 2 3
ReferenceRendererType
integer format: int32
Allowed values: 0 1
ReferenceLookupRenderType
integer format: int32
Allowed values: 0 1
ReferencePath

Reference path configured for breadcrumb rendering.

Array<string>
nullable
ReferenceOpenTarget

Configured reference open target and role-aware target-surface selectors.

object
Target
integer format: int32
Allowed values: 0 1
SurfaceSelectors

Role-aware target-surface selectors.

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
ProjectionColumns

Explicit related-record projection columns shown after root table columns.

Array<object>
nullable

Explicit table projection column keyed by a typed reference path.

object
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
Label

Override label, or null to use the default reference path label.

string
nullable
SortOrder

Projection column sort order.

integer format: int32
Visible

Whether the projection column is visible.

boolean
Width

Projection column width.

integer format: int32
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
RowRules

Explicit table row highlight rules.

Array<object>
nullable

Explicit table row highlight rule keyed by statement id.

object
StatementId

Statement identifier.

string
nullable
SortOrder

Rule sort order.

integer format: int32
FontColor

Optional font color override.

string
nullable
BackgroundColor

Optional background color override.

string
nullable
FilterItems

Ordered filter items available for this table surface.

Array<object>
nullable

One explicit table-surface runtime filter item.

object
Target

Stable query target for table-surface filter configuration.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
Path

Ordered query path for field and system-field targets. Intermediate segments must be readable primary-table reference fields. This path controls filtering and is independent from the filter item’s ReferencePath, which controls lookup breadcrumb rendering.

Array<object>
nullable

One field or system-field segment in a table-surface filter or sort query path.

object
EntityFieldDefinitionId

Entity field id for a reference or terminal entity-field segment.

string
nullable
EntityFieldKey

Entity field key for admin disambiguation and portable request inspection.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Special
integer format: int32
Allowed values: 0 1
StatementId

Statement id when Moltaro.Entity.Ui.Models.EntityUiTableSurfaceFilterTargetAdminModel.TargetKind is Moltaro.Enums.EntityInstanceQueryOptionKindEnum.Statement.

string
nullable
StatementName

Statement name for admin disambiguation and portable request inspection.

string
nullable
ObjectContextFactId

Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiTableSurfaceFilterTargetAdminModel.TargetKind is Moltaro.Enums.EntityInstanceQueryOptionKindEnum.ObjectContextFact.

string
nullable
ObjectContextFactFilterKey

Provider-owned filter facet key when Moltaro.Entity.Ui.Models.EntityUiTableSurfaceFilterTargetAdminModel.TargetKind is Moltaro.Enums.EntityInstanceQueryOptionKindEnum.ObjectContextFact.

string
nullable
Label

Override label, or null to use the target display label.

string
nullable
Visible

Whether this filter is available in the runtime filter drawer add menu.

boolean
VisibleByDefault

Whether this filter appears immediately in the runtime side panel.

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

Reference path configured for breadcrumb rendering.

Array<string>
nullable
ReferenceHierarchy

Saved relationship shape for one hierarchy reference input.

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

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

string
nullable
ParentFieldKey

Recursive parent stable field key used by portable configuration.

string
nullable
SortOrder

Filter item display order.

integer format: int32
SortItems

Ordered sort items available for this table surface.

Array<object>
nullable

One explicit table-surface runtime sort item.

object
Target

Stable sortable path for table-surface sort configuration.

object
Path

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

Array<object>
nullable

One field or system-field segment in a table-surface filter or sort query path.

object
EntityFieldDefinitionId

Entity field id for a reference or terminal entity-field segment.

string
nullable
EntityFieldKey

Entity field key for admin disambiguation and portable request inspection.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Special
integer format: int32
Allowed values: 0 1
Label

Override label, or null to use the target display label.

string
nullable
Visible

Whether this sort target is available in the runtime sorting drawer.

boolean
SortOrder

Sort item display order.

integer format: int32
DefaultSort

Default runtime data explorer sort sequence for this table surface.

Array<object>
nullable

One default table-surface runtime sort item.

object
Target

Stable sortable path for table-surface sort configuration.

object
Path

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

Array<object>
nullable

One field or system-field segment in a table-surface filter or sort query path.

object
EntityFieldDefinitionId

Entity field id for a reference or terminal entity-field segment.

string
nullable
EntityFieldKey

Entity field key for admin disambiguation and portable request inspection.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Special
integer format: int32
Allowed values: 0 1
Direction
integer format: int32
Allowed values: 0 1
SortOrder

Default sort display order.

integer format: int32
TreeView

Parent hierarchy configuration for one table surface.

object
ParentFieldDefinitionId
required

Stable parent field identifier.

string
ParentFieldKey
required

Stable parent field key used by portable configuration.

string
SortFieldDefinitionId

Stable sibling sort field identifier, or null to sort siblings by Display name.

string
nullable
SortFieldKey

Stable sibling sort field key used by portable configuration.

string
nullable
SortSpecial
integer format: int32
Allowed values: 0 1
SortDirection
integer format: int32
Allowed values: 0 1

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

Admin-facing table surface configuration.

object
Meta

Minimal runtime entity metadata used by explicit UI surfaces.

object
EntityDefinitionId

Entity definition identifier.

string
nullable
Name

Internal entity key used by runtime routes.

string
nullable
DisplayNameSingular

User-facing singular name.

string
nullable
DisplayNamePlural

User-facing plural name.

string
nullable
CommentsEnabled

Whether entity comments are enabled.

boolean
AttachmentsEnabled

Whether entity attachments are enabled.

boolean
TagsEnabled

Whether entity tags are enabled.

boolean
FullTextSearchAvailable

Whether runtime configured search is available for the definition.

boolean
Statements

Runtime-exposed statements for this entity.

Array<object>
nullable

Runtime statement descriptor exposed to clients together with predicate payloads.

object
Id

Statement identifier.

string
nullable
Name

Stable technical statement key.

string
nullable
DisplayName

User-facing statement label.

string
nullable
RuleEvaluationContext

Rule evaluation context shared with fast UI runtime evaluation.

object
CurrentUserId

Current workspace user identifier.

string
nullable
CurrentLocalDate

Workspace-local current date in ISO format.

string
nullable
TimeZone

Workspace time zone identifier.

string
nullable
GeneratedAtUtc

UTC instant when the context was generated.

string format: date-time
nullable
NextLocalMidnightUtc

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

string format: date-time
nullable
ContextValues

Owner-scoped runtime values available to rule plans.

object
key
additional properties
object
IsProjection

Whether the entity is an enabled Projection Entity.

boolean
SurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
SurfaceId

Persisted table surface identifier.

string
nullable
Name

Table surface name.

string
nullable
Key

Table surface key.

string
nullable
IsDefault

Whether this table surface is the current default table.

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

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

string
nullable
SourcePackageId

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

string
nullable
SourceStableId

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

string
nullable
CreateFormSelectors

Role-aware form selectors used by table-scoped create flows.

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
EditFormSelectors

Role-aware default form selectors used by table edit actions without an override.

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
DrawerSelectors

Role-aware drawer selectors used by preview actions and post-form navigation.

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
DetailsPageSelectors

Role-aware details-page selectors used by open actions and post-form navigation.

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

Explicit row actions available on this table surface.

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
Columns

Explicit column overrides keyed by stable target anchors.

Array<object>
nullable

Explicit table column override keyed by a stable target anchor.

object
Target

Stable field, system-field, or relation target for table column configuration.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
EntityFieldDefinitionId

Entity field id when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.EntityField.

string
nullable
DisplayFieldId

Display field id when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.DisplayField.

string
nullable
ObjectContextFactId

Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.ObjectContextFact.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
ResponsibilityKey

Stable responsibility key when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Responsibility.

string
nullable
Label

Override label, or null to use the surface default.

string
nullable
SortOrder

Override sort order, or null to use the surface default.

integer format: int32
nullable
Visible

Override visibility, or null to use the surface default.

boolean
nullable
Width

Override width, or null to use the surface default.

integer format: int32
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
ReferenceInputType
integer format: int32
Allowed values: 0 1 2 3
ReferenceRendererType
integer format: int32
Allowed values: 0 1
ReferenceLookupRenderType
integer format: int32
Allowed values: 0 1
ReferencePath

Reference path configured for breadcrumb rendering.

Array<string>
nullable
ReferenceOpenTarget

Configured reference open target and role-aware target-surface selectors.

object
Target
integer format: int32
Allowed values: 0 1
SurfaceSelectors

Role-aware target-surface selectors.

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
ProjectionColumns

Explicit related-record projection columns shown after root table columns.

Array<object>
nullable

Explicit table projection column keyed by a typed reference path.

object
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
Label

Override label, or null to use the default reference path label.

string
nullable
SortOrder

Projection column sort order.

integer format: int32
Visible

Whether the projection column is visible.

boolean
Width

Projection column width.

integer format: int32
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
RowRules

Explicit table row highlight rules.

Array<object>
nullable

Explicit table row highlight rule keyed by statement id.

object
StatementId

Statement identifier.

string
nullable
SortOrder

Rule sort order.

integer format: int32
FontColor

Optional font color override.

string
nullable
BackgroundColor

Optional background color override.

string
nullable
FilterItems

Ordered filter items available for this table surface.

Array<object>
nullable

One explicit table-surface runtime filter item.

object
Target

Stable query target for table-surface filter configuration.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
Path

Ordered query path for field and system-field targets. Intermediate segments must be readable primary-table reference fields. This path controls filtering and is independent from the filter item’s ReferencePath, which controls lookup breadcrumb rendering.

Array<object>
nullable

One field or system-field segment in a table-surface filter or sort query path.

object
EntityFieldDefinitionId

Entity field id for a reference or terminal entity-field segment.

string
nullable
EntityFieldKey

Entity field key for admin disambiguation and portable request inspection.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Special
integer format: int32
Allowed values: 0 1
StatementId

Statement id when Moltaro.Entity.Ui.Models.EntityUiTableSurfaceFilterTargetAdminModel.TargetKind is Moltaro.Enums.EntityInstanceQueryOptionKindEnum.Statement.

string
nullable
StatementName

Statement name for admin disambiguation and portable request inspection.

string
nullable
ObjectContextFactId

Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiTableSurfaceFilterTargetAdminModel.TargetKind is Moltaro.Enums.EntityInstanceQueryOptionKindEnum.ObjectContextFact.

string
nullable
ObjectContextFactFilterKey

Provider-owned filter facet key when Moltaro.Entity.Ui.Models.EntityUiTableSurfaceFilterTargetAdminModel.TargetKind is Moltaro.Enums.EntityInstanceQueryOptionKindEnum.ObjectContextFact.

string
nullable
Label

Override label, or null to use the target display label.

string
nullable
Visible

Whether this filter is available in the runtime filter drawer add menu.

boolean
VisibleByDefault

Whether this filter appears immediately in the runtime side panel.

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

Reference path configured for breadcrumb rendering.

Array<string>
nullable
ReferenceHierarchy

Saved relationship shape for one hierarchy reference input.

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

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

string
nullable
ParentFieldKey

Recursive parent stable field key used by portable configuration.

string
nullable
SortOrder

Filter item display order.

integer format: int32
SortItems

Ordered sort items available for this table surface.

Array<object>
nullable

One explicit table-surface runtime sort item.

object
Target

Stable sortable path for table-surface sort configuration.

object
Path

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

Array<object>
nullable

One field or system-field segment in a table-surface filter or sort query path.

object
EntityFieldDefinitionId

Entity field id for a reference or terminal entity-field segment.

string
nullable
EntityFieldKey

Entity field key for admin disambiguation and portable request inspection.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Special
integer format: int32
Allowed values: 0 1
Label

Override label, or null to use the target display label.

string
nullable
Visible

Whether this sort target is available in the runtime sorting drawer.

boolean
SortOrder

Sort item display order.

integer format: int32
DefaultSort

Configured default sort sequence for this table surface.

Array<object>
nullable

One default table-surface runtime sort item.

object
Target

Stable sortable path for table-surface sort configuration.

object
Path

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

Array<object>
nullable

One field or system-field segment in a table-surface filter or sort query path.

object
EntityFieldDefinitionId

Entity field id for a reference or terminal entity-field segment.

string
nullable
EntityFieldKey

Entity field key for admin disambiguation and portable request inspection.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Special
integer format: int32
Allowed values: 0 1
Direction
integer format: int32
Allowed values: 0 1
SortOrder

Default sort display order.

integer format: int32
TreeView

Parent hierarchy configuration for one table surface.

object
ParentFieldDefinitionId
required

Stable parent field identifier.

string
ParentFieldKey
required

Stable parent field key used by portable configuration.

string
SortFieldDefinitionId

Stable sibling sort field identifier, or null to sort siblings by Display name.

string
nullable
SortFieldKey

Stable sibling sort field key used by portable configuration.

string
nullable
SortSpecial
integer format: int32
Allowed values: 0 1
SortDirection
integer format: int32
Allowed values: 0 1
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": {
    "SurfaceType": 0,
    "Source": 0,
    "CreateFormSelectors": [
      {
        "Mode": 0
      }
    ],
    "EditFormSelectors": [
      {
        "Mode": 0
      }
    ],
    "DrawerSelectors": [
      {
        "Mode": 0
      }
    ],
    "DetailsPageSelectors": [
      {
        "Mode": 0
      }
    ],
    "AfterCreateNavigation": 0,
    "AfterUpdateNavigation": 0,
    "Actions": [
      {
        "Action": 0,
        "Placement": 0,
        "FormSelectors": [
          {
            "Mode": 0
          }
        ],
        "FormSelector": {
          "Mode": 0
        }
      }
    ],
    "Columns": [
      {
        "Target": {
          "TargetKind": 0,
          "SystemField": 0
        },
        "Renderer": 0,
        "ReferenceInputType": 0,
        "ReferenceRendererType": 0,
        "ReferenceLookupRenderType": 0,
        "ReferenceOpenTarget": {
          "Target": 0,
          "SurfaceSelectors": [
            {
              "Mode": 0
            }
          ]
        }
      }
    ],
    "ProjectionColumns": [
      {
        "Renderer": 0
      }
    ],
    "FilterItems": [
      {
        "Target": {
          "TargetKind": 0,
          "Path": [
            {
              "SystemField": 0,
              "Special": 0
            }
          ]
        },
        "ReferenceInputType": 0,
        "ReferenceRendererType": 0,
        "ReferenceLookupRenderType": 0,
        "ReferenceHierarchy": {
          "SourceKind": 0
        }
      }
    ],
    "SortItems": [
      {
        "Target": {
          "Path": [
            {
              "SystemField": 0,
              "Special": 0
            }
          ]
        }
      }
    ],
    "DefaultSort": [
      {
        "Target": {
          "Path": [
            {
              "SystemField": 0,
              "Special": 0
            }
          ]
        },
        "Direction": 0
      }
    ],
    "TreeView": {
      "SortSpecial": 0,
      "SortDirection": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
Data

Admin-facing table surface configuration.

object
Meta

Minimal runtime entity metadata used by explicit UI surfaces.

object
EntityDefinitionId

Entity definition identifier.

string
nullable
Name

Internal entity key used by runtime routes.

string
nullable
DisplayNameSingular

User-facing singular name.

string
nullable
DisplayNamePlural

User-facing plural name.

string
nullable
CommentsEnabled

Whether entity comments are enabled.

boolean
AttachmentsEnabled

Whether entity attachments are enabled.

boolean
TagsEnabled

Whether entity tags are enabled.

boolean
FullTextSearchAvailable

Whether runtime configured search is available for the definition.

boolean
Statements

Runtime-exposed statements for this entity.

Array<object>
nullable

Runtime statement descriptor exposed to clients together with predicate payloads.

object
Id

Statement identifier.

string
nullable
Name

Stable technical statement key.

string
nullable
DisplayName

User-facing statement label.

string
nullable
RuleEvaluationContext

Rule evaluation context shared with fast UI runtime evaluation.

object
CurrentUserId

Current workspace user identifier.

string
nullable
CurrentLocalDate

Workspace-local current date in ISO format.

string
nullable
TimeZone

Workspace time zone identifier.

string
nullable
GeneratedAtUtc

UTC instant when the context was generated.

string format: date-time
nullable
NextLocalMidnightUtc

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

string format: date-time
nullable
ContextValues

Owner-scoped runtime values available to rule plans.

object
key
additional properties
object
IsProjection

Whether the entity is an enabled Projection Entity.

boolean
SurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
SurfaceId

Persisted table surface identifier.

string
nullable
Name

Table surface name.

string
nullable
Key

Table surface key.

string
nullable
IsDefault

Whether this table surface is the current default table.

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

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

string
nullable
SourcePackageId

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

string
nullable
SourceStableId

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

string
nullable
CreateFormSelectors

Role-aware form selectors used by table-scoped create flows.

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
EditFormSelectors

Role-aware default form selectors used by table edit actions without an override.

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
DrawerSelectors

Role-aware drawer selectors used by preview actions and post-form navigation.

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
DetailsPageSelectors

Role-aware details-page selectors used by open actions and post-form navigation.

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

Explicit row actions available on this table surface.

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
Columns

Explicit column overrides keyed by stable target anchors.

Array<object>
nullable

Explicit table column override keyed by a stable target anchor.

object
Target

Stable field, system-field, or relation target for table column configuration.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
EntityFieldDefinitionId

Entity field id when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.EntityField.

string
nullable
DisplayFieldId

Display field id when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.DisplayField.

string
nullable
ObjectContextFactId

Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.ObjectContextFact.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
ResponsibilityKey

Stable responsibility key when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Responsibility.

string
nullable
Label

Override label, or null to use the surface default.

string
nullable
SortOrder

Override sort order, or null to use the surface default.

integer format: int32
nullable
Visible

Override visibility, or null to use the surface default.

boolean
nullable
Width

Override width, or null to use the surface default.

integer format: int32
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
ReferenceInputType
integer format: int32
Allowed values: 0 1 2 3
ReferenceRendererType
integer format: int32
Allowed values: 0 1
ReferenceLookupRenderType
integer format: int32
Allowed values: 0 1
ReferencePath

Reference path configured for breadcrumb rendering.

Array<string>
nullable
ReferenceOpenTarget

Configured reference open target and role-aware target-surface selectors.

object
Target
integer format: int32
Allowed values: 0 1
SurfaceSelectors

Role-aware target-surface selectors.

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
ProjectionColumns

Explicit related-record projection columns shown after root table columns.

Array<object>
nullable

Explicit table projection column keyed by a typed reference path.

object
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
Label

Override label, or null to use the default reference path label.

string
nullable
SortOrder

Projection column sort order.

integer format: int32
Visible

Whether the projection column is visible.

boolean
Width

Projection column width.

integer format: int32
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
RowRules

Explicit table row highlight rules.

Array<object>
nullable

Explicit table row highlight rule keyed by statement id.

object
StatementId

Statement identifier.

string
nullable
SortOrder

Rule sort order.

integer format: int32
FontColor

Optional font color override.

string
nullable
BackgroundColor

Optional background color override.

string
nullable
FilterItems

Ordered filter items available for this table surface.

Array<object>
nullable

One explicit table-surface runtime filter item.

object
Target

Stable query target for table-surface filter configuration.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
Path

Ordered query path for field and system-field targets. Intermediate segments must be readable primary-table reference fields. This path controls filtering and is independent from the filter item’s ReferencePath, which controls lookup breadcrumb rendering.

Array<object>
nullable

One field or system-field segment in a table-surface filter or sort query path.

object
EntityFieldDefinitionId

Entity field id for a reference or terminal entity-field segment.

string
nullable
EntityFieldKey

Entity field key for admin disambiguation and portable request inspection.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Special
integer format: int32
Allowed values: 0 1
StatementId

Statement id when Moltaro.Entity.Ui.Models.EntityUiTableSurfaceFilterTargetAdminModel.TargetKind is Moltaro.Enums.EntityInstanceQueryOptionKindEnum.Statement.

string
nullable
StatementName

Statement name for admin disambiguation and portable request inspection.

string
nullable
ObjectContextFactId

Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiTableSurfaceFilterTargetAdminModel.TargetKind is Moltaro.Enums.EntityInstanceQueryOptionKindEnum.ObjectContextFact.

string
nullable
ObjectContextFactFilterKey

Provider-owned filter facet key when Moltaro.Entity.Ui.Models.EntityUiTableSurfaceFilterTargetAdminModel.TargetKind is Moltaro.Enums.EntityInstanceQueryOptionKindEnum.ObjectContextFact.

string
nullable
Label

Override label, or null to use the target display label.

string
nullable
Visible

Whether this filter is available in the runtime filter drawer add menu.

boolean
VisibleByDefault

Whether this filter appears immediately in the runtime side panel.

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

Reference path configured for breadcrumb rendering.

Array<string>
nullable
ReferenceHierarchy

Saved relationship shape for one hierarchy reference input.

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

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

string
nullable
ParentFieldKey

Recursive parent stable field key used by portable configuration.

string
nullable
SortOrder

Filter item display order.

integer format: int32
SortItems

Ordered sort items available for this table surface.

Array<object>
nullable

One explicit table-surface runtime sort item.

object
Target

Stable sortable path for table-surface sort configuration.

object
Path

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

Array<object>
nullable

One field or system-field segment in a table-surface filter or sort query path.

object
EntityFieldDefinitionId

Entity field id for a reference or terminal entity-field segment.

string
nullable
EntityFieldKey

Entity field key for admin disambiguation and portable request inspection.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Special
integer format: int32
Allowed values: 0 1
Label

Override label, or null to use the target display label.

string
nullable
Visible

Whether this sort target is available in the runtime sorting drawer.

boolean
SortOrder

Sort item display order.

integer format: int32
DefaultSort

Configured default sort sequence for this table surface.

Array<object>
nullable

One default table-surface runtime sort item.

object
Target

Stable sortable path for table-surface sort configuration.

object
Path

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

Array<object>
nullable

One field or system-field segment in a table-surface filter or sort query path.

object
EntityFieldDefinitionId

Entity field id for a reference or terminal entity-field segment.

string
nullable
EntityFieldKey

Entity field key for admin disambiguation and portable request inspection.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Special
integer format: int32
Allowed values: 0 1
Direction
integer format: int32
Allowed values: 0 1
SortOrder

Default sort display order.

integer format: int32
TreeView

Parent hierarchy configuration for one table surface.

object
ParentFieldDefinitionId
required

Stable parent field identifier.

string
ParentFieldKey
required

Stable parent field key used by portable configuration.

string
SortFieldDefinitionId

Stable sibling sort field identifier, or null to sort siblings by Display name.

string
nullable
SortFieldKey

Stable sibling sort field key used by portable configuration.

string
nullable
SortSpecial
integer format: int32
Allowed values: 0 1
SortDirection
integer format: int32
Allowed values: 0 1
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": {
    "SurfaceType": 0,
    "Source": 0,
    "CreateFormSelectors": [
      {
        "Mode": 0
      }
    ],
    "EditFormSelectors": [
      {
        "Mode": 0
      }
    ],
    "DrawerSelectors": [
      {
        "Mode": 0
      }
    ],
    "DetailsPageSelectors": [
      {
        "Mode": 0
      }
    ],
    "AfterCreateNavigation": 0,
    "AfterUpdateNavigation": 0,
    "Actions": [
      {
        "Action": 0,
        "Placement": 0,
        "FormSelectors": [
          {
            "Mode": 0
          }
        ],
        "FormSelector": {
          "Mode": 0
        }
      }
    ],
    "Columns": [
      {
        "Target": {
          "TargetKind": 0,
          "SystemField": 0
        },
        "Renderer": 0,
        "ReferenceInputType": 0,
        "ReferenceRendererType": 0,
        "ReferenceLookupRenderType": 0,
        "ReferenceOpenTarget": {
          "Target": 0,
          "SurfaceSelectors": [
            {
              "Mode": 0
            }
          ]
        }
      }
    ],
    "ProjectionColumns": [
      {
        "Renderer": 0
      }
    ],
    "FilterItems": [
      {
        "Target": {
          "TargetKind": 0,
          "Path": [
            {
              "SystemField": 0,
              "Special": 0
            }
          ]
        },
        "ReferenceInputType": 0,
        "ReferenceRendererType": 0,
        "ReferenceLookupRenderType": 0,
        "ReferenceHierarchy": {
          "SourceKind": 0
        }
      }
    ],
    "SortItems": [
      {
        "Target": {
          "Path": [
            {
              "SystemField": 0,
              "Special": 0
            }
          ]
        }
      }
    ],
    "DefaultSort": [
      {
        "Target": {
          "Path": [
            {
              "SystemField": 0,
              "Special": 0
            }
          ]
        },
        "Direction": 0
      }
    ],
    "TreeView": {
      "SortSpecial": 0,
      "SortDirection": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Section titled “403”

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"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
Data

Admin-facing table surface configuration.

object
Meta

Minimal runtime entity metadata used by explicit UI surfaces.

object
EntityDefinitionId

Entity definition identifier.

string
nullable
Name

Internal entity key used by runtime routes.

string
nullable
DisplayNameSingular

User-facing singular name.

string
nullable
DisplayNamePlural

User-facing plural name.

string
nullable
CommentsEnabled

Whether entity comments are enabled.

boolean
AttachmentsEnabled

Whether entity attachments are enabled.

boolean
TagsEnabled

Whether entity tags are enabled.

boolean
FullTextSearchAvailable

Whether runtime configured search is available for the definition.

boolean
Statements

Runtime-exposed statements for this entity.

Array<object>
nullable

Runtime statement descriptor exposed to clients together with predicate payloads.

object
Id

Statement identifier.

string
nullable
Name

Stable technical statement key.

string
nullable
DisplayName

User-facing statement label.

string
nullable
RuleEvaluationContext

Rule evaluation context shared with fast UI runtime evaluation.

object
CurrentUserId

Current workspace user identifier.

string
nullable
CurrentLocalDate

Workspace-local current date in ISO format.

string
nullable
TimeZone

Workspace time zone identifier.

string
nullable
GeneratedAtUtc

UTC instant when the context was generated.

string format: date-time
nullable
NextLocalMidnightUtc

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

string format: date-time
nullable
ContextValues

Owner-scoped runtime values available to rule plans.

object
key
additional properties
object
IsProjection

Whether the entity is an enabled Projection Entity.

boolean
SurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
SurfaceId

Persisted table surface identifier.

string
nullable
Name

Table surface name.

string
nullable
Key

Table surface key.

string
nullable
IsDefault

Whether this table surface is the current default table.

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

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

string
nullable
SourcePackageId

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

string
nullable
SourceStableId

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

string
nullable
CreateFormSelectors

Role-aware form selectors used by table-scoped create flows.

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
EditFormSelectors

Role-aware default form selectors used by table edit actions without an override.

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
DrawerSelectors

Role-aware drawer selectors used by preview actions and post-form navigation.

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
DetailsPageSelectors

Role-aware details-page selectors used by open actions and post-form navigation.

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

Explicit row actions available on this table surface.

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
Columns

Explicit column overrides keyed by stable target anchors.

Array<object>
nullable

Explicit table column override keyed by a stable target anchor.

object
Target

Stable field, system-field, or relation target for table column configuration.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
EntityFieldDefinitionId

Entity field id when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.EntityField.

string
nullable
DisplayFieldId

Display field id when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.DisplayField.

string
nullable
ObjectContextFactId

Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.ObjectContextFact.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
ResponsibilityKey

Stable responsibility key when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Responsibility.

string
nullable
Label

Override label, or null to use the surface default.

string
nullable
SortOrder

Override sort order, or null to use the surface default.

integer format: int32
nullable
Visible

Override visibility, or null to use the surface default.

boolean
nullable
Width

Override width, or null to use the surface default.

integer format: int32
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
ReferenceInputType
integer format: int32
Allowed values: 0 1 2 3
ReferenceRendererType
integer format: int32
Allowed values: 0 1
ReferenceLookupRenderType
integer format: int32
Allowed values: 0 1
ReferencePath

Reference path configured for breadcrumb rendering.

Array<string>
nullable
ReferenceOpenTarget

Configured reference open target and role-aware target-surface selectors.

object
Target
integer format: int32
Allowed values: 0 1
SurfaceSelectors

Role-aware target-surface selectors.

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
ProjectionColumns

Explicit related-record projection columns shown after root table columns.

Array<object>
nullable

Explicit table projection column keyed by a typed reference path.

object
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
Label

Override label, or null to use the default reference path label.

string
nullable
SortOrder

Projection column sort order.

integer format: int32
Visible

Whether the projection column is visible.

boolean
Width

Projection column width.

integer format: int32
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
RowRules

Explicit table row highlight rules.

Array<object>
nullable

Explicit table row highlight rule keyed by statement id.

object
StatementId

Statement identifier.

string
nullable
SortOrder

Rule sort order.

integer format: int32
FontColor

Optional font color override.

string
nullable
BackgroundColor

Optional background color override.

string
nullable
FilterItems

Ordered filter items available for this table surface.

Array<object>
nullable

One explicit table-surface runtime filter item.

object
Target

Stable query target for table-surface filter configuration.

object
TargetKind
integer format: int32
Allowed values: 0 1 2 3 4
Path

Ordered query path for field and system-field targets. Intermediate segments must be readable primary-table reference fields. This path controls filtering and is independent from the filter item’s ReferencePath, which controls lookup breadcrumb rendering.

Array<object>
nullable

One field or system-field segment in a table-surface filter or sort query path.

object
EntityFieldDefinitionId

Entity field id for a reference or terminal entity-field segment.

string
nullable
EntityFieldKey

Entity field key for admin disambiguation and portable request inspection.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Special
integer format: int32
Allowed values: 0 1
StatementId

Statement id when Moltaro.Entity.Ui.Models.EntityUiTableSurfaceFilterTargetAdminModel.TargetKind is Moltaro.Enums.EntityInstanceQueryOptionKindEnum.Statement.

string
nullable
StatementName

Statement name for admin disambiguation and portable request inspection.

string
nullable
ObjectContextFactId

Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiTableSurfaceFilterTargetAdminModel.TargetKind is Moltaro.Enums.EntityInstanceQueryOptionKindEnum.ObjectContextFact.

string
nullable
ObjectContextFactFilterKey

Provider-owned filter facet key when Moltaro.Entity.Ui.Models.EntityUiTableSurfaceFilterTargetAdminModel.TargetKind is Moltaro.Enums.EntityInstanceQueryOptionKindEnum.ObjectContextFact.

string
nullable
Label

Override label, or null to use the target display label.

string
nullable
Visible

Whether this filter is available in the runtime filter drawer add menu.

boolean
VisibleByDefault

Whether this filter appears immediately in the runtime side panel.

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

Reference path configured for breadcrumb rendering.

Array<string>
nullable
ReferenceHierarchy

Saved relationship shape for one hierarchy reference input.

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

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

string
nullable
ParentFieldKey

Recursive parent stable field key used by portable configuration.

string
nullable
SortOrder

Filter item display order.

integer format: int32
SortItems

Ordered sort items available for this table surface.

Array<object>
nullable

One explicit table-surface runtime sort item.

object
Target

Stable sortable path for table-surface sort configuration.

object
Path

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

Array<object>
nullable

One field or system-field segment in a table-surface filter or sort query path.

object
EntityFieldDefinitionId

Entity field id for a reference or terminal entity-field segment.

string
nullable
EntityFieldKey

Entity field key for admin disambiguation and portable request inspection.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Special
integer format: int32
Allowed values: 0 1
Label

Override label, or null to use the target display label.

string
nullable
Visible

Whether this sort target is available in the runtime sorting drawer.

boolean
SortOrder

Sort item display order.

integer format: int32
DefaultSort

Configured default sort sequence for this table surface.

Array<object>
nullable

One default table-surface runtime sort item.

object
Target

Stable sortable path for table-surface sort configuration.

object
Path

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

Array<object>
nullable

One field or system-field segment in a table-surface filter or sort query path.

object
EntityFieldDefinitionId

Entity field id for a reference or terminal entity-field segment.

string
nullable
EntityFieldKey

Entity field key for admin disambiguation and portable request inspection.

string
nullable
SystemField
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
Special
integer format: int32
Allowed values: 0 1
Direction
integer format: int32
Allowed values: 0 1
SortOrder

Default sort display order.

integer format: int32
TreeView

Parent hierarchy configuration for one table surface.

object
ParentFieldDefinitionId
required

Stable parent field identifier.

string
ParentFieldKey
required

Stable parent field key used by portable configuration.

string
SortFieldDefinitionId

Stable sibling sort field identifier, or null to sort siblings by Display name.

string
nullable
SortFieldKey

Stable sibling sort field key used by portable configuration.

string
nullable
SortSpecial
integer format: int32
Allowed values: 0 1
SortDirection
integer format: int32
Allowed values: 0 1
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": {
    "SurfaceType": 0,
    "Source": 0,
    "CreateFormSelectors": [
      {
        "Mode": 0
      }
    ],
    "EditFormSelectors": [
      {
        "Mode": 0
      }
    ],
    "DrawerSelectors": [
      {
        "Mode": 0
      }
    ],
    "DetailsPageSelectors": [
      {
        "Mode": 0
      }
    ],
    "AfterCreateNavigation": 0,
    "AfterUpdateNavigation": 0,
    "Actions": [
      {
        "Action": 0,
        "Placement": 0,
        "FormSelectors": [
          {
            "Mode": 0
          }
        ],
        "FormSelector": {
          "Mode": 0
        }
      }
    ],
    "Columns": [
      {
        "Target": {
          "TargetKind": 0,
          "SystemField": 0
        },
        "Renderer": 0,
        "ReferenceInputType": 0,
        "ReferenceRendererType": 0,
        "ReferenceLookupRenderType": 0,
        "ReferenceOpenTarget": {
          "Target": 0,
          "SurfaceSelectors": [
            {
              "Mode": 0
            }
          ]
        }
      }
    ],
    "ProjectionColumns": [
      {
        "Renderer": 0
      }
    ],
    "FilterItems": [
      {
        "Target": {
          "TargetKind": 0,
          "Path": [
            {
              "SystemField": 0,
              "Special": 0
            }
          ]
        },
        "ReferenceInputType": 0,
        "ReferenceRendererType": 0,
        "ReferenceLookupRenderType": 0,
        "ReferenceHierarchy": {
          "SourceKind": 0
        }
      }
    ],
    "SortItems": [
      {
        "Target": {
          "Path": [
            {
              "SystemField": 0,
              "Special": 0
            }
          ]
        }
      }
    ],
    "DefaultSort": [
      {
        "Target": {
          "Path": [
            {
              "SystemField": 0,
              "Special": 0
            }
          ]
        },
        "Direction": 0
      }
    ],
    "TreeView": {
      "SortSpecial": 0,
      "SortDirection": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}