Data UI

Data UI is a built-in interface that lets you browse, search, create, edit, and delete documents directly from the platform — no API calls or external tooling required.

Before You Start

Data UI reads from and writes to Elasticsearch indexes that are created when an API version is deployed. The following must be in place before any data can be loaded:

  • API — at least one API created
  • Model — at least one model with fields defined; table columns and forms are generated from the model mapping
  • Endpoint — at least one endpoint assigned to the model on an API version; models without an endpoint assignment do not appear in the selector
  • Deployed API Version — the API version must be deployed; deployment creates the Elasticsearch index and without it Data UI cannot read or write documents

Overview

Data UI gives you a table view of your index data. You select an API version and a model, and the interface loads the corresponding documents from Elasticsearch. All operations go through the same validation and relational rules that apply to the API.

Use the selector at the top of the page to choose an API version and a model. The table updates automatically and shows the columns defined in the model's mapping. Only models that have at least one endpoint configured for the selected API version are listed.

Data UI — API version and model selector Select an API version and model to load the document table

Browsing & Searching

Documents are loaded in pages. Use the search box to search across all fields marked as searchable in the model configuration. A document is returned if any searchable field matches the query (OR logic). Fields not marked as searchable are never included in the search.

Data UI — document table with search Document table with pagination and full-text search

Creating a Record

Click Add New Record to open the creation form. The form is generated from the model mapping:

  • Required fields are marked and must be filled.
  • Relational fields (object / nested) show a dropdown populated from the related index. Select one item for object fields or multiple items for nested fields.
  • Date fields expect YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS format.

On submit, the record is validated and indexed. If a document with the same primary key already exists, the creation is rejected.

Data UI — create record form Create form with required field indicators and relational dropdowns

Editing a Record

Click a row to open the edit form. All fields are pre-filled with the current values. Save changes to update the document in Elasticsearch.

Relational cascade update

If the record is embedded in other models and you change a visible field, the platform automatically updates all affected related documents in the background after saving. The UI shows how many records will be affected before you confirm.

Data UI — edit record form Edit form pre-filled with existing document values

Deleting Records

You can delete a single record from its row, or select multiple rows and delete them in bulk. A record cannot be deleted if it is currently referenced by another document — the UI shows which models hold the reference.

Scenario Result
Record has no references Deleted immediately
Record is referenced by another model Blocked — the referencing model names are shown
Bulk delete with mixed records Unreferenced records are deleted; referenced ones are listed as blocked