Collection

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/kilnbakery.com/collections/collection_1",
  "$type": "Collection",
  "id": "Example id",
  "type": [
    "noun_1"
  ],
  "state": "Example state",
  "outside": {},
  "query": {}
}

RelationshipsCopy Anchor Link

• A Collection contains many Things: Members are listed one by one or matched by the Collection’s saved query; a Thing can belong to many Collections. contains, inverse memberOf.

VerbsCopy Anchor Link

1. createCreates a Collection.
   POST /{namespace}/collectionsdoCollection.created
2. getReturns one Collection by id.
   GET /{namespace}/collections/{id}readNo Event
3. listReturns Collections, newest first, one page at a time.
   GET /{namespace}/collectionsreadNo Event
4. updateChanges the given properties of a Collection.
   PATCH /{namespace}/collections/{id}doCollection.updated
5. deleteDeletes a Collection; its history is kept.
   DELETE /{namespace}/collections/{id}doCollection.deleted
6. exportExport writes a Collection’s records to a file or the Startup’s warehouse, once or on a schedule.
   POST /{namespace}/collections/{collection}/exportdoCollection.exported
7. queryQuery reads any Nouns the caller’s Permissions allow, by SQL or a Relationship path, across every System in one call.
   POST /{namespace}/collections/querydoCollection.queried

PermissionsCopy Anchor Link

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

Call itCopy Anchor Link

Query the latest collection.

ExampleCopy Anchor Link

The Collection "enterprise Customers" is a saved query for Customers with more than 50 seats. A new Customer at 51 seats joins it at once.