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
| Property | Type | Required | Description |
|---|---|---|---|
predicate | string | required | The name read from the source, such as makes. |
inverse | string | required | The name read from the target, such as madeBy. |
provenance | string | Who asserted it: Stated, Ratified, Inferred, or Observed. |
Object
{
"$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
makesandmadeBy.typedBy, inversetypes.
Verbs
createCreates a Relationship.POST /{namespace}/relationshipsgetReturns one Relationship by id.GET /{namespace}/relationships/{id}listReturns Relationships, newest first, one page at a time.GET /{namespace}/relationshipsupdateChanges the given properties of a Relationship.PATCH /{namespace}/relationships/{id}deleteDeletes a Relationship; its history is kept.DELETE /{namespace}/relationships/{id}
Permissions
Which Access level may call each Verb. One-way Verbs wait their delay window.
| Operation | owner | admin | member | viewer |
|---|---|---|---|---|
Relationship.create | Yes | Yes | Yes | No |
Relationship.get | Yes | Yes | Yes | Yes |
Relationship.list | Yes | Yes | Yes | Yes |
Relationship.update | Yes | Yes | Yes | No |
Relationship.delete | Yes | Yes | Yes | No |
Call it
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.