List a component's effective properties

GET

/components/{name}/properties

const url = 'https://example.com/api/v1/components/example/properties';
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/components/example/properties

Every property the component’s product declares, resolved to the component’s own value or the contract default (is_set marks the override), plus any property set directly on the component (from_contract false). Gated by component:read; an out-of-scope component is a non-disclosing 404.

Parameters

Path Parameters

name

required

The component’s unique name

string

The component’s unique name

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

component

required

string

properties

required

Array<object> | null

object

data_type

required

The declared value type, from the property catalog

string

default_value

The contract default; omitted when the contract sets none

display_name

The property’s human label; omitted when unset

string

from_contract

required

True when the component’s product declares the property; false for one set directly on the component

boolean

is_set

required

True when the component overrides the contract default

boolean

property_type_id

required

The catalog property’s uuid, the stable form of property_type_name

string

property_type_name

required

The catalog property name

string

required

required

Whether the product contract requires a value; always false off-contract

boolean

set_value

The component’s override; omitted when the property is unset

value

The effective value: the override, or the contract default when unset

value_id

The stored value’s id when set; omitted when the property is unset

string

Example

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