API Pages Resource
Pages define the areas in which Stikis are displayed. They record details such as a title and owner, as well as display information such as a zoom level, left edge and top edge. The following table summarizes the attributes and constraints on Page resources.
| Attribute | Description | Constraints | Default | Read-only | Required on create |
|---|---|---|---|---|---|
| id | A unique numeric identifier for the page. | Positive integer. | nil | yes | no |
| title | A title for the page. | Must be unique. Cannot contain following characters (<, >, ", ’, +, #, ?, &, @). | "" | no | yes |
| user_id | A reference to the user record for the person that owns the page. | Positive integer. Must refer to an existing user. | nil | no | yes |
| zoom | A numeric value representing how far the page is zoomed (1.00 = 100%) | Positive float. | 1.0 | no | no |
| left_edge | A numeric value representing how far the page is panned from the left (ems in html). | Float. | 0.0 | no | no |
| top_edge | A numeric value representing how far the page is panned from the top (ems in html). | Float. | 0.0 | no | no |
| created_at | The date and time that the page was created. | Datetime. | nil | yes | no |
| updated_at | The date and time that the page was last updated. | Datetime. | nil | yes | no |
| accessed_at | The last time that the page was accessed | Datetime. | nil | yes | no |
Available actions
- Create: Create a new page on the site.
- Destroy: Delete a page from the site.
- Edit: Get a form for updating a page.
- Index: Get a list of all pages belonging to a user.
- New: Get a form for creating a new page.
- Show: Retrieve a copy of a page.
- Update: Update the attributes of a page.
Likely changes
Pages will likely become shareable in future, which will mean that pages will be viewable and possibly editable by more than just the owner of the page. This could also mean that view information (left_edge, top_edge, zoom) would be moved to a separate resource so different users could maintain different views of a page.
Another likely change is the addition of more format support. For example, xml support and further js support.