Versions Compared

Key

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

...

Table of Contents
2
maxLevel3

Objects

/fedora/objects

GET - Lists objects in the repository

Panel
bgColorwhite
borderStylenone

URL Parameters

Parameter

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 the value it has configured for this.  The smaller of the two will be used.

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 modification date of the Dublin Core (DC) datastream will be included in the response

false

true, false

title, creator, subject, description, publisher, contributor, date, type, format, identifier, language, relation, coverage, rights

if any of these are given as true, the associated Dublin Core element(s) of matching objects will be included in the response

false

true, false

Response

HTTP Status Code: 200

Examples

Show search form.

Start a search.

Get next page of results.

POST - Adds an object

/fedora/objects/{pid}

GET - Gets information about an object

PUT - Creates or updates an object

DELETE - Removes an object

Datastreams

/fedora/objects/{pid}/datastreams

GET - Lists datastreams in an object

/fedora/objects/{pid}/datastreams/{dsId}

GET - Gets information about a datastream

PUT - Creates or updates a datastream

DELETE - Removes a datastream

/fedora/objects/{pid}/datastreams/{dsId}/content

GET - Gets the content of a datastream

...

Methods

/fedora/objects/{pid}/methods

GET - Lists all invokable methods on an object

/fedora/objects/{pid}/methods/{sDef}

GET - Lists all invokable methods on an object, filtered by Service Definition

/fedora/objects/{pid}/methods/{sDef}/{method}

GET - Invokes a GET method on an object