Return the runtime entity-list page bootstrap payload for the data explorer page.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/entity/example/ui/entity-list-page"),};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/entity/example/ui/entity-list-page';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/entity/example/ui/entity-list-pageAuthorizations
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
Runtime bootstrap payload for the top-level list page.
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 full-text 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.
Runtime top-level list-page orchestration model resolved from persisted configuration and current access.
object
Selector for resolving an entity UI surface by default pointer or custom key.
object
Runtime entity table-surface filter item resolved from configuration.
object
One runtime query target with backend-approved filter and sort capabilities.
object
Stable option identifier.
Localized user-facing label.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Whether multiple values are allowed for the bound field.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse-reference fields.
Select options when applicable.
Option metadata for select fields.
object
Option identifier.
Owning field identifier.
Option key.
Option display value.
Sort order.
Whether the backend accepts filter predicates for this option.
Operators accepted by the backend for this option.
Runtime variables accepted by the backend for this option.
Whether the backend accepts sort items for this option.
Base currency code for Money fields.
Reference path configured for breadcrumb rendering.
Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.
object
Stable configured target key.
Safe reason code. Does not include hidden field names.
Runtime entity table-surface sort item resolved from configuration.
object
Typed target path for a runtime list query sort item.
object
Reference path from the queried entity to the sortable terminal field or system field.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.
object
Stable configured target key.
Safe reason code. Does not include hidden field names.
One sort item in the runtime list query.
object
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Typed target path for a runtime list query sort item.
object
Reference path from the queried entity to the sortable terminal field or system field.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Machine-readable state for a reusable UI surface that is intentionally missing.
object
Selector for resolving an entity UI surface by default pointer or custom key.
object
object
object
object
object
Example
{ "Data": { "Meta": { "AccessModel": 0 }, "Model": { "MainTableSelector": { "Mode": 0 }, "RuntimeFilterItems": [ { "FilterOption": { "Kind": 0, "Reference": { "Special": 0 }, "FieldType": 0, "ReferenceDeleteBehavior": 0, "FilterOperators": [ 0 ], "FilterVariables": [ 0 ] }, "ReferenceInputType": 0, "ReferenceRendererType": 0, "ReferenceLookupRenderType": 0 } ], "RuntimeSortItems": [ { "SortTarget": { "Path": [ { "Special": 0 } ] } } ], "RuntimeDefaultSort": [ { "Field": { "Special": 0 }, "Target": { "Path": [ { "Special": 0 } ] }, "Direction": 0 } ] }, "MissingSurface": { "SurfaceType": 0, "Reason": 0, "Selector": { "Mode": 0 } } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Runtime bootstrap payload for the top-level list page.
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 full-text 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.
Runtime top-level list-page orchestration model resolved from persisted configuration and current access.
object
Selector for resolving an entity UI surface by default pointer or custom key.
object
Runtime entity table-surface filter item resolved from configuration.
object
One runtime query target with backend-approved filter and sort capabilities.
object
Stable option identifier.
Localized user-facing label.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Whether multiple values are allowed for the bound field.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse-reference fields.
Select options when applicable.
Option metadata for select fields.
object
Option identifier.
Owning field identifier.
Option key.
Option display value.
Sort order.
Whether the backend accepts filter predicates for this option.
Operators accepted by the backend for this option.
Runtime variables accepted by the backend for this option.
Whether the backend accepts sort items for this option.
Base currency code for Money fields.
Reference path configured for breadcrumb rendering.
Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.
object
Stable configured target key.
Safe reason code. Does not include hidden field names.
Runtime entity table-surface sort item resolved from configuration.
object
Typed target path for a runtime list query sort item.
object
Reference path from the queried entity to the sortable terminal field or system field.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.
object
Stable configured target key.
Safe reason code. Does not include hidden field names.
One sort item in the runtime list query.
object
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Typed target path for a runtime list query sort item.
object
Reference path from the queried entity to the sortable terminal field or system field.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Machine-readable state for a reusable UI surface that is intentionally missing.
object
Selector for resolving an entity UI surface by default pointer or custom key.
object
object
object
object
object
Example
{ "Data": { "Meta": { "AccessModel": 0 }, "Model": { "MainTableSelector": { "Mode": 0 }, "RuntimeFilterItems": [ { "FilterOption": { "Kind": 0, "Reference": { "Special": 0 }, "FieldType": 0, "ReferenceDeleteBehavior": 0, "FilterOperators": [ 0 ], "FilterVariables": [ 0 ] }, "ReferenceInputType": 0, "ReferenceRendererType": 0, "ReferenceLookupRenderType": 0 } ], "RuntimeSortItems": [ { "SortTarget": { "Path": [ { "Special": 0 } ] } } ], "RuntimeDefaultSort": [ { "Field": { "Special": 0 }, "Target": { "Path": [ { "Special": 0 } ] }, "Direction": 0 } ] }, "MissingSurface": { "SurfaceType": 0, "Reason": 0, "Selector": { "Mode": 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
Runtime bootstrap payload for the top-level list page.
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 full-text 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.
Runtime top-level list-page orchestration model resolved from persisted configuration and current access.
object
Selector for resolving an entity UI surface by default pointer or custom key.
object
Runtime entity table-surface filter item resolved from configuration.
object
One runtime query target with backend-approved filter and sort capabilities.
object
Stable option identifier.
Localized user-facing label.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Whether multiple values are allowed for the bound field.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse-reference fields.
Select options when applicable.
Option metadata for select fields.
object
Option identifier.
Owning field identifier.
Option key.
Option display value.
Sort order.
Whether the backend accepts filter predicates for this option.
Operators accepted by the backend for this option.
Runtime variables accepted by the backend for this option.
Whether the backend accepts sort items for this option.
Base currency code for Money fields.
Reference path configured for breadcrumb rendering.
Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.
object
Stable configured target key.
Safe reason code. Does not include hidden field names.
Runtime entity table-surface sort item resolved from configuration.
object
Typed target path for a runtime list query sort item.
object
Reference path from the queried entity to the sortable terminal field or system field.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.
object
Stable configured target key.
Safe reason code. Does not include hidden field names.
One sort item in the runtime list query.
object
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Typed target path for a runtime list query sort item.
object
Reference path from the queried entity to the sortable terminal field or system field.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Machine-readable state for a reusable UI surface that is intentionally missing.
object
Selector for resolving an entity UI surface by default pointer or custom key.
object
object
object
object
object
Example
{ "Data": { "Meta": { "AccessModel": 0 }, "Model": { "MainTableSelector": { "Mode": 0 }, "RuntimeFilterItems": [ { "FilterOption": { "Kind": 0, "Reference": { "Special": 0 }, "FieldType": 0, "ReferenceDeleteBehavior": 0, "FilterOperators": [ 0 ], "FilterVariables": [ 0 ] }, "ReferenceInputType": 0, "ReferenceRendererType": 0, "ReferenceLookupRenderType": 0 } ], "RuntimeSortItems": [ { "SortTarget": { "Path": [ { "Special": 0 } ] } } ], "RuntimeDefaultSort": [ { "Field": { "Special": 0 }, "Target": { "Path": [ { "Special": 0 } ] }, "Direction": 0 } ] }, "MissingSurface": { "SurfaceType": 0, "Reason": 0, "Selector": { "Mode": 0 } } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Runtime bootstrap payload for the top-level list page.
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 full-text 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.
Runtime top-level list-page orchestration model resolved from persisted configuration and current access.
object
Selector for resolving an entity UI surface by default pointer or custom key.
object
Runtime entity table-surface filter item resolved from configuration.
object
One runtime query target with backend-approved filter and sort capabilities.
object
Stable option identifier.
Localized user-facing label.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Whether multiple values are allowed for the bound field.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse-reference fields.
Select options when applicable.
Option metadata for select fields.
object
Option identifier.
Owning field identifier.
Option key.
Option display value.
Sort order.
Whether the backend accepts filter predicates for this option.
Operators accepted by the backend for this option.
Runtime variables accepted by the backend for this option.
Whether the backend accepts sort items for this option.
Base currency code for Money fields.
Reference path configured for breadcrumb rendering.
Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.
object
Stable configured target key.
Safe reason code. Does not include hidden field names.
Runtime entity table-surface sort item resolved from configuration.
object
Typed target path for a runtime list query sort item.
object
Reference path from the queried entity to the sortable terminal field or system field.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.
object
Stable configured target key.
Safe reason code. Does not include hidden field names.
One sort item in the runtime list query.
object
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Typed target path for a runtime list query sort item.
object
Reference path from the queried entity to the sortable terminal field or system field.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Machine-readable state for a reusable UI surface that is intentionally missing.
object
Selector for resolving an entity UI surface by default pointer or custom key.
object
object
object
object
object
Example
{ "Data": { "Meta": { "AccessModel": 0 }, "Model": { "MainTableSelector": { "Mode": 0 }, "RuntimeFilterItems": [ { "FilterOption": { "Kind": 0, "Reference": { "Special": 0 }, "FieldType": 0, "ReferenceDeleteBehavior": 0, "FilterOperators": [ 0 ], "FilterVariables": [ 0 ] }, "ReferenceInputType": 0, "ReferenceRendererType": 0, "ReferenceLookupRenderType": 0 } ], "RuntimeSortItems": [ { "SortTarget": { "Path": [ { "Special": 0 } ] } } ], "RuntimeDefaultSort": [ { "Field": { "Special": 0 }, "Target": { "Path": [ { "Special": 0 } ] }, "Direction": 0 } ] }, "MissingSurface": { "SurfaceType": 0, "Reason": 0, "Selector": { "Mode": 0 } } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}