Skip to content
Omniglass Omniglass Omniglass

Create a system

POST
/systems
 
curl --request POST \
  --url https://example.com/api/v1/systems \
  --header 'Content-Type: application/json' \
  --data '{ "expected_name": "example", "label": "example", "location": "example", "name": "example", "parent": "example", "standard_id": "example", "system_type_id": "example" }'

Creates a system, optionally under a parent (a root needs an all-scoped grant), at a location, conforming to a standard, and classified as a system_type. Gated by system:create; the location reference resolves within the caller’s location:read scope, because the label this stores is rendered from it, and a location outside that scope is refused (422) exactly as :renderLabel refuses to preview it.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
expected_name

The name a create form previewed (POST /systems:renderLabel returns it). The create is refused with a 409 naming what it would produce instead, rather than silently landing a different name, if the number was taken or the system_type’s stem moved while the form was open. It does not name the row (the platform still does, and the row is still name_generated): it only asserts what that name will be. Applies only when the platform names the row: sending it beside a name is a 422.

string
>= 1 characters <= 100 characters /^[a-z0-9][a-z0-9-]*$/
label

What an operator reads; the name is the address

string
location

Location name this system is placed at

string
name

Name, unique within its placement (the address; lowercase letters, digits, hyphens). Omit to have the platform generate one from the system_type’s stem.

string
>= 1 characters <= 100 characters /^[a-z0-9][a-z0-9-]*$/
parent

Parent system name; omit for a root system

string
standard_id

The standard it conforms to, by handle or uuid; omit for a one-off system

string
system_type_id

The system_type it is classified as (what kind of space it is), by name or uuid; omit to leave it unclassified

string

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created

Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
actions

The scope-aware actions the caller may perform on this row (create a child, update, delete); a UI hint, the server still enforces.

Array<string> | null
effective_tags

The resolved effective tags (key -> winning value) that cascade onto this system (platform, its location, its system tree); for the Tags column.

object
key
additional properties
string
id
required
string
label
string
label_generated
required

Whether the platform rendered this label from a label rule rather than an operator typing it. Read-only: write label to claim it, write an empty label to hand it back.

boolean
location

The location’s name, for display

string
location_id

The location’s id, the canonical handle

string
member_count
required

How many components are bound into this system

integer format: int64
name
required
string
name_generated
required

Whether the platform picked this name (from the system_type’s stem) rather than an operator typing it.

boolean
parent

The parent system’s name, for display; absent for a root system

string
parent_id

The parent system’s id, the canonical handle

string
path

The dotted address (e.g. boi.17c.$sys.av). Set on a GET or LIST response; empty on a create/update/move/rename response (refetch the row to see it).

string
path_segments

Path split on ’.’, accessors included, so the round trip through the resolver stays lossless.

Array<string> | null
renders

Two display-only compact forms of path, dash and bare. Neither is accepted back by the resolver: stripping/compacting is lossy.

object
bare
required

The dash render’s segments concatenated with no separator, with the final stem-ordinal segment compacted to when the owning type registers one (e.g. boi17c216bdsp1). On a LIST row the substitution is skipped (segments concatenated as-is) to avoid a per-row abbrev resolution; a GET always compacts it. Display only either way; not accepted by the resolver.

string
dash
required

The path’s non-accessor segments joined with ’-’ (e.g. boi-17c-216b-display-1). Display only; not accepted by the resolver.

string
standard

The standard’s handle, for display; omitted for a one-off system

string
standard_id

The standard’s uuid; the stable form of standard

string
system_type

The system_type’s name, for display: what kind of space this is (board, class, video-wall). Omitted for an unclassified system. Distinct from standard, which is the blueprint it is built to.

string
system_type_id

The system_type’s uuid; the stable form of system_type

string
Example 
{
  "$schema": "/api/v1/schemas/SystemBody.json"
}

default

Section titled “default ”

Error

Media type application/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank
Example 
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}