Thread
A Thread is a set of Messages replying to one another inside a Channel.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
subject | string | What the Thread is about. |
Object
{
"$id": "https: //api.sb/ kilnbakery.com/ threads/ thread_1",
"$type": "Thread",
"subject": "Example subject"
}Relationships
- A Thread groups many Messages: a Thread groups Messages that reply to one another.
groups, inversethread. - A Thread is hosted in one Channel: a Channel holds Threads.
hostedIn, inversehosts. - A Thread has many Questions: each Question posts in the Thread of the record it concerns, where free-text replies land.
questions, inversepostedIn. - A Thread is raised in one Conversation: the intake Threads a support Conversation opens, each deadline counted from the Conversation’s first Message.
raisedIn, inverseraises.
Verbs
createCreates a Thread.POST /{namespace}/threadsgetReturns one Thread by id.GET /{namespace}/threads/{id}listReturns Threads, newest first, one page at a time.GET /{namespace}/threadsupdateChanges the given properties of a Thread.PATCH /{namespace}/threads/{id}deleteDeletes a Thread; its history is kept.DELETE /{namespace}/threads/{id}
Permissions
Which Access level may call each Verb. One-way Verbs wait their delay window.
| Operation | owner | admin | member | viewer |
|---|---|---|---|---|
Thread.create | Yes | Yes | Yes | No |
Thread.get | Yes | Yes | Yes | Yes |
Thread.list | Yes | Yes | Yes | Yes |
Thread.update | Yes | Yes | Yes | No |
Thread.delete | Yes | Yes | Yes | No |
Call it
Add a thread to PetPantry.Example
A parent's question about a missed session, the tutor's reply, and the parent's follow-up form one Thread in the help@ Channel.