API Resources
These are the currently-supported Siteframe resources that can be manipulated via the API. This list will be updated as necessary. Those in bold will be the most commonly-used objects.
- Audit - a log entry to the audit log.
- Comment - a comment on a page.
- Favorite - a collection of a user's favorite users.
- File - an uploaded file, such as an image file or document.
- Folder - a collection of pages.
- Group - a collection of users.
- GroupUserRel - a link between a group and a user.
- Invitation - an invitation to join the website.
- Link - a link to an external website.
- LinkPageRel - a relationship between a page and a link ("related links").
- Memo - an online message from one user to another.
- Page - a unit of content.
- PageRating - a relationship between a rating and a page.
- Ping - a readonly resource used for testing and status checks.
- Property - a global name/value pair.
- Quote - a quotation.
- RSSfeed - a RSS feed to be used on the site.
- Rating - a rating for a page.
- Subscription - a subscription to a folder.
- Tag - a tag.
- TagPageRel - a relationship between a tag and a page.
- Template - a template object.
- Text - an ad hoc text object.
- User - a user.
- UserLog - an entry in the user log.
Note that, while all resources can be retrieved using GET, not all entries can be created, updated, or deleted using POST or DELETE. A number of resources (for example, the audit and user logs) are read-only. The User object, in particular, cannot be created via the API, since there are checks in place to ensure that a new user can only be created by a human being, and not in an automated manner.
