Skip to main content

Property templates

Route/admin/dashboard/templates
Legacy screen
This surface predates the Hive redesign; it is scheduled under #5272.

A property template is a ready-made property — a name, a JSON Schema, a category and tags — that authors can reuse instead of writing the same definition again: a UUID, a Created At timestamp, an Email, a Money Amount. Property Templates in the admin console lists every template in the installation, the system templates shipped with Apiome and the tenant templates workspaces created for themselves. Sign in to the admin console and choose Property Templates in the sidebar.

Property Templates: seven templates with their category, type, schema type, usage and status under a row of totalsProperty Templates: seven templates with their category, type, schema type, usage and status under a row of totals
Route/admin/dashboard/templates

Read the list​

The cards at the top count Total Templates, System, Tenant, Enabled, Disabled, Total Usage (how many times templates have been applied) and Categories. Each row shows:

ColumnShows
TemplateThe name — a star marks a system template — and the description
CategorySuch as Identifiers, Timestamps, Contact Info, Money & Currency or a custom one
TypeSystem (available to every tenant) or Tenant (one workspace's own)
Schema TypeThe schema's type, with its format when it has one — string (uuid)
UsageHow many times the template has been used
StatusEnabled or Disabled

To narrow the list, search by name, description, or tags, pick a category in All Categories, or tick System Only or Tenant Only. Refresh reloads it.

Act on a template​

Click ⋮ at the end of a row for its actions:

The actions menu of the Email template: View Details, Edit Template, Copy Schema, Disable Template and Delete TemplateThe actions menu of the Email template: View Details, Edit Template, Copy Schema, Disable Template and Delete Template
Route/admin/dashboard/templates
  • View Details — the description, category, type, status, usage count, visibility, tags, the JSON Schema (with Copy), when it was created and updated, and for a tenant template the Tenant and Created By.
  • Edit Template — the same form as a new template, filled in.
  • Copy Schema — copies the JSON Schema to the clipboard.
  • Disable Template / Enable Template — a disabled template is kept but no longer offered.
  • Delete Template — asks Delete template "…"? first. The template stops being offered when authors add a property; properties already created from it are not changed.
Details of the Product SKU tenant template: Retail category, private, its tags, JSON Schema, Northwind tenant and creatorDetails of the Product SKU tenant template: Retail category, private, its tags, JSON Schema, Northwind tenant and creator
Route/admin/dashboard/templates

Add a template​

  1. Click “Add Template”.
  2. Enter a Name (required) and a Description.
  3. Choose a Category, or tick Create new category and type one — it is saved in lower case with hyphens for spaces (Medical Records becomes medical-records).
  4. Write the JSON Schema (required) — for example {"type": "string", "pattern": "^[A-Z]{2}$", "example": "NZ"}.
  5. Add Tags (comma-separated) to help people find it.
  6. Leave System Template and Public ticked: a template that is either one is offered to every tenant.
  7. Click “Create Template”. Template created successfully appears and the list reloads.
Create New Template filled in for Country Code: Internationalization category, a two-letter pattern schema and three tagsCreate New Template filled in for Country Code: Internationalization category, a two-letter pattern schema and three tags
Route/admin/dashboard/templates

When the schema is not valid JSON the form says Invalid JSON schema and nothing is saved. Editing works the same way: Edit Template, change the fields, click “Save Changes”.

With the API​

The console reads and writes templates directly in the database; there is no REST endpoint or CLI command for managing them.

Where next​