Plan a simulated system to a standard

GET

/simulation/standards/{standard}:plan

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

Previews a simulated system built to a standard: each of the standard’s roles (one alternate taken per choice) staffed with the first simulated product that fits its accepted types and pins, as many as its quorum and at least one, or left short with the reason when nothing simulated fits. Creates nothing. Gated by simulation:read.

Parameters

Path Parameters

standard

required

The standard to staff, by name

string

The standard to staff, by name

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

alternates

required

The alternate taken for each of the standard’s choices.

object

key

additional properties

string

components

required

How many simulated components the system would get.

integer format: int64

roles

required

Array<object> | null

object

alternate

The choice alternate the role belongs to, choice/alternate; empty when unconditional.

string

count

required

How many simulated components the role gets: its quorum, at least one, capped at its capacity.

integer format: int64

missing

How many the role stays short when nothing simulated fits.

integer format: int64

product

The simulated product chosen for the role; empty when nothing simulated fits.

string

reason

Why the role is left unstaffed.

string

role

required

string

standard

required

string

Example

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