Skip to content

Page

A Page is an addressable page of a Site, of a named type such as pricing, about one Thing or each member of a Collection.

A Template renders it.

Properties

PropertyTypeRequiredDescription
pathstringrequiredThe path under its Site, such as /pricing.
kindstringThe page type, such as landing, pricing, or terms.
fromstringLineage: the slot it compiles from, as Hypothesis#<slot>@v<version>.

Object

JSON
{
  "$id": "https://api.sb/shiftnote.app/pages/page_1",
  "$type": "Page",
  "path": "/",
  "kind": "landing",
  "from": "Hypothesis#approach@v1"
}

Relationships

Verbs

  1. createCreates a Page.
    POST /{namespace}/pagesdoPage.created
  2. getReturns one Page by id.
    GET /{namespace}/pages/{id}readNo Event
  3. listReturns Pages, newest first, one page at a time.
    GET /{namespace}/pagesreadNo Event
  4. updateChanges the given properties of a Page.
    PATCH /{namespace}/pages/{id}doPage.updated
  5. deleteDeletes a Page; its history is kept.
    DELETE /{namespace}/pages/{id}doPage.deleted

Permissions

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

Operationowneradminmemberviewer
Page.createYesYesYesNo
Page.getYesYesYesYes
Page.listYesYesYesYes
Page.updateYesYesYesNo
Page.deleteYesYesYesNo

Call it

Text
Add a page to RouteWise.

Example

/inspectors/denver is a Page of kind city on a home-inspector directory, one per member of a Collection of cities. Adding an inspector updates it with no edit.