Skip to content

Lifecycle

A Lifecycle is the states a Thing of one Noun moves through and the Verbs that move it between them.

Read as
GuideSpec

Properties

PropertyTypeRequiredDescription
statesstring[]requiredThe states, in order.
initialstringrequiredThe state a new Thing starts in.

Object

JSON
{
  "$id": "https://api.sb/quietcopy.com/lifecycles/lifecycle_1",
  "$type": "Lifecycle",
  "states": [
    "Example states"
  ],
  "initial": "Example initial"
}

Relationships

Verbs

  1. getReturns one Lifecycle by id.
    GET /{namespace}/lifecycles/{id}readNo Event
  2. listReturns Lifecycles, newest first, one page at a time.
    GET /{namespace}/lifecyclesreadNo Event
  3. updateChanges the given properties of a Lifecycle.
    PATCH /{namespace}/lifecycles/{id}doLifecycle.updated

Permissions

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

Operationowneradminmemberviewer
Lifecycle.getYesYesYesYes
Lifecycle.listYesYesYesYes
Lifecycle.updateYesYesYesNo

Call it

Text
Show me the latest lifecycle.

Example

The Order Lifecycle runs placed, paid, fulfilled, closed. The Verb pay moves an Order from placed to paid.