Regenerate a system's name

POST

/systems/{name}:resetName

const url = 'https://example.com/api/v1/systems/example:resetName';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/systems/example:resetName

Hands the pen back to the platform: regenerates the name from the system’s current system_type and placement (the same rule a nameless create applies, the type’s stem plus the lowest free ordinal, bare for the first of that stem in the placement) and marks it name_generated, whether or not it already was. An unclassified system is a 422: the stem lives on the system_type. Gated by system:rename, the same token :rename uses: it changes the name, exactly that permission’s blast radius.

Parameters

Path Parameters

name

required

The system’s name, or a dotted address (e.g. boi.17c.$sys.av)

string

The system’s name, or a dotted address (e.g. boi.17c.$sys.av)

Responses

200

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

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

Error

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"
}