1.5 Navigation

The Filr REST Interface is fully navigable. In other words, resources contain links to other related resources, so clients can navigate from one resource to another without needing to understand the URL scheme of the REST interface.

For example, a folder resource contains links to the parent folder attribute, the lists of files and folders, etc.

The starting point for the REST Interface is https://[server_address]:[port]/rest.

This response consists of a list of related links. Each link has a “rel” (relation) attribute and an “href” attribute. All href values are relative to the base REST URL. After I request the root resource (/rest), I can retrieve the “self” resource as follows (append the href, /self, to https://amethyst.wal.novell.com:8443/rest):

The “self” resource is a User object representing the user making the REST request. It contains a number of additional related links (not shown in the example above), which allow the client to continue navigating the REST interface.