Versions Compared

Old Version 8

changes.mady.by.user Nigel Banks

Saved on

compared with

New Version Current

changes.mady.by.user David Wilcox

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Much of the functionality that is exposed through the RESTful HTTP API is also available using an HTML user interface interpreted by your favorite web browser.  Whether your request for particular HTTP API endpoints results in an HTML UI or more machine-readable formats is based on content negotiation headers.  This tour walks you through the major user interface components when accessing the HTTP API through a web browser.

Home Page

When you access the root path of the RESTful HTTP API you are presented with a rendering of the root level of your Fedora repository

Now that you have Fedora 4 running either as a war deployed to Tomcat or via Maven and Jetty, you can navigate in your web-browser to the HTML front end of Fedora 4.
 
Which should be located here: http://localhost:8080/rest
 
The interface is comprised of several regions:

The Navigation Bar

 
Image Removed
From here you can navigate between Home/Namespace/Workspaces and the search interface. 

Home

Image Removed

Is where the heart is, also where you will spend most of your time.

From here you can:

  • Ingest new Objects and Data-streams. Create new Resources (Containers or Binaries)
  • Inspect the properties of Objects and Data-streamsResources. 
  • Update the properties of Objects and Data-streamsResources.
  • Navigate the Repository Hierarchy of Objects and Data-streams.Resources.
  • Import/Export Resources.
  • Start Transactions.

Image Added

The user interface is divided into regions.

  • Navigation bar (top)
  • Resource information and navigation (center left)
  • Optional resource actions (center right)

Navigation Bar

The navigation bar, which appears at the top of each page, includes links to the following:

Resource Information

Information about the resource requested is displayed below the navigation bar, filling the left two thirds of interface.

 

Section
Column

Image Added

Column

1 Object Title 

If a title (either http://www.w3.org/2000/01/rdf-schema#label or http://purl.org/dc/elements/1.1/title) is available, it is displayed here. If no title has been assigned, the resource URI is displayed in this location.

2 Object Path 

Fedora 4 is different from Fedora 3 in that there is an innate tree hierarchy to the repository rather than a flat

...

Image RemovedJust below the Navigation bar, we have the path to the Object (Which is also it's identifier) displayed as the page's title. 

The displayed breadcrumbs can be used to navigate back up the hierarchy to the ancestors of the currently display object.

Image Removed

Here all the properties that describe the object are enumerated, as well as some of the child Object / Data-stream properties.

You can ingest new Object's and Data-streams via the "Create New Node" widget. You can either give your own identifier or use an auto-generated one.

 Newly ingested Objects and Data-streams will occur under the Object in which you are currently viewing.

structure. The path (list of ancestors) for the viewed resource is presented below the object title. Performance is expected to be better with a deeper hierarchy with fewer items per level as opposed to a shallow hierarchy where each level has a larger number of siblings. The automatic ID (and path) generated is meant to optimize performance, but you may use your own organizational strategy when creating resources.

In this particular example, the container was created with a fully qualified name including a namespace and local name (separated by a colon). Fedora 4 does not require (nor recommend) that identifiers have namespaces.

3 Featured Properties

Very basic metadata such as the UUID and modification/creation times and users are presented below the resource path.

4 Children

Any children that the container has will be listed and linked here. Like the parent containter, if a child resource has recognized title metadata, the title will be presented here rather than its URI.

5 All Resource Properties 

All properties of the resource are presented here. Hover your mouse over the namespace prefix to see the full namespace.

6 Other Resources 

A subset of properties from the parent resource. Click on the gray box to expand the list of properties or the label text to view that resource directly.


 

Actions

Include Page
Feature Tour - Actions
Feature Tour - Actions
Currently creating Data-streams is not functional though this interface.