List component types

GET

/component-types

const url = 'https://example.com/api/v1/component-types';
const options = {method: 'GET'};

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

curl --request GET \
  --url https://example.com/api/v1/component-types

Lists the component_type registry (the taxonomy a product is classified under: mic, camera, wireless-mic under mic), ordered alphabetically by label. Each row carries its parent link, so the console reconstructs the tree client-side. Gated by component_type:read.

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

component_types

required

Array<object> | null

object

$schema

A URL to the JSON Schema for this object.

string format: uri

abbrev

A compact form of label; empty inherits the nearest ancestor’s

string

default_tags

required

Tags every instance of this type (or a descendant that does not override) starts with

Array<string> | null

forked

required

True when this shipped row carries changes of yours overriding it. Restore discards them

boolean

icon

A glyph key; empty inherits the nearest ancestor’s

string

required

The component_type’s uuid, the stable handle that survives a rename

string

inherited_abbrev

The abbrev this type would take if it stated none: the nearest ancestor’s. Absent when no ancestor states one. Served on the registry listing, on the same terms as resolved_icon

string

inherited_abbrev_source

The name of the ancestor component_type inherited_abbrev comes from, which may be further up the chain than the parent

string

inherited_icon

The glyph this type would take if it stated none: the nearest ancestor’s. Absent when no ancestor states one. Served on the registry listing, on the same terms as resolved_icon

string

inherited_icon_source

The name of the ancestor component_type inherited_icon comes from, which may be further up the chain than the parent

string

inherited_stem

The stem this type would take if it stated none: the nearest ancestor’s. Absent when no ancestor states one. Served on the registry listing, on the same terms as resolved_icon

string

inherited_stem_source

The name of the ancestor component_type inherited_stem comes from, which may be further up the chain than the parent

string

label

required

string

label_rule

The label template instances of this type get; empty inherits the nearest ancestor’s, then the global rule for components

string

name

required

The name an operator reads and types; renameable

string

official

required

True for a row this release ships. A shipped row is never written by an operator: an edit forks it

boolean

parent

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

string

parent_id

The parent component_type’s id, the canonical handle; absent for a root type

string

resolved_icon

The glyph this type shows: its own icon, else the nearest ancestor’s. Served on the registry listing, where the whole chain is already in hand; a single-row write response does not carry it

string

stem

The auto-generated component name’s prefix; empty inherits the nearest ancestor’s

string

Example

{
  "$schema": "/api/v1/schemas/ListComponentTypesOutputBody.json",
  "component_types": [
    {
      "$schema": "/api/v1/schemas/ComponentTypeBody.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"
}