Skip to content
API Now! is currently in closed beta. We are constantly updating these guides as we release updates!

Standard Smart Fields Reference

This reference guide provides a complete dictionary of the Smart Fields (Data Semantics) available in the Domain Modeler. Applying these tags to your properties automates complex backend logic like security, audit trails, and input validation without writing code.


These fields define system users, manage authentication credentials, and enforce data ownership rules.

Smart Field Business Behavior Automatic Backend Action Example Use Case
User Marks an entity as a system user. Enables user account features. Customer or Employee profile.
Username Represents the unique identifier for logging in. Enforces uniqueness. Sign-in email address or custom handle.
Password A secure, encrypted credentials field. Hashing (e.g. bcrypt) on write. Write-only; hidden from API reads. Login credentials.
UserRole Sets user permission roles. Enforces Role-Based Access Control (RBAC). Roles: Admin, Manager, Customer.
ResourceOwnerIdentifier Binds a record to the user who created it. Enforces row-level security (only owner can read/write). Order linked to the buying user.
RelationalResourceOwner Transitive ownership through parent associations. Inherits security permissions from parent records. Comment inheriting ownership from Post.

These fields automatically record who changed your data and when, keeping a secure history of all transactions.

Smart Field Business Behavior Automatic Backend Action Example Use Case
CreatedTimestamp Records when a record was first created. Auto-populates the date/time on initial entry. created_at audit field.
UpdatedTimestamp Records when a record was last modified. Auto-updates the date/time whenever edits occur. updated_at audit field.
DeletedTimestamp Records the exact time of soft-deletion. Populates with date/time when a record is deleted. Soft-delete tracking.
DeletedFlag Flags whether a record is active or deleted. True/False boolean. Deletes flag the row as “hidden”. Moves items to the Recycle Bin.
CreatedBy Identifies the user who created the record. Auto-populates with the active session user’s ID. Track which team member created a listing.
UpdatedBy Identifies the user who last updated the record. Auto-updates with the active editor’s user ID. Audit who modified pricing.
DeletedBy Identifies the user who deleted the record. Auto-populates with the user ID who soft-deleted it. Track who deleted a customer record.
Version Protects data from simultaneous edits. Optimistic locking counter to prevent overwrites. Prevent editing collisions.

These fields automate standard text validation for communications and web identifiers.

Smart Field Business Behavior Automatic Backend Action Example Use Case
Email Represents a verified email address. Automatically validates standard email formats. contact_email fields.
Phone Represents a formatted phone number. Automatically sanitizes and formats inputs. Customer cell numbers.
URL Represents a web hyperlink. Validates standard web URL structures. Company website URLs.
ClientIPAddress Records the IP address of the requester. Auto-populates with the caller’s IP address. Logging API client requests.

These fields manage financial values, product identifiers, and custom lifecycle workflows.

Smart Field Business Behavior Automatic Backend Action Example Use Case
Currency Handles monetary transactions securely. Stores amounts in base units (cents) to avoid rounding bugs. Product prices, billing invoices.
SKU Represents a stock keeping unit code. Validates alphanumeric serial code formats. Product inventory tracking.
Status Tracks the lifecycle states of a record. Limits changes to predefined states (State Machine). Draft $\rightarrow$ Published $\rightarrow$ Archived.

These fields handle physical addresses and location-based coordinates.

Smart Field Business Behavior Automatic Backend Action Example Use Case
Address Represents a complete physical address structure. Validates nested street, city, region structures. Shipping address profiles.
StreetAddress Primary street line. Standard text validation. 123 Main Street.
City Represents a city or locality. Standard text validation. San Francisco.
Region Represents a state, province, or territory. Standard text validation. California.
Country Represents a country. Validates ISO two-letter country codes (e.g., US). Country profiles.
PostalCode Represents a ZIP or postal code. Dynamically validates codes based on selected country. 94107 or EC1A 1BB.
GeospatialCoordinates Represents latitude & longitude coordinates. Enables spatial indexing and proximity queries. Finding stores within a 5-mile radius.

These fields handle human-readable text, media attachments, and database organization tags.

Smart Field Business Behavior Automatic Backend Action Example Use Case
Title / Name Primary heading or person’s name. Standard high-priority indexing. Blog title, customer name.
Description / Summary Detailed paragraphs or brief excerpts. Long-form text formatting. Product descriptions.
Markdown Formatted rich text using Markdown. Automatically sanitizes text to block security hacks (XSS). Blog post content.
HTML Raw rich HTML block. Sanitizes and validates HTML safety tags. Embed codes.
ImageURL / FileURL Links to uploaded images or attachments. Stores file links and validates URL endpoints. Product main image, invoice PDF.
PublicUniqueName URL-friendly unique slug. Auto-generates unique slugs (e.g., my-product-name). Friendly blog post links.
Tags / Categories Labels for grouping and filtering. Enables multi-tag indexing and nested groupings. Product categories (Electronics).

These fields perform calculations automatically at the database level when records are saved.

Smart Field Business Behavior Automatic Backend Action Example Use Case
Calculated Evaluates a mathematical formula. Auto-calculates values from numeric properties. Formula: price * quantity.
Derived Concatenates or derives text values. Auto-joins text fields together. Join: firstName + " " + lastName.