Return visual editor options for form surface configuration.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/admin/entity-definitions/example/ui/form-surfaces/configuration/options"),};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/admin/entity-definitions/example/ui/form-surfaces/configuration/options';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/workspace/admin/entity-definitions/example/ui/form-surfaces/configuration/optionsAuthorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Responses
Section titled “Responses”OK
object
Visual editor options for form surface configuration.
object
Minimal runtime entity metadata used by explicit UI surfaces.
object
Entity definition identifier.
Internal entity key used by runtime routes.
User-facing singular name.
User-facing plural name.
Whether entity comments are enabled.
Whether entity attachments are enabled.
Whether entity tags are enabled.
Whether runtime configured search is available for the definition.
Runtime-exposed statements for this entity.
Runtime statement descriptor exposed to clients together with predicate payloads.
object
Statement identifier.
Stable technical statement key.
User-facing statement label.
Rule evaluation context shared with fast UI runtime evaluation.
object
Current workspace user identifier.
Workspace-local current date in ISO format.
Workspace time zone identifier.
UTC instant when the context was generated.
UTC instant for the next midnight in the workspace time zone.
Owner-scoped runtime values available to rule plans.
object
object
Whether the entity is an enabled Projection Entity.
Eligible field and system-field targets for form items.
One eligible field-like target and its surface defaults.
object
Stable visual-editor key for this target.
Default user-facing label.
Technical key for test automation and admin disambiguation.
Stable field-or-system target for table, form, and card surface configurations.
object
Entity field id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.EntityField.
Display field id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.DisplayField.
Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.ObjectContextFact.
Stable responsibility key when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Responsibility.
Default sort order.
Default visibility.
Default table column width when the surface is table.
Default breadcrumb reference path.
Backend-approved breadcrumb path options for this reference target.
One backend-approved reference breadcrumb path option.
object
Reference field keys relative to the configured reference target entity.
User-facing label for the path.
Terminal entity definition identifier reached by this path.
Backend-approved hierarchy sources for one direct scalar Reference target.
object
Explicit terminal-to-ancestor paths accepted by hierarchy metadata validation.
One backend-approved reference breadcrumb path option.
object
Reference field keys relative to the configured reference target entity.
User-facing label for the path.
Terminal entity definition identifier reached by this path.
Ready indexed self-reference fields accepted as recursive parent sources.
One backend-approved recursive hierarchy parent field.
object
Stable field identifier.
Stable field key.
User-facing field name.
Create-time Reference Eligibility context for one dependent Form target.
object
Dependent Reference field identifier.
Dependent Reference field key.
Dependent Reference field display name.
Direct Eligibility drivers and external inputs used to derive them.
One direct Reference Eligibility driver and its possible external create inputs.
object
Direct driver field identifier.
Direct driver field key.
Direct driver field display name.
Alternative create inputs from which authoritative automation may derive the driver.
One possible related-create root that may be supplied outside the visual Form composition.
object
Source field identifier.
Source field key.
Source field display name.
Explicit table surfaces from the referenced target entity, used by lookup field selectors.
One surface metadata entry inside the admin catalog.
object
Persisted surface identifier.
Surface name.
Surface key.
Whether this surface is currently resolved as the default for its type.
Whether this Table Surface is configured as a Parent Tree View.
Stable NET package root id when this surface is package-owned.
NET package artifact id when this surface is package-owned.
Stable package surface id when this surface is package-owned.
Explicit form surfaces from the referenced target entity.
One surface metadata entry inside the admin catalog.
object
Persisted surface identifier.
Surface name.
Surface key.
Whether this surface is currently resolved as the default for its type.
Whether this Table Surface is configured as a Parent Tree View.
Stable NET package root id when this surface is package-owned.
NET package artifact id when this surface is package-owned.
Stable package surface id when this surface is package-owned.
Explicit drawer surfaces from the referenced target entity.
One surface metadata entry inside the admin catalog.
object
Persisted surface identifier.
Surface name.
Surface key.
Whether this surface is currently resolved as the default for its type.
Whether this Table Surface is configured as a Parent Tree View.
Stable NET package root id when this surface is package-owned.
NET package artifact id when this surface is package-owned.
Stable package surface id when this surface is package-owned.
Explicit details-page surfaces from the referenced target entity.
One surface metadata entry inside the admin catalog.
object
Persisted surface identifier.
Surface name.
Surface key.
Whether this surface is currently resolved as the default for its type.
Whether this Table Surface is configured as a Parent Tree View.
Stable NET package root id when this surface is package-owned.
NET package artifact id when this surface is package-owned.
Stable package surface id when this surface is package-owned.
Eligible direct inverse-reference targets for related-table form items.
One direct inverse-reference target eligible for a related-table form item.
object
Stable visual-editor key for this relation target.
Default user-facing label for the embedded child table.
Stable field-or-system target for table, form, and card surface configurations.
object
Entity field id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.EntityField.
Display field id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.DisplayField.
Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.ObjectContextFact.
Stable responsibility key when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Responsibility.
Child entity definition identifier.
Child entity singular display name.
Child entity plural display name.
Reference field identifier on the child entity that points back to the parent.
Stable key of the child reference field.
User-facing name of the child reference field.
Explicit table surfaces available on the child entity.
One surface metadata entry inside the admin catalog.
object
Persisted surface identifier.
Surface name.
Surface key.
Whether this surface is currently resolved as the default for its type.
Whether this Table Surface is configured as a Parent Tree View.
Stable NET package root id when this surface is package-owned.
NET package artifact id when this surface is package-owned.
Stable package surface id when this surface is package-owned.
object
object
object
object
Example
{ "Data": { "SurfaceType": 0, "ItemTargets": [ { "Target": { "TargetKind": 0, "SystemField": 0 }, "FieldType": 0, "TableRenderer": 0, "FormEditor": 0, "CardRenderer": 0, "ReferenceInputType": 0, "ReferenceRendererType": 0, "ReferenceLookupRenderType": 0, "ReferenceTargetTableSurfaces": [ { "SurfaceType": 0, "Source": 0 } ], "ReferenceTargetFormSurfaces": [ { "SurfaceType": 0, "Source": 0 } ], "ReferenceTargetDrawerSurfaces": [ { "SurfaceType": 0, "Source": 0 } ], "ReferenceTargetDetailsPageSurfaces": [ { "SurfaceType": 0, "Source": 0 } ] } ], "RelatedTableTargets": [ { "Target": { "TargetKind": 0, "SystemField": 0 }, "TableSurfaces": [ { "SurfaceType": 0, "Source": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Visual editor options for form surface configuration.
object
Minimal runtime entity metadata used by explicit UI surfaces.
object
Entity definition identifier.
Internal entity key used by runtime routes.
User-facing singular name.
User-facing plural name.
Whether entity comments are enabled.
Whether entity attachments are enabled.
Whether entity tags are enabled.
Whether runtime configured search is available for the definition.
Runtime-exposed statements for this entity.
Runtime statement descriptor exposed to clients together with predicate payloads.
object
Statement identifier.
Stable technical statement key.
User-facing statement label.
Rule evaluation context shared with fast UI runtime evaluation.
object
Current workspace user identifier.
Workspace-local current date in ISO format.
Workspace time zone identifier.
UTC instant when the context was generated.
UTC instant for the next midnight in the workspace time zone.
Owner-scoped runtime values available to rule plans.
object
object
Whether the entity is an enabled Projection Entity.
Eligible field and system-field targets for form items.
One eligible field-like target and its surface defaults.
object
Stable visual-editor key for this target.
Default user-facing label.
Technical key for test automation and admin disambiguation.
Stable field-or-system target for table, form, and card surface configurations.
object
Entity field id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.EntityField.
Display field id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.DisplayField.
Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.ObjectContextFact.
Stable responsibility key when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Responsibility.
Default sort order.
Default visibility.
Default table column width when the surface is table.
Default breadcrumb reference path.
Backend-approved breadcrumb path options for this reference target.
One backend-approved reference breadcrumb path option.
object
Reference field keys relative to the configured reference target entity.
User-facing label for the path.
Terminal entity definition identifier reached by this path.
Backend-approved hierarchy sources for one direct scalar Reference target.
object
Explicit terminal-to-ancestor paths accepted by hierarchy metadata validation.
One backend-approved reference breadcrumb path option.
object
Reference field keys relative to the configured reference target entity.
User-facing label for the path.
Terminal entity definition identifier reached by this path.
Ready indexed self-reference fields accepted as recursive parent sources.
One backend-approved recursive hierarchy parent field.
object
Stable field identifier.
Stable field key.
User-facing field name.
Create-time Reference Eligibility context for one dependent Form target.
object
Dependent Reference field identifier.
Dependent Reference field key.
Dependent Reference field display name.
Direct Eligibility drivers and external inputs used to derive them.
One direct Reference Eligibility driver and its possible external create inputs.
object
Direct driver field identifier.
Direct driver field key.
Direct driver field display name.
Alternative create inputs from which authoritative automation may derive the driver.
One possible related-create root that may be supplied outside the visual Form composition.
object
Source field identifier.
Source field key.
Source field display name.
Explicit table surfaces from the referenced target entity, used by lookup field selectors.
One surface metadata entry inside the admin catalog.
object
Persisted surface identifier.
Surface name.
Surface key.
Whether this surface is currently resolved as the default for its type.
Whether this Table Surface is configured as a Parent Tree View.
Stable NET package root id when this surface is package-owned.
NET package artifact id when this surface is package-owned.
Stable package surface id when this surface is package-owned.
Explicit form surfaces from the referenced target entity.
One surface metadata entry inside the admin catalog.
object
Persisted surface identifier.
Surface name.
Surface key.
Whether this surface is currently resolved as the default for its type.
Whether this Table Surface is configured as a Parent Tree View.
Stable NET package root id when this surface is package-owned.
NET package artifact id when this surface is package-owned.
Stable package surface id when this surface is package-owned.
Explicit drawer surfaces from the referenced target entity.
One surface metadata entry inside the admin catalog.
object
Persisted surface identifier.
Surface name.
Surface key.
Whether this surface is currently resolved as the default for its type.
Whether this Table Surface is configured as a Parent Tree View.
Stable NET package root id when this surface is package-owned.
NET package artifact id when this surface is package-owned.
Stable package surface id when this surface is package-owned.
Explicit details-page surfaces from the referenced target entity.
One surface metadata entry inside the admin catalog.
object
Persisted surface identifier.
Surface name.
Surface key.
Whether this surface is currently resolved as the default for its type.
Whether this Table Surface is configured as a Parent Tree View.
Stable NET package root id when this surface is package-owned.
NET package artifact id when this surface is package-owned.
Stable package surface id when this surface is package-owned.
Eligible direct inverse-reference targets for related-table form items.
One direct inverse-reference target eligible for a related-table form item.
object
Stable visual-editor key for this relation target.
Default user-facing label for the embedded child table.
Stable field-or-system target for table, form, and card surface configurations.
object
Entity field id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.EntityField.
Display field id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.DisplayField.
Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.ObjectContextFact.
Stable responsibility key when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Responsibility.
Child entity definition identifier.
Child entity singular display name.
Child entity plural display name.
Reference field identifier on the child entity that points back to the parent.
Stable key of the child reference field.
User-facing name of the child reference field.
Explicit table surfaces available on the child entity.
One surface metadata entry inside the admin catalog.
object
Persisted surface identifier.
Surface name.
Surface key.
Whether this surface is currently resolved as the default for its type.
Whether this Table Surface is configured as a Parent Tree View.
Stable NET package root id when this surface is package-owned.
NET package artifact id when this surface is package-owned.
Stable package surface id when this surface is package-owned.
object
object
object
object
Example
{ "Data": { "SurfaceType": 0, "ItemTargets": [ { "Target": { "TargetKind": 0, "SystemField": 0 }, "FieldType": 0, "TableRenderer": 0, "FormEditor": 0, "CardRenderer": 0, "ReferenceInputType": 0, "ReferenceRendererType": 0, "ReferenceLookupRenderType": 0, "ReferenceTargetTableSurfaces": [ { "SurfaceType": 0, "Source": 0 } ], "ReferenceTargetFormSurfaces": [ { "SurfaceType": 0, "Source": 0 } ], "ReferenceTargetDrawerSurfaces": [ { "SurfaceType": 0, "Source": 0 } ], "ReferenceTargetDetailsPageSurfaces": [ { "SurfaceType": 0, "Source": 0 } ] } ], "RelatedTableTargets": [ { "Target": { "TargetKind": 0, "SystemField": 0 }, "TableSurfaces": [ { "SurfaceType": 0, "Source": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Visual editor options for form surface configuration.
object
Minimal runtime entity metadata used by explicit UI surfaces.
object
Entity definition identifier.
Internal entity key used by runtime routes.
User-facing singular name.
User-facing plural name.
Whether entity comments are enabled.
Whether entity attachments are enabled.
Whether entity tags are enabled.
Whether runtime configured search is available for the definition.
Runtime-exposed statements for this entity.
Runtime statement descriptor exposed to clients together with predicate payloads.
object
Statement identifier.
Stable technical statement key.
User-facing statement label.
Rule evaluation context shared with fast UI runtime evaluation.
object
Current workspace user identifier.
Workspace-local current date in ISO format.
Workspace time zone identifier.
UTC instant when the context was generated.
UTC instant for the next midnight in the workspace time zone.
Owner-scoped runtime values available to rule plans.
object
object
Whether the entity is an enabled Projection Entity.
Eligible field and system-field targets for form items.
One eligible field-like target and its surface defaults.
object
Stable visual-editor key for this target.
Default user-facing label.
Technical key for test automation and admin disambiguation.
Stable field-or-system target for table, form, and card surface configurations.
object
Entity field id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.EntityField.
Display field id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.DisplayField.
Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.ObjectContextFact.
Stable responsibility key when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Responsibility.
Default sort order.
Default visibility.
Default table column width when the surface is table.
Default breadcrumb reference path.
Backend-approved breadcrumb path options for this reference target.
One backend-approved reference breadcrumb path option.
object
Reference field keys relative to the configured reference target entity.
User-facing label for the path.
Terminal entity definition identifier reached by this path.
Backend-approved hierarchy sources for one direct scalar Reference target.
object
Explicit terminal-to-ancestor paths accepted by hierarchy metadata validation.
One backend-approved reference breadcrumb path option.
object
Reference field keys relative to the configured reference target entity.
User-facing label for the path.
Terminal entity definition identifier reached by this path.
Ready indexed self-reference fields accepted as recursive parent sources.
One backend-approved recursive hierarchy parent field.
object
Stable field identifier.
Stable field key.
User-facing field name.
Create-time Reference Eligibility context for one dependent Form target.
object
Dependent Reference field identifier.
Dependent Reference field key.
Dependent Reference field display name.
Direct Eligibility drivers and external inputs used to derive them.
One direct Reference Eligibility driver and its possible external create inputs.
object
Direct driver field identifier.
Direct driver field key.
Direct driver field display name.
Alternative create inputs from which authoritative automation may derive the driver.
One possible related-create root that may be supplied outside the visual Form composition.
object
Source field identifier.
Source field key.
Source field display name.
Explicit table surfaces from the referenced target entity, used by lookup field selectors.
One surface metadata entry inside the admin catalog.
object
Persisted surface identifier.
Surface name.
Surface key.
Whether this surface is currently resolved as the default for its type.
Whether this Table Surface is configured as a Parent Tree View.
Stable NET package root id when this surface is package-owned.
NET package artifact id when this surface is package-owned.
Stable package surface id when this surface is package-owned.
Explicit form surfaces from the referenced target entity.
One surface metadata entry inside the admin catalog.
object
Persisted surface identifier.
Surface name.
Surface key.
Whether this surface is currently resolved as the default for its type.
Whether this Table Surface is configured as a Parent Tree View.
Stable NET package root id when this surface is package-owned.
NET package artifact id when this surface is package-owned.
Stable package surface id when this surface is package-owned.
Explicit drawer surfaces from the referenced target entity.
One surface metadata entry inside the admin catalog.
object
Persisted surface identifier.
Surface name.
Surface key.
Whether this surface is currently resolved as the default for its type.
Whether this Table Surface is configured as a Parent Tree View.
Stable NET package root id when this surface is package-owned.
NET package artifact id when this surface is package-owned.
Stable package surface id when this surface is package-owned.
Explicit details-page surfaces from the referenced target entity.
One surface metadata entry inside the admin catalog.
object
Persisted surface identifier.
Surface name.
Surface key.
Whether this surface is currently resolved as the default for its type.
Whether this Table Surface is configured as a Parent Tree View.
Stable NET package root id when this surface is package-owned.
NET package artifact id when this surface is package-owned.
Stable package surface id when this surface is package-owned.
Eligible direct inverse-reference targets for related-table form items.
One direct inverse-reference target eligible for a related-table form item.
object
Stable visual-editor key for this relation target.
Default user-facing label for the embedded child table.
Stable field-or-system target for table, form, and card surface configurations.
object
Entity field id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.EntityField.
Display field id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.DisplayField.
Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.ObjectContextFact.
Stable responsibility key when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Responsibility.
Child entity definition identifier.
Child entity singular display name.
Child entity plural display name.
Reference field identifier on the child entity that points back to the parent.
Stable key of the child reference field.
User-facing name of the child reference field.
Explicit table surfaces available on the child entity.
One surface metadata entry inside the admin catalog.
object
Persisted surface identifier.
Surface name.
Surface key.
Whether this surface is currently resolved as the default for its type.
Whether this Table Surface is configured as a Parent Tree View.
Stable NET package root id when this surface is package-owned.
NET package artifact id when this surface is package-owned.
Stable package surface id when this surface is package-owned.
object
object
object
object
Example
{ "Data": { "SurfaceType": 0, "ItemTargets": [ { "Target": { "TargetKind": 0, "SystemField": 0 }, "FieldType": 0, "TableRenderer": 0, "FormEditor": 0, "CardRenderer": 0, "ReferenceInputType": 0, "ReferenceRendererType": 0, "ReferenceLookupRenderType": 0, "ReferenceTargetTableSurfaces": [ { "SurfaceType": 0, "Source": 0 } ], "ReferenceTargetFormSurfaces": [ { "SurfaceType": 0, "Source": 0 } ], "ReferenceTargetDrawerSurfaces": [ { "SurfaceType": 0, "Source": 0 } ], "ReferenceTargetDetailsPageSurfaces": [ { "SurfaceType": 0, "Source": 0 } ] } ], "RelatedTableTargets": [ { "Target": { "TargetKind": 0, "SystemField": 0 }, "TableSurfaces": [ { "SurfaceType": 0, "Source": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}