Effective tags for a component

GET

/components/{name}/effective-tags

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

Resolves the tags that cascade onto a component (platform -> location -> system -> component): keys union, values override most-specific-wins, with the winner and shadowed candidates. A non-propagating key resolves only from a binding on the component itself. The system band comes from MEMBERSHIP: pass ?system= to resolve against one the component belongs to (a shared device answers differently for each), or omit it to resolve against its primary membership. Gated by component: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

Query Parameters

system

Resolve against this system, which the component must be a member of. Omit to resolve against its primary membership, the default for a caller with no system in hand.

string

Resolve against this system, which the component must be a member of. Omit to resolve against its primary membership, the default for a caller with no system in hand.

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

tags

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

key

required

string

owner_id

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

string

owner_kind

required

string

owner_name

string

value

required

string

winner

required

True for the resolved value; false for a shadowed candidate

boolean

Example

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