Template

A Template is an inheritable Startup definition that a new Startup extends, overriding anything it inherits.

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/tutorloop.com/templates/template_1",
  "$type": "Template",
  "body": "Example body"
}

RelationshipsCopy Anchor Link

• A Template generates many Documents: a Template fills its variables from the graph to generate a Document, such as a proposal or an invoice. generates, inverse generatedFrom.
• A Template places many Components: a Template places named Components, such as Pricing, and fills their props from records. places, inverse placedBy.
• A Template renders many Pages: a Template fills one Page per Thing or per member of a Collection. renders, inverse renderedWith.

VerbsCopy Anchor Link

1. createCreates a Template.
   POST /{namespace}/templatesdoTemplate.created
2. getReturns one Template by id.
   GET /{namespace}/templates/{id}readNo Event
3. listReturns Templates, newest first, one page at a time.
   GET /{namespace}/templatesreadNo Event
4. updateChanges the given properties of a Template.
   PATCH /{namespace}/templates/{id}doTemplate.updated
5. deleteDeletes a Template; its history is kept.
   DELETE /{namespace}/templates/{id}doTemplate.deleted
6. extendExtend adds a Template to a Startup’s bases, pinned to a Version, so the Startup inherits its definition.
   POST /{namespace}/templates/{template}/extenddoTemplate.extended
7. promotePromote moves one Startup’s refinement into a Template, so every Startup that extends the Template inherits it.
   POST /{namespace}/templates/{template}/promotedoTemplate.promoted
8. upgradeUpgrade moves a Startup to a newer Version of a Template it extends, through a Change it can review.
   POST /{namespace}/templates/{template}/upgradedoTemplate.upgraded

PermissionsCopy Anchor Link

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

Call itCopy Anchor Link

Extend the latest template with a startup.

ExampleCopy Anchor Link

A Startup that sells a collections Agent extends the Agent as a Service Template, then overrides the default Price to $150 a month.