List a standard's declared roles

GET

/standards/{id}/roles

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

Lists the roles this standard declares (every conforming system inherits them live), ordered by name, each with its quorum and the component_types (accepted_types) and, if pinned, the products a filling component must match. Gated by standard:read.

Parameters

Path Parameters

required

The standard id

string

The standard id

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

roles

required

Array<object> | null

object

$schema

A URL to the JSON Schema for this object.

string format: uri

accepted_types

required

The component_types a filling component’s product must be classified within (self or a descendant); empty accepts any type

Array<string> | null

alternate

The choice/alternate this role joins, addressed as “choice-name/alternate-name” (#626); absent when the role is unconditional. The same form the write body takes, so a read round-trips into a write

string

capacity

The most components the role will accept; null means no upper bound beyond quorum

integer format: int64

impact

required

What an impaired role means for its system: outage, degraded, or none

string

label

required

The role’s human label

string

name

required

The role’s name within its owner (the address)

string

pinned_products

required

If set, a filling component’s product must be one of these; empty accepts any product of an accepted type

Array<string> | null

position_labels

required

Human labels for each position within the role, by index; empty when unlabeled

Array<string> | null

quorum

required

How many components must fill the role

integer format: int64

Example

{
  "$schema": "/api/v1/schemas/ListStandardRolesOutputBody.json",
  "roles": [
    {
      "$schema": "/api/v1/schemas/SystemRoleBody.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"
}