Purpose

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/kilnbakery.com/purposes/purpose_1",
  "$type": "Purpose",
  "name": "Kiln Bakery"
}

RelationshipsCopy Anchor Link

• A Purpose has many Consents: the Purpose the Consent permits processing for, and nothing beyond it. consents, inverse covers.

VerbsCopy Anchor Link

1. createCreates a Purpose.
   POST /{namespace}/purposesdoPurpose.created
2. getReturns one Purpose by id.
   GET /{namespace}/purposes/{id}readNo Event
3. listReturns Purposes, newest first, one page at a time.
   GET /{namespace}/purposesreadNo Event
4. updateChanges the given properties of a Purpose.
   PATCH /{namespace}/purposes/{id}doPurpose.updated
5. deleteDeletes a Purpose; its history is kept.
   DELETE /{namespace}/purposes/{id}doPurpose.deleted

PermissionsCopy Anchor Link

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

Call itCopy Anchor Link

Add a purpose to PetPantry.

ExampleCopy Anchor Link

"Send product updates" is a Purpose with consent as its lawful basis. "Bill the Customer" is a Purpose with contract as its basis.