Return the runtime entity-list page bootstrap payload for the data explorer page.

GET

/api/workspace/entity/{entityIdOrKey}/ui/entity-list-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-page

Authorizations

None

Parameters

Path Parameters

entityIdOrKey

required

string

Query Parameters

surfaceKey

string

access_token

string

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

Responses

200

application/json

object

Data

Runtime bootstrap payload for the top-level list page.

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

Statement identifier.

string

nullable

Name

Stable technical statement key.

string

nullable

DisplayName

User-facing statement label.

string

nullable

RuleEvaluationContext

Rule evaluation context shared with fast UI runtime evaluation.

object

CurrentUserId

Current workspace user identifier.

string

nullable

CurrentLocalDate

Workspace-local current date in ISO format.

string

nullable

TimeZone

Workspace time zone identifier.

string

nullable

GeneratedAtUtc

UTC instant when the context was generated.

string format: date-time

nullable

NextLocalMidnightUtc

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

string format: date-time

nullable

ContextValues

Owner-scoped runtime values available to rule plans.

object

key

additional properties

object

IsProjection

Whether the entity is an enabled Projection Entity.

boolean

Model

Runtime top-level list-page orchestration model resolved from persisted configuration and current access.

object

MainTableSelector

Selector for resolving an entity UI surface by default pointer or custom key.

object

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

string

nullable

HasConfiguredRuntimeFilterItems

boolean

RuntimeFilterItems

Array<object>

nullable

Runtime entity table-surface filter item resolved and permission-checked for the current user.

object

Key

Canonical complete-target identity used to restore configured and saved filters.

string

nullable

Label

Display label for the filter control.

string

nullable

VisibleByDefault

Whether the control is placed in the drawer initially.

boolean

SortOrder

Filter control display order.

integer format: int32

FilterOption

One runtime query target with backend-approved filter and sort capabilities.

object

Stable option identifier.

string

nullable

Label

Localized user-facing label.

string

nullable

Kind

integer format: int32

Allowed values: 0 1 2 3 4

Reference

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

FieldType

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

AllowMultiple

Whether multiple values are allowed for the bound field.

boolean

DecimalPrecision

Decimal precision when applicable.

integer format: int32

nullable

DecimalScale

Decimal scale when applicable.

integer format: int32

nullable

StringMaxLength

String max length when applicable.

integer format: int32

nullable

ReferenceToEntityDefinitionId

Target entity definition identifier for reference-style fields.

string

nullable

PairedReferenceFieldId

Paired reference field identifier for inverse-reference fields.

string

nullable

ReferenceDeleteBehavior

integer format: int32

Allowed values: 0 1 2

Options

Select options when applicable.

Array<object>

nullable

Option metadata for select fields.

object

Option identifier.

string

nullable

EntityFieldDefinitionId

Owning field identifier.

string

nullable

Key

Option key.

string

nullable

Value

Option display value.

string

nullable

SortOrder

Sort order.

integer format: int32

CanFilter

Whether the backend accepts filter predicates for this option.

boolean

FilterOperators

Operators accepted by the backend for this option.

Array<integer>

nullable

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

FilterVariables

Runtime variables accepted by the backend for this option.

Array<integer>

nullable

Allowed values: 0 1

CanSort

Whether the backend accepts sort items for this option.

boolean

RowsFilterOptions

Array<object> recursive

BaseCurrencyCode

Base currency code for Money fields.

string

nullable

ClassifierCatalogDefinitionId

Bound Classifier Catalog Definition identifier.

string

nullable

SemanticRole

integer format: int32

Allowed values: 0 1 2 3

FilterTarget

Typed server-side condition target. The first segment belongs to the queried entity; every intermediate segment must be a readable primary-table reference, and the terminal segment determines the field type, supported operators, and operand shape.

object

Path

Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both are supplied they must resolve to the same field in the entity reached by the preceding segment.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

ReferenceInputType

integer format: int32

Allowed values: 0 1 2 3

ReferenceRendererType

integer format: int32

Allowed values: 0 1

ReferenceLookupRenderType

integer format: int32

Allowed values: 0 1

ReferencePath

Reference path configured for breadcrumb rendering. This does not select the field being filtered; Moltaro.Entity.Ui.Models.Table.EntityTableSurfaceRuntimeFilterItemModel.FilterTarget carries that query path.

Array<string>

nullable

HierarchySourceKind

integer format: int32

Allowed values: 0 1

ReferenceEligibility

Dependency metadata for one direct runtime Table Surface filter item.

object

TargetFieldId

Direct source field represented by this filter item.

string

nullable

DriverFilterItemKeys

Canonical direct driver item keys when this item is dependent.

Array<string>

nullable

IsDriver

Whether an active rule depends on this item.

boolean

IsDependent

Whether an active rule governs this item’s Reference values.

boolean

Singleton

Whether the filter item may occur only once in a draft tree.

boolean

DependenciesAvailable

Whether every driver is queryable by the current actor.

boolean

RuntimeUnavailableFilterItems

Array<object>

nullable

Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.

object

Key

Stable configured target key.

string

nullable

ReasonCode

Safe reason code. Does not include hidden field names.

string

nullable

RuntimeSortItems

Array<object>

nullable

Runtime entity table-surface sort item resolved from configuration.

object

Key

string

nullable

Label

string

nullable

SortOrder

integer format: int32

SortTarget

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

RuntimeUnavailableSortItems

Array<object>

nullable

Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.

object

Key

Stable configured target key.

string

nullable

ReasonCode

Safe reason code. Does not include hidden field names.

string

nullable

RuntimeDefaultSort

Array<object>

nullable

One sort item in the runtime list query.

object

Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Direction

integer format: int32

Allowed values: 0 1

MissingSurface

Machine-readable state for a reusable UI surface that is intentionally missing.

object

SurfaceType

integer format: int32

Allowed values: 0 1 2 3 4 5

Reason

integer format: int32

Allowed values: 0 1

Selector

Selector for resolving an entity UI surface by default pointer or custom key.

object

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

string

nullable

ResolvedContainerSurfaceId

Resolved Entity List Page surface id, or null when the container is unavailable.

string

nullable

ResolvedTableSurfaceId

Resolved Table surface id, or null when the selected table is unavailable.

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": {
    "Model": {
      "MainTableSelector": {
        "Mode": 0
      },
      "RuntimeFilterItems": [
        {
          "FilterOption": {
            "Kind": 0,
            "Reference": {
              "Special": 0
            },
            "FieldType": 0,
            "ReferenceDeleteBehavior": 0,
            "FilterOperators": [
              0
            ],
            "FilterVariables": [
              0
            ],
            "SemanticRole": 0
          },
          "FilterTarget": {
            "Path": [
              {
                "Special": 0
              }
            ]
          },
          "ReferenceInputType": 0,
          "ReferenceRendererType": 0,
          "ReferenceLookupRenderType": 0,
          "HierarchySourceKind": 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
    }
  ]
}

400

Bad Request

application/json

object

Data

Runtime bootstrap payload for the top-level list page.

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

Statement identifier.

string

nullable

Name

Stable technical statement key.

string

nullable

DisplayName

User-facing statement label.

string

nullable

RuleEvaluationContext

Rule evaluation context shared with fast UI runtime evaluation.

object

CurrentUserId

Current workspace user identifier.

string

nullable

CurrentLocalDate

Workspace-local current date in ISO format.

string

nullable

TimeZone

Workspace time zone identifier.

string

nullable

GeneratedAtUtc

UTC instant when the context was generated.

string format: date-time

nullable

NextLocalMidnightUtc

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

string format: date-time

nullable

ContextValues

Owner-scoped runtime values available to rule plans.

object

key

additional properties

object

IsProjection

Whether the entity is an enabled Projection Entity.

boolean

Model

Runtime top-level list-page orchestration model resolved from persisted configuration and current access.

object

MainTableSelector

Selector for resolving an entity UI surface by default pointer or custom key.

object

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

string

nullable

HasConfiguredRuntimeFilterItems

boolean

RuntimeFilterItems

Array<object>

nullable

Runtime entity table-surface filter item resolved and permission-checked for the current user.

object

Key

Canonical complete-target identity used to restore configured and saved filters.

string

nullable

Label

Display label for the filter control.

string

nullable

VisibleByDefault

Whether the control is placed in the drawer initially.

boolean

SortOrder

Filter control display order.

integer format: int32

FilterOption

One runtime query target with backend-approved filter and sort capabilities.

object

Stable option identifier.

string

nullable

Label

Localized user-facing label.

string

nullable

Kind

integer format: int32

Allowed values: 0 1 2 3 4

Reference

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

FieldType

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

AllowMultiple

Whether multiple values are allowed for the bound field.

boolean

DecimalPrecision

Decimal precision when applicable.

integer format: int32

nullable

DecimalScale

Decimal scale when applicable.

integer format: int32

nullable

StringMaxLength

String max length when applicable.

integer format: int32

nullable

ReferenceToEntityDefinitionId

Target entity definition identifier for reference-style fields.

string

nullable

PairedReferenceFieldId

Paired reference field identifier for inverse-reference fields.

string

nullable

ReferenceDeleteBehavior

integer format: int32

Allowed values: 0 1 2

Options

Select options when applicable.

Array<object>

nullable

Option metadata for select fields.

object

Option identifier.

string

nullable

EntityFieldDefinitionId

Owning field identifier.

string

nullable

Key

Option key.

string

nullable

Value

Option display value.

string

nullable

SortOrder

Sort order.

integer format: int32

CanFilter

Whether the backend accepts filter predicates for this option.

boolean

FilterOperators

Operators accepted by the backend for this option.

Array<integer>

nullable

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

FilterVariables

Runtime variables accepted by the backend for this option.

Array<integer>

nullable

Allowed values: 0 1

CanSort

Whether the backend accepts sort items for this option.

boolean

RowsFilterOptions

Array<object> recursive

BaseCurrencyCode

Base currency code for Money fields.

string

nullable

ClassifierCatalogDefinitionId

Bound Classifier Catalog Definition identifier.

string

nullable

SemanticRole

integer format: int32

Allowed values: 0 1 2 3

FilterTarget

object

Path

Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both are supplied they must resolve to the same field in the entity reached by the preceding segment.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

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

Array<string>

nullable

HierarchySourceKind

integer format: int32

Allowed values: 0 1

ReferenceEligibility

Dependency metadata for one direct runtime Table Surface filter item.

object

TargetFieldId

Direct source field represented by this filter item.

string

nullable

DriverFilterItemKeys

Canonical direct driver item keys when this item is dependent.

Array<string>

nullable

IsDriver

Whether an active rule depends on this item.

boolean

IsDependent

Whether an active rule governs this item’s Reference values.

boolean

Singleton

Whether the filter item may occur only once in a draft tree.

boolean

DependenciesAvailable

Whether every driver is queryable by the current actor.

boolean

RuntimeUnavailableFilterItems

Array<object>

nullable

Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.

object

Key

Stable configured target key.

string

nullable

ReasonCode

Safe reason code. Does not include hidden field names.

string

nullable

RuntimeSortItems

Array<object>

nullable

Runtime entity table-surface sort item resolved from configuration.

object

Key

string

nullable

Label

string

nullable

SortOrder

integer format: int32

SortTarget

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

RuntimeUnavailableSortItems

Array<object>

nullable

Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.

object

Key

Stable configured target key.

string

nullable

ReasonCode

Safe reason code. Does not include hidden field names.

string

nullable

RuntimeDefaultSort

Array<object>

nullable

One sort item in the runtime list query.

object

Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Direction

integer format: int32

Allowed values: 0 1

MissingSurface

Machine-readable state for a reusable UI surface that is intentionally missing.

object

SurfaceType

integer format: int32

Allowed values: 0 1 2 3 4 5

Reason

integer format: int32

Allowed values: 0 1

Selector

Selector for resolving an entity UI surface by default pointer or custom key.

object

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

string

nullable

ResolvedContainerSurfaceId

Resolved Entity List Page surface id, or null when the container is unavailable.

string

nullable

ResolvedTableSurfaceId

Resolved Table surface id, or null when the selected table is unavailable.

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": {
    "Model": {
      "MainTableSelector": {
        "Mode": 0
      },
      "RuntimeFilterItems": [
        {
          "FilterOption": {
            "Kind": 0,
            "Reference": {
              "Special": 0
            },
            "FieldType": 0,
            "ReferenceDeleteBehavior": 0,
            "FilterOperators": [
              0
            ],
            "FilterVariables": [
              0
            ],
            "SemanticRole": 0
          },
          "FilterTarget": {
            "Path": [
              {
                "Special": 0
              }
            ]
          },
          "ReferenceInputType": 0,
          "ReferenceRendererType": 0,
          "ReferenceLookupRenderType": 0,
          "HierarchySourceKind": 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
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

application/json

object

Data

Runtime bootstrap payload for the top-level list page.

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

Statement identifier.

string

nullable

Name

Stable technical statement key.

string

nullable

DisplayName

User-facing statement label.

string

nullable

RuleEvaluationContext

Rule evaluation context shared with fast UI runtime evaluation.

object

CurrentUserId

Current workspace user identifier.

string

nullable

CurrentLocalDate

Workspace-local current date in ISO format.

string

nullable

TimeZone

Workspace time zone identifier.

string

nullable

GeneratedAtUtc

UTC instant when the context was generated.

string format: date-time

nullable

NextLocalMidnightUtc

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

string format: date-time

nullable

ContextValues

Owner-scoped runtime values available to rule plans.

object

key

additional properties

object

IsProjection

Whether the entity is an enabled Projection Entity.

boolean

Model

Runtime top-level list-page orchestration model resolved from persisted configuration and current access.

object

MainTableSelector

Selector for resolving an entity UI surface by default pointer or custom key.

object

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

string

nullable

HasConfiguredRuntimeFilterItems

boolean

RuntimeFilterItems

Array<object>

nullable

Runtime entity table-surface filter item resolved and permission-checked for the current user.

object

Key

Canonical complete-target identity used to restore configured and saved filters.

string

nullable

Label

Display label for the filter control.

string

nullable

VisibleByDefault

Whether the control is placed in the drawer initially.

boolean

SortOrder

Filter control display order.

integer format: int32

FilterOption

One runtime query target with backend-approved filter and sort capabilities.

object

Stable option identifier.

string

nullable

Label

Localized user-facing label.

string

nullable

Kind

integer format: int32

Allowed values: 0 1 2 3 4

Reference

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

FieldType

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

AllowMultiple

Whether multiple values are allowed for the bound field.

boolean

DecimalPrecision

Decimal precision when applicable.

integer format: int32

nullable

DecimalScale

Decimal scale when applicable.

integer format: int32

nullable

StringMaxLength

String max length when applicable.

integer format: int32

nullable

ReferenceToEntityDefinitionId

Target entity definition identifier for reference-style fields.

string

nullable

PairedReferenceFieldId

Paired reference field identifier for inverse-reference fields.

string

nullable

ReferenceDeleteBehavior

integer format: int32

Allowed values: 0 1 2

Options

Select options when applicable.

Array<object>

nullable

Option metadata for select fields.

object

Option identifier.

string

nullable

EntityFieldDefinitionId

Owning field identifier.

string

nullable

Key

Option key.

string

nullable

Value

Option display value.

string

nullable

SortOrder

Sort order.

integer format: int32

CanFilter

Whether the backend accepts filter predicates for this option.

boolean

FilterOperators

Operators accepted by the backend for this option.

Array<integer>

nullable

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

FilterVariables

Runtime variables accepted by the backend for this option.

Array<integer>

nullable

Allowed values: 0 1

CanSort

Whether the backend accepts sort items for this option.

boolean

RowsFilterOptions

Array<object> recursive

BaseCurrencyCode

Base currency code for Money fields.

string

nullable

ClassifierCatalogDefinitionId

Bound Classifier Catalog Definition identifier.

string

nullable

SemanticRole

integer format: int32

Allowed values: 0 1 2 3

FilterTarget

object

Path

Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both are supplied they must resolve to the same field in the entity reached by the preceding segment.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

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

Array<string>

nullable

HierarchySourceKind

integer format: int32

Allowed values: 0 1

ReferenceEligibility

Dependency metadata for one direct runtime Table Surface filter item.

object

TargetFieldId

Direct source field represented by this filter item.

string

nullable

DriverFilterItemKeys

Canonical direct driver item keys when this item is dependent.

Array<string>

nullable

IsDriver

Whether an active rule depends on this item.

boolean

IsDependent

Whether an active rule governs this item’s Reference values.

boolean

Singleton

Whether the filter item may occur only once in a draft tree.

boolean

DependenciesAvailable

Whether every driver is queryable by the current actor.

boolean

RuntimeUnavailableFilterItems

Array<object>

nullable

Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.

object

Key

Stable configured target key.

string

nullable

ReasonCode

Safe reason code. Does not include hidden field names.

string

nullable

RuntimeSortItems

Array<object>

nullable

Runtime entity table-surface sort item resolved from configuration.

object

Key

string

nullable

Label

string

nullable

SortOrder

integer format: int32

SortTarget

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

RuntimeUnavailableSortItems

Array<object>

nullable

Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.

object

Key

Stable configured target key.

string

nullable

ReasonCode

Safe reason code. Does not include hidden field names.

string

nullable

RuntimeDefaultSort

Array<object>

nullable

One sort item in the runtime list query.

object

Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Direction

integer format: int32

Allowed values: 0 1

MissingSurface

Machine-readable state for a reusable UI surface that is intentionally missing.

object

SurfaceType

integer format: int32

Allowed values: 0 1 2 3 4 5

Reason

integer format: int32

Allowed values: 0 1

Selector

Selector for resolving an entity UI surface by default pointer or custom key.

object

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

string

nullable

ResolvedContainerSurfaceId

Resolved Entity List Page surface id, or null when the container is unavailable.

string

nullable

ResolvedTableSurfaceId

Resolved Table surface id, or null when the selected table is unavailable.

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": {
    "Model": {
      "MainTableSelector": {
        "Mode": 0
      },
      "RuntimeFilterItems": [
        {
          "FilterOption": {
            "Kind": 0,
            "Reference": {
              "Special": 0
            },
            "FieldType": 0,
            "ReferenceDeleteBehavior": 0,
            "FilterOperators": [
              0
            ],
            "FilterVariables": [
              0
            ],
            "SemanticRole": 0
          },
          "FilterTarget": {
            "Path": [
              {
                "Special": 0
              }
            ]
          },
          "ReferenceInputType": 0,
          "ReferenceRendererType": 0,
          "ReferenceLookupRenderType": 0,
          "HierarchySourceKind": 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
    }
  ]
}

409

Conflict

application/json

object

Data

Runtime bootstrap payload for the top-level list page.

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

Statement identifier.

string

nullable

Name

Stable technical statement key.

string

nullable

DisplayName

User-facing statement label.

string

nullable

RuleEvaluationContext

Rule evaluation context shared with fast UI runtime evaluation.

object

CurrentUserId

Current workspace user identifier.

string

nullable

CurrentLocalDate

Workspace-local current date in ISO format.

string

nullable

TimeZone

Workspace time zone identifier.

string

nullable

GeneratedAtUtc

UTC instant when the context was generated.

string format: date-time

nullable

NextLocalMidnightUtc

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

string format: date-time

nullable

ContextValues

Owner-scoped runtime values available to rule plans.

object

key

additional properties

object

IsProjection

Whether the entity is an enabled Projection Entity.

boolean

Model

Runtime top-level list-page orchestration model resolved from persisted configuration and current access.

object

MainTableSelector

Selector for resolving an entity UI surface by default pointer or custom key.

object

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

string

nullable

HasConfiguredRuntimeFilterItems

boolean

RuntimeFilterItems

Array<object>

nullable

Runtime entity table-surface filter item resolved and permission-checked for the current user.

object

Key

Canonical complete-target identity used to restore configured and saved filters.

string

nullable

Label

Display label for the filter control.

string

nullable

VisibleByDefault

Whether the control is placed in the drawer initially.

boolean

SortOrder

Filter control display order.

integer format: int32

FilterOption

One runtime query target with backend-approved filter and sort capabilities.

object

Stable option identifier.

string

nullable

Label

Localized user-facing label.

string

nullable

Kind

integer format: int32

Allowed values: 0 1 2 3 4

Reference

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

FieldType

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

AllowMultiple

Whether multiple values are allowed for the bound field.

boolean

DecimalPrecision

Decimal precision when applicable.

integer format: int32

nullable

DecimalScale

Decimal scale when applicable.

integer format: int32

nullable

StringMaxLength

String max length when applicable.

integer format: int32

nullable

ReferenceToEntityDefinitionId

Target entity definition identifier for reference-style fields.

string

nullable

PairedReferenceFieldId

Paired reference field identifier for inverse-reference fields.

string

nullable

ReferenceDeleteBehavior

integer format: int32

Allowed values: 0 1 2

Options

Select options when applicable.

Array<object>

nullable

Option metadata for select fields.

object

Option identifier.

string

nullable

EntityFieldDefinitionId

Owning field identifier.

string

nullable

Key

Option key.

string

nullable

Value

Option display value.

string

nullable

SortOrder

Sort order.

integer format: int32

CanFilter

Whether the backend accepts filter predicates for this option.

boolean

FilterOperators

Operators accepted by the backend for this option.

Array<integer>

nullable

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

FilterVariables

Runtime variables accepted by the backend for this option.

Array<integer>

nullable

Allowed values: 0 1

CanSort

Whether the backend accepts sort items for this option.

boolean

RowsFilterOptions

Array<object> recursive

BaseCurrencyCode

Base currency code for Money fields.

string

nullable

ClassifierCatalogDefinitionId

Bound Classifier Catalog Definition identifier.

string

nullable

SemanticRole

integer format: int32

Allowed values: 0 1 2 3

FilterTarget

object

Path

Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both are supplied they must resolve to the same field in the entity reached by the preceding segment.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

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

Array<string>

nullable

HierarchySourceKind

integer format: int32

Allowed values: 0 1

ReferenceEligibility

Dependency metadata for one direct runtime Table Surface filter item.

object

TargetFieldId

Direct source field represented by this filter item.

string

nullable

DriverFilterItemKeys

Canonical direct driver item keys when this item is dependent.

Array<string>

nullable

IsDriver

Whether an active rule depends on this item.

boolean

IsDependent

Whether an active rule governs this item’s Reference values.

boolean

Singleton

Whether the filter item may occur only once in a draft tree.

boolean

DependenciesAvailable

Whether every driver is queryable by the current actor.

boolean

RuntimeUnavailableFilterItems

Array<object>

nullable

Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.

object

Key

Stable configured target key.

string

nullable

ReasonCode

Safe reason code. Does not include hidden field names.

string

nullable

RuntimeSortItems

Array<object>

nullable

Runtime entity table-surface sort item resolved from configuration.

object

Key

string

nullable

Label

string

nullable

SortOrder

integer format: int32

SortTarget

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

RuntimeUnavailableSortItems

Array<object>

nullable

Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema.

object

Key

Stable configured target key.

string

nullable

ReasonCode

Safe reason code. Does not include hidden field names.

string

nullable

RuntimeDefaultSort

Array<object>

nullable

One sort item in the runtime list query.

object

Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Direction

integer format: int32

Allowed values: 0 1

MissingSurface

Machine-readable state for a reusable UI surface that is intentionally missing.

object

SurfaceType

integer format: int32

Allowed values: 0 1 2 3 4 5

Reason

integer format: int32

Allowed values: 0 1

Selector

Selector for resolving an entity UI surface by default pointer or custom key.

object

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

string

nullable

ResolvedContainerSurfaceId

Resolved Entity List Page surface id, or null when the container is unavailable.

string

nullable

ResolvedTableSurfaceId

Resolved Table surface id, or null when the selected table is unavailable.

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": {
    "Model": {
      "MainTableSelector": {
        "Mode": 0
      },
      "RuntimeFilterItems": [
        {
          "FilterOption": {
            "Kind": 0,
            "Reference": {
              "Special": 0
            },
            "FieldType": 0,
            "ReferenceDeleteBehavior": 0,
            "FilterOperators": [
              0
            ],
            "FilterVariables": [
              0
            ],
            "SemanticRole": 0
          },
          "FilterTarget": {
            "Path": [
              {
                "Special": 0
              }
            ]
          },
          "ReferenceInputType": 0,
          "ReferenceRendererType": 0,
          "ReferenceLookupRenderType": 0,
          "HierarchySourceKind": 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
    }
  ]
}

Return the runtime entity-list page bootstrap payload for the data explorer page.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated