Skip to content

Return visual editor options for table surface configuration.

GET
/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/table-surfaces/configuration/options
curl --request GET \
--url https://example.com/api/workspace/admin/entity-definitions/example/ui/table-surfaces/configuration/options
  • None
entityDefinitionId
required
string
access_token
string

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

OK

Media typeapplication/json
object
Data

Visual editor options for 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
ColumnTargets

Eligible field, system-field, and relation targets for table columns.

Array<object>
nullable

One eligible table column target and its surface defaults.

object
Key

Stable visual-editor key for this target.

string
nullable
Label

Default user-facing label.

string
nullable
TechnicalKey

Technical key for test automation and admin disambiguation.

string
nullable
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
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SortOrder

Default sort order.

integer format: int32
Visible

Default visibility.

boolean
Width

Default table column width.

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

Explicit table renderers accepted for this target. Null remains the inherited/default choice.

Array<integer>
nullable
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

Default breadcrumb reference path.

Array<string>
nullable
ReferencePathOptions

Backend-approved breadcrumb path options for this reference target.

Array<object>
nullable

One backend-approved reference breadcrumb path option.

object
Path

Reference field keys relative to the configured reference target entity.

Array<string>
nullable
Label

User-facing label for the path.

string
nullable
TerminalEntityDefinitionId

Terminal entity definition identifier reached by this path.

string
nullable
ReferenceTargetDrawerSurfaces

Explicit drawer surfaces from the referenced target entity.

Array<object>
nullable

One surface metadata entry inside the admin catalog.

object
SurfaceId

Persisted surface identifier.

string
nullable
SurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
Name

Surface name.

string
nullable
Key

Surface key.

string
nullable
IsDefault

Whether this surface is currently resolved as the default for its type.

boolean
IsTreeView

Whether this Table Surface is configured as a Parent Tree View.

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

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

string
nullable
SourcePackageId

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

string
nullable
SourceStableId

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

string
nullable
ReferenceTargetDetailsPageSurfaces

Explicit details-page surfaces from the referenced target entity.

Array<object>
nullable

One surface metadata entry inside the admin catalog.

object
SurfaceId

Persisted surface identifier.

string
nullable
SurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
Name

Surface name.

string
nullable
Key

Surface key.

string
nullable
IsDefault

Whether this surface is currently resolved as the default for its type.

boolean
IsTreeView

Whether this Table Surface is configured as a Parent Tree View.

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

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

string
nullable
SourcePackageId

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

string
nullable
SourceStableId

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

string
nullable
ProjectionColumns

Eligible related-record projection columns for table surfaces.

Array<object>
nullable

One eligible table projection column path and its surface defaults.

object
Key

Stable visual-editor key for this projection path.

string
nullable
Label

Default user-facing projection label.

string
nullable
Path

Reference and terminal field keys in display order.

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
TerminalFieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SortOrder

Default sort order.

integer format: int32
Visible

Default visibility.

boolean
Width

Default 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
AllowedTableRenderers

Explicit table renderers accepted for the projected terminal field. Null remains the inherited/default choice.

Array<integer>
nullable
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
FilterTargets

Eligible field and statement targets for table-surface filters.

Array<object>
nullable

One eligible table-surface filter target and its configuration metadata.

object
Key

Stable visual-editor key for this target.

string
nullable
Label

Default user-facing label.

string
nullable
TechnicalKey

Technical key for test automation and admin disambiguation.

string
nullable
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
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
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

Default breadcrumb reference path.

Array<string>
nullable
ReferencePathOptions

Backend-approved breadcrumb path options for this reference target.

Array<object>
nullable

One backend-approved reference breadcrumb path option.

object
Path

Reference field keys relative to the configured reference target entity.

Array<string>
nullable
Label

User-facing label for the path.

string
nullable
TerminalEntityDefinitionId

Terminal entity definition identifier reached by this path.

string
nullable
ReferenceHierarchyOptions

Backend-approved hierarchy sources for one direct scalar Reference target.

object
ExplicitPaths

Explicit terminal-to-ancestor paths accepted by hierarchy metadata validation.

Array<object>
nullable

One backend-approved reference breadcrumb path option.

object
Path

Reference field keys relative to the configured reference target entity.

Array<string>
nullable
Label

User-facing label for the path.

string
nullable
TerminalEntityDefinitionId

Terminal entity definition identifier reached by this path.

string
nullable
RecursiveParentFields

Ready indexed self-reference fields accepted as recursive parent sources.

Array<object>
nullable

One backend-approved recursive hierarchy parent field.

object
FieldDefinitionId

Stable field identifier.

string
nullable
FieldKey

Stable field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
ReferenceEligibility

Reference Eligibility requirements for one direct Table filter target.

object
TargetFieldDefinitionId
string
nullable
RequiredDriverTargetKeys
Array<string>
nullable
IsDriver
boolean
IsDependent
boolean
Singleton
boolean
SortTargets

Eligible field and system-field targets for table-surface sorting.

Array<object>
nullable

One eligible table-surface sort target and its configuration metadata.

object
Key

Stable visual-editor key for this target.

string
nullable
Label

Default user-facing label.

string
nullable
TechnicalKey

Technical key for test automation and admin disambiguation.

string
nullable
SortTarget

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
Statements

Client-exposed statements available to table row rules.

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
TreeViewParentFields

Structurally eligible self-reference fields and their physical index readiness.

Array<object>
nullable

One structurally eligible Parent Tree View field option.

object
FieldDefinitionId

Stable field identifier.

string
nullable
FieldKey

Stable field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
Source
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root identifier for package-owned schema.

string
nullable
SourcePackageId

NET package artifact identifier for package-owned schema.

string
nullable
SourceStableId

Stable package field identifier.

string
nullable
Availability
integer format: int32
Allowed values: 0 1
UnavailableReason

Localized explanation when the field is not ready.

string
nullable
TreeViewSortFields

Sortable primary-table fields eligible as the Tree View sibling sort field.

Array<object>
nullable

One sortable field eligible as the Tree View sibling sort field.

object
FieldDefinitionId

Stable field identifier.

string
nullable
FieldKey

Stable field key.

string
nullable
DisplayName

User-facing field name.

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

Stable NET package root identifier for package-owned schema.

string
nullable
SourcePackageId

NET package artifact identifier for package-owned schema.

string
nullable
SourceStableId

Stable package field identifier.

string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"SurfaceType": 0,
"ColumnTargets": [
{
"Target": {
"TargetKind": 0,
"SystemField": 0
},
"FieldType": 0,
"TableRenderer": 0,
"AllowedTableRenderers": [
0
],
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0,
"ReferenceTargetDrawerSurfaces": [
{
"SurfaceType": 0,
"Source": 0
}
],
"ReferenceTargetDetailsPageSurfaces": [
{
"SurfaceType": 0,
"Source": 0
}
]
}
],
"ProjectionColumns": [
{
"TerminalFieldType": 0,
"Renderer": 0,
"AllowedTableRenderers": [
0
]
}
],
"FilterTargets": [
{
"Target": {
"TargetKind": 0,
"Path": [
{
"SystemField": 0,
"Special": 0
}
]
},
"FieldType": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0
}
],
"SortTargets": [
{
"SortTarget": {
"Path": [
{
"SystemField": 0,
"Special": 0
}
]
}
}
],
"TreeViewParentFields": [
{
"Source": 0,
"Availability": 0
}
],
"TreeViewSortFields": [
{
"FieldType": 0,
"Source": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data

Visual editor options for 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
ColumnTargets

Eligible field, system-field, and relation targets for table columns.

Array<object>
nullable

One eligible table column target and its surface defaults.

object
Key

Stable visual-editor key for this target.

string
nullable
Label

Default user-facing label.

string
nullable
TechnicalKey

Technical key for test automation and admin disambiguation.

string
nullable
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
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SortOrder

Default sort order.

integer format: int32
Visible

Default visibility.

boolean
Width

Default table column width.

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

Explicit table renderers accepted for this target. Null remains the inherited/default choice.

Array<integer>
nullable
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

Default breadcrumb reference path.

Array<string>
nullable
ReferencePathOptions

Backend-approved breadcrumb path options for this reference target.

Array<object>
nullable

One backend-approved reference breadcrumb path option.

object
Path

Reference field keys relative to the configured reference target entity.

Array<string>
nullable
Label

User-facing label for the path.

string
nullable
TerminalEntityDefinitionId

Terminal entity definition identifier reached by this path.

string
nullable
ReferenceTargetDrawerSurfaces

Explicit drawer surfaces from the referenced target entity.

Array<object>
nullable

One surface metadata entry inside the admin catalog.

object
SurfaceId

Persisted surface identifier.

string
nullable
SurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
Name

Surface name.

string
nullable
Key

Surface key.

string
nullable
IsDefault

Whether this surface is currently resolved as the default for its type.

boolean
IsTreeView

Whether this Table Surface is configured as a Parent Tree View.

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

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

string
nullable
SourcePackageId

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

string
nullable
SourceStableId

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

string
nullable
ReferenceTargetDetailsPageSurfaces

Explicit details-page surfaces from the referenced target entity.

Array<object>
nullable

One surface metadata entry inside the admin catalog.

object
SurfaceId

Persisted surface identifier.

string
nullable
SurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
Name

Surface name.

string
nullable
Key

Surface key.

string
nullable
IsDefault

Whether this surface is currently resolved as the default for its type.

boolean
IsTreeView

Whether this Table Surface is configured as a Parent Tree View.

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

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

string
nullable
SourcePackageId

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

string
nullable
SourceStableId

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

string
nullable
ProjectionColumns

Eligible related-record projection columns for table surfaces.

Array<object>
nullable

One eligible table projection column path and its surface defaults.

object
Key

Stable visual-editor key for this projection path.

string
nullable
Label

Default user-facing projection label.

string
nullable
Path

Reference and terminal field keys in display order.

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
TerminalFieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SortOrder

Default sort order.

integer format: int32
Visible

Default visibility.

boolean
Width

Default 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
AllowedTableRenderers

Explicit table renderers accepted for the projected terminal field. Null remains the inherited/default choice.

Array<integer>
nullable
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
FilterTargets

Eligible field and statement targets for table-surface filters.

Array<object>
nullable

One eligible table-surface filter target and its configuration metadata.

object
Key

Stable visual-editor key for this target.

string
nullable
Label

Default user-facing label.

string
nullable
TechnicalKey

Technical key for test automation and admin disambiguation.

string
nullable
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
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
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

Default breadcrumb reference path.

Array<string>
nullable
ReferencePathOptions

Backend-approved breadcrumb path options for this reference target.

Array<object>
nullable

One backend-approved reference breadcrumb path option.

object
Path

Reference field keys relative to the configured reference target entity.

Array<string>
nullable
Label

User-facing label for the path.

string
nullable
TerminalEntityDefinitionId

Terminal entity definition identifier reached by this path.

string
nullable
ReferenceHierarchyOptions

Backend-approved hierarchy sources for one direct scalar Reference target.

object
ExplicitPaths

Explicit terminal-to-ancestor paths accepted by hierarchy metadata validation.

Array<object>
nullable

One backend-approved reference breadcrumb path option.

object
Path

Reference field keys relative to the configured reference target entity.

Array<string>
nullable
Label

User-facing label for the path.

string
nullable
TerminalEntityDefinitionId

Terminal entity definition identifier reached by this path.

string
nullable
RecursiveParentFields

Ready indexed self-reference fields accepted as recursive parent sources.

Array<object>
nullable

One backend-approved recursive hierarchy parent field.

object
FieldDefinitionId

Stable field identifier.

string
nullable
FieldKey

Stable field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
ReferenceEligibility

Reference Eligibility requirements for one direct Table filter target.

object
TargetFieldDefinitionId
string
nullable
RequiredDriverTargetKeys
Array<string>
nullable
IsDriver
boolean
IsDependent
boolean
Singleton
boolean
SortTargets

Eligible field and system-field targets for table-surface sorting.

Array<object>
nullable

One eligible table-surface sort target and its configuration metadata.

object
Key

Stable visual-editor key for this target.

string
nullable
Label

Default user-facing label.

string
nullable
TechnicalKey

Technical key for test automation and admin disambiguation.

string
nullable
SortTarget

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
Statements

Client-exposed statements available to table row rules.

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
TreeViewParentFields

Structurally eligible self-reference fields and their physical index readiness.

Array<object>
nullable

One structurally eligible Parent Tree View field option.

object
FieldDefinitionId

Stable field identifier.

string
nullable
FieldKey

Stable field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
Source
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root identifier for package-owned schema.

string
nullable
SourcePackageId

NET package artifact identifier for package-owned schema.

string
nullable
SourceStableId

Stable package field identifier.

string
nullable
Availability
integer format: int32
Allowed values: 0 1
UnavailableReason

Localized explanation when the field is not ready.

string
nullable
TreeViewSortFields

Sortable primary-table fields eligible as the Tree View sibling sort field.

Array<object>
nullable

One sortable field eligible as the Tree View sibling sort field.

object
FieldDefinitionId

Stable field identifier.

string
nullable
FieldKey

Stable field key.

string
nullable
DisplayName

User-facing field name.

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

Stable NET package root identifier for package-owned schema.

string
nullable
SourcePackageId

NET package artifact identifier for package-owned schema.

string
nullable
SourceStableId

Stable package field identifier.

string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"SurfaceType": 0,
"ColumnTargets": [
{
"Target": {
"TargetKind": 0,
"SystemField": 0
},
"FieldType": 0,
"TableRenderer": 0,
"AllowedTableRenderers": [
0
],
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0,
"ReferenceTargetDrawerSurfaces": [
{
"SurfaceType": 0,
"Source": 0
}
],
"ReferenceTargetDetailsPageSurfaces": [
{
"SurfaceType": 0,
"Source": 0
}
]
}
],
"ProjectionColumns": [
{
"TerminalFieldType": 0,
"Renderer": 0,
"AllowedTableRenderers": [
0
]
}
],
"FilterTargets": [
{
"Target": {
"TargetKind": 0,
"Path": [
{
"SystemField": 0,
"Special": 0
}
]
},
"FieldType": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0
}
],
"SortTargets": [
{
"SortTarget": {
"Path": [
{
"SystemField": 0,
"Special": 0
}
]
}
}
],
"TreeViewParentFields": [
{
"Source": 0,
"Availability": 0
}
],
"TreeViewSortFields": [
{
"FieldType": 0,
"Source": 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

Visual editor options for 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
ColumnTargets

Eligible field, system-field, and relation targets for table columns.

Array<object>
nullable

One eligible table column target and its surface defaults.

object
Key

Stable visual-editor key for this target.

string
nullable
Label

Default user-facing label.

string
nullable
TechnicalKey

Technical key for test automation and admin disambiguation.

string
nullable
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
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SortOrder

Default sort order.

integer format: int32
Visible

Default visibility.

boolean
Width

Default table column width.

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

Explicit table renderers accepted for this target. Null remains the inherited/default choice.

Array<integer>
nullable
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

Default breadcrumb reference path.

Array<string>
nullable
ReferencePathOptions

Backend-approved breadcrumb path options for this reference target.

Array<object>
nullable

One backend-approved reference breadcrumb path option.

object
Path

Reference field keys relative to the configured reference target entity.

Array<string>
nullable
Label

User-facing label for the path.

string
nullable
TerminalEntityDefinitionId

Terminal entity definition identifier reached by this path.

string
nullable
ReferenceTargetDrawerSurfaces

Explicit drawer surfaces from the referenced target entity.

Array<object>
nullable

One surface metadata entry inside the admin catalog.

object
SurfaceId

Persisted surface identifier.

string
nullable
SurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
Name

Surface name.

string
nullable
Key

Surface key.

string
nullable
IsDefault

Whether this surface is currently resolved as the default for its type.

boolean
IsTreeView

Whether this Table Surface is configured as a Parent Tree View.

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

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

string
nullable
SourcePackageId

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

string
nullable
SourceStableId

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

string
nullable
ReferenceTargetDetailsPageSurfaces

Explicit details-page surfaces from the referenced target entity.

Array<object>
nullable

One surface metadata entry inside the admin catalog.

object
SurfaceId

Persisted surface identifier.

string
nullable
SurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
Name

Surface name.

string
nullable
Key

Surface key.

string
nullable
IsDefault

Whether this surface is currently resolved as the default for its type.

boolean
IsTreeView

Whether this Table Surface is configured as a Parent Tree View.

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

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

string
nullable
SourcePackageId

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

string
nullable
SourceStableId

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

string
nullable
ProjectionColumns

Eligible related-record projection columns for table surfaces.

Array<object>
nullable

One eligible table projection column path and its surface defaults.

object
Key

Stable visual-editor key for this projection path.

string
nullable
Label

Default user-facing projection label.

string
nullable
Path

Reference and terminal field keys in display order.

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
TerminalFieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SortOrder

Default sort order.

integer format: int32
Visible

Default visibility.

boolean
Width

Default 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
AllowedTableRenderers

Explicit table renderers accepted for the projected terminal field. Null remains the inherited/default choice.

Array<integer>
nullable
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
FilterTargets

Eligible field and statement targets for table-surface filters.

Array<object>
nullable

One eligible table-surface filter target and its configuration metadata.

object
Key

Stable visual-editor key for this target.

string
nullable
Label

Default user-facing label.

string
nullable
TechnicalKey

Technical key for test automation and admin disambiguation.

string
nullable
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
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
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

Default breadcrumb reference path.

Array<string>
nullable
ReferencePathOptions

Backend-approved breadcrumb path options for this reference target.

Array<object>
nullable

One backend-approved reference breadcrumb path option.

object
Path

Reference field keys relative to the configured reference target entity.

Array<string>
nullable
Label

User-facing label for the path.

string
nullable
TerminalEntityDefinitionId

Terminal entity definition identifier reached by this path.

string
nullable
ReferenceHierarchyOptions

Backend-approved hierarchy sources for one direct scalar Reference target.

object
ExplicitPaths

Explicit terminal-to-ancestor paths accepted by hierarchy metadata validation.

Array<object>
nullable

One backend-approved reference breadcrumb path option.

object
Path

Reference field keys relative to the configured reference target entity.

Array<string>
nullable
Label

User-facing label for the path.

string
nullable
TerminalEntityDefinitionId

Terminal entity definition identifier reached by this path.

string
nullable
RecursiveParentFields

Ready indexed self-reference fields accepted as recursive parent sources.

Array<object>
nullable

One backend-approved recursive hierarchy parent field.

object
FieldDefinitionId

Stable field identifier.

string
nullable
FieldKey

Stable field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
ReferenceEligibility

Reference Eligibility requirements for one direct Table filter target.

object
TargetFieldDefinitionId
string
nullable
RequiredDriverTargetKeys
Array<string>
nullable
IsDriver
boolean
IsDependent
boolean
Singleton
boolean
SortTargets

Eligible field and system-field targets for table-surface sorting.

Array<object>
nullable

One eligible table-surface sort target and its configuration metadata.

object
Key

Stable visual-editor key for this target.

string
nullable
Label

Default user-facing label.

string
nullable
TechnicalKey

Technical key for test automation and admin disambiguation.

string
nullable
SortTarget

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
Statements

Client-exposed statements available to table row rules.

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
TreeViewParentFields

Structurally eligible self-reference fields and their physical index readiness.

Array<object>
nullable

One structurally eligible Parent Tree View field option.

object
FieldDefinitionId

Stable field identifier.

string
nullable
FieldKey

Stable field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
Source
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Stable NET package root identifier for package-owned schema.

string
nullable
SourcePackageId

NET package artifact identifier for package-owned schema.

string
nullable
SourceStableId

Stable package field identifier.

string
nullable
Availability
integer format: int32
Allowed values: 0 1
UnavailableReason

Localized explanation when the field is not ready.

string
nullable
TreeViewSortFields

Sortable primary-table fields eligible as the Tree View sibling sort field.

Array<object>
nullable

One sortable field eligible as the Tree View sibling sort field.

object
FieldDefinitionId

Stable field identifier.

string
nullable
FieldKey

Stable field key.

string
nullable
DisplayName

User-facing field name.

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

Stable NET package root identifier for package-owned schema.

string
nullable
SourcePackageId

NET package artifact identifier for package-owned schema.

string
nullable
SourceStableId

Stable package field identifier.

string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"SurfaceType": 0,
"ColumnTargets": [
{
"Target": {
"TargetKind": 0,
"SystemField": 0
},
"FieldType": 0,
"TableRenderer": 0,
"AllowedTableRenderers": [
0
],
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0,
"ReferenceTargetDrawerSurfaces": [
{
"SurfaceType": 0,
"Source": 0
}
],
"ReferenceTargetDetailsPageSurfaces": [
{
"SurfaceType": 0,
"Source": 0
}
]
}
],
"ProjectionColumns": [
{
"TerminalFieldType": 0,
"Renderer": 0,
"AllowedTableRenderers": [
0
]
}
],
"FilterTargets": [
{
"Target": {
"TargetKind": 0,
"Path": [
{
"SystemField": 0,
"Special": 0
}
]
},
"FieldType": 0,
"ReferenceInputType": 0,
"ReferenceRendererType": 0,
"ReferenceLookupRenderType": 0
}
],
"SortTargets": [
{
"SortTarget": {
"Path": [
{
"SystemField": 0,
"Special": 0
}
]
}
}
],
"TreeViewParentFields": [
{
"Source": 0,
"Availability": 0
}
],
"TreeViewSortFields": [
{
"FieldType": 0,
"Source": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}