Skip to content
Omniglass Omniglass Omniglass

Update a component

PATCH
/components/{name}
 
curl --request PATCH \
  --url https://example.com/api/v1/components/example \
  --header 'Content-Type: application/json' \
  --data '{ "label": "example", "product": "example" }'

Patches a component’s label or product. The name is not patchable: renaming is the :rename custom method. Placement is not patchable either: relocating or re-parenting is the :move custom method, gated separately, because a placement change is an authorization act. Product is required, so it is unchanged when omitted and reclassified when named, but an explicit empty string is refused (422), not a clear. Gated by component:update; read and update scopes drive the 404 versus 403 split.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
name
required

The component’s name, or a dotted address (e.g. boi.17c.415a.$comp.display-1)

string

The component’s name, or a dotted address (e.g. boi.17c.415a.$comp.display-1)

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
label

A new operator-facing label

string
product

Re-classifies the component to this product (catalog SKU), by name or uuid. Required once set: an empty string is refused (422), not a clear. Explicitly-set property values persist; the new product’s contract defaults follow.

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

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 component; for the Tags column. Provenance is in the effective-tags detail view.

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
name
required
string
name_generated
required

Whether the platform picked this name (a server-side generator) rather than an operator typing it.

boolean
parent

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

string
parent_id

The parent component’s id, the canonical handle

string
path

The dotted address (e.g. boi.17c.415a.$comp.display-1): derived from the component’s own placement, never from a system it belongs to. Set on a GET or LIST response; empty on a create/update/move/rename/resetName 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
product

The product’s name, for display; the form a body round-trips.

string
product_id

The product (catalog SKU) this component is an instance of, if any; the stable handle that survives a rename.

string
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
system

Name of the component’s primary system, its default when no system is named. A component may belong to several; read /components/{name}/memberships for all of them.

string
system_count
required

How many systems this component belongs to; more than one means it is shared.

integer format: int64
system_id

The primary system’s id, the canonical handle

string
Example 
{
  "$schema": "/api/v1/schemas/ComponentBody.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"
}