This is non-official. It's my own attempt at documenting Fedora's REST API in a resource-oriented way.
Collection: objects
GET
Parameters
Name |
Description |
Default |
Options |
---|---|---|---|
terms |
a phrase represented as a sequence of characters (including the ? and * wildcards) for the search. If this sequence is found in any of the fields for an object, the object is considered a match. Do NOT use this parameter in combination with the "query" parameter |
|
|
query |
a sequence of space-separated conditions. A condition consists of a metadata element name followed directly by an operator, followed directly by a value. Valid element names are (pid, label, state, ownerId, cDate, mDate, dcmDate, title, creator, subject, description, publisher, contributor, date, type, format, identifier, source, language, relation, coverage, rights). Valid operators are: contains (), equals (=), greater than (>), less than (<), greater than or equals (>=), less than or equals (<=). The contains () operator may be used in combination with the ? and * wildcards to query for simple string patterns. Space-separators should be encoded in the URL as %20. Operators must be encoded when used in the URL syntax as follows: the (=) operator must be encoded as %3D, the (>) operator as %3E, the (<) operator as %3C, the (>=) operator as %3E%3D, the (<=) operator as %3C%3D, and the (~) operator as %7E. Values may be any string. If the string contains a space, the value should begin and end with a single quote character ('). If all conditions are met for an object, the object is considered a match. Do NOT use this parameter in combination with the "terms" parameter |
|
|
maxResults |
the maximum number of results that the server should provide at once. If this is unspecified, the server will default to a small value |
25 |
|
resultFormat |
the preferred output format |
html |
xml, html |
pid |
if true, the Fedora persistent identifier (PID) element of matching objects will be included in the response |
false |
true, false |
label |
if true, the Fedora object label element of matching objects will be included in the response |
false |
true, false |
state |
if true, the Fedora object state element of matching objects will be included in the response |
false |
true, false |
ownerId |
if true, each matching objects' owner id will be included in the responsefalsetrue, false |
false |
true, false |
cDate |
if true, the Fedora create date element of matching objects will be included in the response |
false |
true, false |
mDate |
if true, the Fedora modified date of matching objects will be included in the response |
false |
true, false |
dcmDate |
if true, the Dublin Core modified date element(s) of matching objects will be included in the response |
false |
true, false |
title |
if true, the Dublin Core title element(s) of matching objects will be included in the response |
false |
true, false |
creator |
if true, the Dublin Core creator element(s) of matching objects will be included in the response |
false |
true, false |
subject |
if true, the Dublin Core subject element(s) of matching objects will be included in the response |
false |
true, false |
description |
if true, the Dublin Core description element(s) of matching objects will be included in the response |
false |
true, false |
publisher |
if true, the Dublin Core publisher element(s) of matching objects will be included in the response |
false |
true, false |
contributor |
if true, the Dublin Core contributor element(s) of matching objects will be included in the response |
false |
true, false |
date |
if true, the Dublin Core date element(s) of matching objects will be included in the response |
false |
true, false |
type |
if true, the Dublin Core type element(s) of matching objects will be included in the response |
false |
true, false |
format |
if true, the Dublin Core format element(s) of matching objects will be included in the response |
false |
true, false |
identifier |
if true, the Dublin Core identifier element(s) of matching objects will be included in the response |
false |
true, false |
source |
if true, the Dublin Core source element(s) of matching objects will be included in the response |
false |
true, false |
language |
if true, the Dublin Core language element(s) of matching objects will be included in the response |
false |
true, false |
relation |
if true, the Dublin Core relation element(s) of matching objects will be included in the response |
false |
true, false |
coverage |
if true, the Dublin Core coverage element(s) of matching objects will be included in the response |
false |
true, false |
rights |
if true, the Dublin Core rights element(s) of matching objects will be included in the response |
false |
true, false |
Example: Show search form
http://localhost:8080/fedora/objects
Example: Begin search
Starts a search.
Example: Resume search
Gets the next page of search results.
objects/{pid}
An object in the repository.
GET
Without parameters
Provides an HTML representation of the object.
With parameters
A variety of views of the object can be returned, based on the values of the following optional parameters: