Effective variables for a component

GET

/components/{name}/effective-variables

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

Resolves the variables that cascade onto a component (platform -> location -> system -> component): names union, values override most-specific-wins, with the winner and the shadowed candidates it overrode. The system band comes from the component’s PRIMARY membership; resolving against a named system is not offered here yet, unlike effective-tags. Gated by variable:read; the component must be in the caller’s component read scope.

Parameters

Path Parameters

name

required

The component’s name

string

The component’s name

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

variables

required

Array<object> | null

object

band

required

Cascade tier: 0 platform, 1 location, 2 system, 3 component

integer format: int64

depth

required

Distance up the tier’s tree from the component (0 nearest)

integer format: int64

required

string

name

required

string

owner_id

The owning entity’s id, the canonical handle; absent for a platform owner

string

owner_kind

required

string

owner_name

string

value

required

The value, shape given by value_type

value_type

required

string

winner

required

True for the resolved value; false for a shadowed candidate

boolean

Example

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