Skip to content

Setting

A Setting is a configurable value a Thing inherits from its nearest holder, Studio to Startup to Product, unless it sets its own.

Properties

PropertyTypeRequiredDescription
keystringrequiredThe name of the choice.
valuejsonrequiredThe chosen value.
lockedbooleanTrue when no holder below may override it.

Object

JSON
{
  "$id": "https://api.sb/tutorloop.com/settings/setting_1",
  "$type": "Setting",
  "key": "Example key",
  "value": {},
  "locked": true
}

Relationships

  • A Setting configures one Thing: the Thing whose choice a Setting holds; everything below it inherits the value unless it sets its own. configures, inverse configuredBy.

Verbs

  1. createCreates a Setting.
    POST /{namespace}/settingsdoSetting.created
  2. getReturns one Setting by id.
    GET /{namespace}/settings/{id}readNo Event
  3. listReturns Settings, newest first, one page at a time.
    GET /{namespace}/settingsreadNo Event
  4. updateChanges the given properties of a Setting.
    PATCH /{namespace}/settings/{id}doSetting.updated
  5. deleteDeletes a Setting; its history is kept.
    DELETE /{namespace}/settings/{id}doSetting.deleted

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Setting.createYesYesNoNo
Setting.getYesYesYesYes
Setting.listYesYesYesYes
Setting.updateYesYesNoNo
Setting.deleteYesYesNoNo

Call it

Text
Add a setting to QuietCopy.

Example

The Studio sets the default currency to USD. A Startup selling in euros overrides it with EUR, and its Products inherit EUR.