Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APICore grammar

Lifecycle routes

Every Lifecycle Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for Lifecycle.

Lifecycle.get

Returns one Lifecycle by id. Verb page.

Text
GET /{namespace}/lifecycles/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Lifecycle.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
lifecycleLifecyclerequiredThe Lifecycle.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/lifecycles/lifecycle_DfihmW6mF5 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Lifecycle",
  "$id": "https://api.sb/leaseline.app/lifecycles/lifecycle_DfihmW6mF5",
  "lifecycle": {
    "$id": "https://api.sb/leaseline.app/lifecycles/lifecycle_DfihmW6mF5",
    "$type": "Lifecycle",
    "states": [
      "Example states"
    ],
    "initial": "Example initial"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/lifecycles/lifecycle_DfihmW6mF5",
    "up": "https://api.sb/leaseline.app/lifecycles"
  }
}

Lifecycle.list

Returns Lifecycles, newest first, one page at a time. Verb page.

Text
GET /{namespace}/lifecycles

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
lifecycleslist of LifecyclerequiredOne page of Lifecycles.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/lifecycles?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Lifecycle",
  "lifecycles": [
    {
      "$id": "https://api.sb/leaseline.app/lifecycles/lifecycle_DfihmW6mF5",
      "$type": "Lifecycle",
      "states": [
        "Example states"
      ],
      "initial": "Example initial"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "lifecycle_DfihmW6mF5"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/lifecycles?limit=20",
    "next": "https://api.sb/leaseline.app/lifecycles?after=lifecycle_DfihmW6mF5"
  }
}

Lifecycle.update

Changes the given properties of a Lifecycle. Verb page.

Text
PATCH /{namespace}/lifecycles/{id}

Path: id. Body, as JSON: the other inputs. Emits Lifecycle.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Lifecycle.
statesstring[]The states, in order.
initialstringThe state a new Thing starts in.

Returns

OutputTypeRequiredDescription
lifecycleLifecyclerequiredThe Lifecycle.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X PATCH https://api.sb/leaseline.app/lifecycles/lifecycle_DfihmW6mF5 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"states":["Example states"]}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "lifecycle": {
    "$id": "https://api.sb/leaseline.app/lifecycles/lifecycle_DfihmW6mF5",
    "$type": "Lifecycle",
    "states": [
      "Example states"
    ],
    "initial": "Example initial"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Lifecycle.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

Limit

Next