List the components in a system

GET

/systems/{name}/members

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

The components bound into this system, ordered by name. Membership is what a role attaches to: every component staffing a role here is a member, and a member may also carry no role at all (a power conditioner is in the room without filling a declared slot). Gated by system:read; an out-of-scope system is a non-disclosing 404.

Parameters

Path Parameters

name

required

Technical name of the system

string

Technical name of the system

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

members

required

Array<object> | null

object

component

required

Technical name of the component

string

primary

required

Whether this membership is the component’s default when no system is given

boolean

system

required

Technical name of the system

string

system_count

required

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

integer format: int64

system

required

string

Example

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