Skip to content

Training Create a Data Model

Craig Scott edited this page Jun 9, 2026 · 1 revision

Training: Create a Data Model

What you'll learn: how to create a data model, the naming rules, and where fields and deployment happen. You need: Administrator or Developer access type, an Application Development application. Time: 8 minutes.

Before you start

Pick the Data Model Kind — it determines how the model behaves:

Kind Use it for
Reference Standalone records with their own API (most models)
Embeddable Structures embedded inside other models

Naming rule: model names must contain only alphabetic characters — no spaces, digits, or symbols. Use PascalCase, e.g. WorkOrder, not Work Order 2.

Steps

  1. Go to Left menu → Schema & GraphQL → Data Models. (Fallback: header Search "Data Models".) Data models
  2. Click +. The Create a new Data Model dialog opens.
  3. Type the Name (alphabetic only, e.g. Asset).
  4. Type a Description.
  5. Pick the Data Model Kind (Reference or Embeddable). Create data model
  6. Click the orange +. You land on the model's detail page. Model detail
  7. Click the screen icon (🖥) in the toolbar to open the model in the Schema Designer, where you add fields (Toolbox → Field) on the canvas. Schema Designer
  8. Back on the model detail, open the VERSIONS tab, click + to create a version, then click ⬆ to deploy it. The model is live only after a version is deployed.

Check your work

The Data Models table shows your model with a Current Deployment, the DATA MODELS KPI tile on Home counts it as deployed, and its generated Query/Mutation types appear in the GraphQL API Explorer's Documentation Explorer.

If creation fails with an "Error modifying data" toast, click the bell icon → the Activity entry explains why — most often the alphabetic-only name rule.

Try it yourself

Create a Reference model named TrainingAsset, open it in the Schema Designer, then delete the model from its detail page (trash icon).

Related training

Training: Explore the GraphQL API · Training: Add a Custom Field · Training: Navigate the Application Designer

🏠 Home

Getting Started (14)
Training Guides (52)

Applications

Access & Users

Data Models & Schema

Screens

Weather Lookup Series — guided 3-part build

Data Flows & Integrations

Data, Reporting & Monitoring

Enterprise & Organizations

Platform Concepts & Architecture (10)
Screens & Application Design (17)
Data Models & Schema (8)
Data Flows & Scripting (51)

Designing Flows

Data Flow Nodes

JSONata Reference

Scripting

Integrations & Connectors (30)

General & iPaaS

Plex

EDI

IIoT & Edge Gateway (18)

Physical Device Connectors

Edge Data Connectors

Reporting, Documents & Dashboards (8)
Administration & Access Control (27)
Data Management (8)
Accelerators, Templates & Packages (8)
Design Standards (1)
How-To Guides (8)
FAQ & Troubleshooting (1)
Release Notes (117)

2026

2025

2024

2023

2022

2021

2020

Policies & Company (6)

Clone this wiki locally