Skip to content
omnismith docs

Create and Edit Entities

An Entity represents an active data record instantiated from a specific Template (e.g. a specific server prod-app-01, a customer ACME Corp, or a ticket #104).

1. Creating an Entity in the UI

Section titled “1. Creating an Entity in the UI”
  1. Navigate to Entity Operations → Entities via the navigation launcher.
  2. Select your target template from the Template Gateway (e.g. Server Node).
  3. Click + Create Entity.
  4. The dynamic entry form renders all attached attributes:
    • Dimensions: Text fields, dates, flags, and dropdown selection lists.
    • Metrics: Initial numeric values (e.g. Initial CPU % or Balance).
    • References: Searchable dropdowns pointing to target entities.
  5. Click Save.

Entity search list and entity details interface

2. Entity Detail Workspace Tabs

Section titled “2. Entity Detail Workspace Tabs”

When you select an entity from the search list, the detail workspace provides three dedicated tabs:

  • Attributes: View and edit the current value of every dimension, metric, list option, and reference link. Fields are organized into structured section cards based on the template’s Attribute Groups (as shown in the entity card on the right of /assets/SH-020.png), displaying section icons, custom headings, and responsive 1 or 2-column layouts.
  • History: Review the complete immutable audit change log of every edit, detailing what changed, when, and by whom.
  • Chart: Analyze interactive time-series plots for numeric metric attributes over historical time windows.

3. Dynamic Field Validation

Section titled “3. Dynamic Field Validation”

Omnismith automatically validates attribute inputs on save:

  • Required Fields: Ensures mandatory dimensions and references are populated.
  • Data Type Safety: Enforces numeric ranges, valid date formats (YYYY-MM-DD), ISO timestamps, and strict List options.
  • Reference Integrity: Verifies that referenced target entities exist and are active.

4. Programmatic Ingestion via Slugs & REST API

Section titled “4. Programmatic Ingestion via Slugs & REST API”

Omnismith allows external systems, background agents, and CI/CD pipelines to create and update entities using project-unique slugs:

Creating an Entity Using Slugs

Section titled “Creating an Entity Using Slugs”

Post directly to /api/v1/entities using template_slug and attribute_slug fields:

Terminal window
curl -X POST "https://api.omnismith.io/api/v1/entities" \
  -H "Authorization: Bearer omni_live_secret_key_12345" \
  -H "Content-Type: application/json" \
  -d '{
    "template_slug": "server_node",
    "attribute_values": [
      {
        "attribute_slug": "hostname",
        "value": "web-prod-03"
      },
      {
        "attribute_slug": "cpu_usage",
        "value": "72.4"
      }
    ]
  }'

Retrieving Entities with Slug-Keyed Values

Section titled “Retrieving Entities with Slug-Keyed Values”

When reading entity data, append ?attribute_key=slug to receive a dictionary keyed by string slugs instead of database UUIDs:

Terminal window
curl -X GET "https://api.omnismith.io/api/v1/entities/{entityId}?attribute_key=slug" \
  -H "Authorization: Bearer omni_live_secret_key_12345"
{
  "id": "019fe207-38eb-7182-9a5f-70cdaeea34f2",
  "template_slug": "server_node",
  "attribute_values": {
    "hostname": {
      "value": "web-prod-03",
      "attribute_slug": "hostname"
    },
    "cpu_usage": {
      "value": "72.4",
      "attribute_slug": "cpu_usage"
    }
  }
}