Skip to content

Relationship

A Relationship is a standing Action between two Things, read in the present tense and typed by a Verb whose forms give its reverse.

A Relationship is a standing link between two Things, typed by a Verb, declared once and read from both ends.

Properties

PropertyTypeRequiredDescription
predicatestringrequiredThe name read from the source, such as makes.
inversestringrequiredThe name read from the target, such as madeBy.
provenancestringWho asserted it: Stated, Ratified, Inferred, or Observed.

Object

JSON
{
  "$id": "https://api.sb/tutorloop.com/relationships/relationship_1",
  "$type": "Relationship",
  "predicate": "Example predicate",
  "inverse": "Example inverse",
  "provenance": "Stated"
}

Relationships

  • A Relationship is typed by one Verb: a Relationship reads through a Verb whose forms name it from each side, such as makes and madeBy. typedBy, inverse types.

Verbs

  1. createCreates a Relationship.
    POST /{namespace}/relationshipsdoRelationship.created
  2. getReturns one Relationship by id.
    GET /{namespace}/relationships/{id}readNo Event
  3. listReturns Relationships, newest first, one page at a time.
    GET /{namespace}/relationshipsreadNo Event
  4. updateChanges the given properties of a Relationship.
    PATCH /{namespace}/relationships/{id}doRelationship.updated
  5. deleteDeletes a Relationship; its history is kept.
    DELETE /{namespace}/relationships/{id}doRelationship.deleted

Permissions

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

Operationowneradminmemberviewer
Relationship.createYesYesYesNo
Relationship.getYesYesYesYes
Relationship.listYesYesYesYes
Relationship.updateYesYesYesNo
Relationship.deleteYesYesYesNo

Call it

Text
Add a relationship to QuietCopy.

Example

Customer accepts Offer is one Relationship, declared once. The Customer page shows accepts, and the Offer page shows acceptedBy.