Page History

...

Student: Bojan Suzic, University of Technology Graz

Mentor: Aaron Zeckoski

Wiki MarkupContacting author: bojan AT trust - b . com using subject line \ [DSPACE:DSpace\]

SCM Location for Project: http://scm.dspace.org/svn/repo/modules/rest

...

Name and description	Value and notes
Base URI:
Description:	Returns a list of all communities on the system or return just top level communities.
HTTP method:	`GET`
Optional parameters:
Sorting fields supported:	`id, name, countitems`: sorting by id, community name and item count
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 204: no content 400: bad request 500: internal server error }}
Response details

Name and description	Value and notes
Base URI:
Description:	Returns a list of all parent communities of the `id` community.
HTTP method:	`GET`
Optional parameters:
Sorting fields supported:	`id, name, countitems`: sorting by id, community name and item count
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 204: no content 400: bad request 500: internal server error }}
Response details

Name and description	Value and notes
Base URI:
Description:	Returns a list of immediate sub-communities (children) of the `id` community.
HTTP method:	`GET`
Optional parameters:
Sorting fields supported:	`id, name, countitems`: sorting by id, community name and item count
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 204: no content 400: bad request 500: internal server error }}
Response details

Name and description	Value and notes
Base URI:
Description:	Returns a list of collections in the `id` community
HTTP method:	`GET`
Optional parameters:
Sorting fields supported:	`id, name, countitems`: sorting by id, collection name and item count
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 204: no content 400: bad request 500: internal server error }}
Response details

Name and description	Value and notes
Base URI:
Description:	Returns a list of recent submissions to a community
HTTP method:	`GET`
Optional parameters:
Sorting fields supported:	`id, name, lastmodified, submitter`: sorting by id, name(title), last modified date and submitter(name) of item
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 204: no content 400: bad request 500: internal server error }}
Response details

Name and description	Value and notes
Base URI:
Description:	Returns a list of all collections in the system
HTTP method:	`GET`
Optional parameters:
Sorting fields supported:	`id, name, countitems`: sorting by id, collection name and item count
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 204: no content 400: bad request 500: internal server error }}
Response details

Name and description	Value and notes
Base URI:
Description:	Returns a list of all communities a collection with `id` belongs to
HTTP method:	`GET`
Optional parameters:
Sorting fields supported:	`id, name, countitems`: sorting by id, community name and item count
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 204: no content 400: bad request 500: internal server error }}
Response details

Name and description	Value and notes
Base URI:
Description:	Returns a list of all items from the collection `id`
HTTP method:	`GET`
Optional parameters:
Sorting fields supported:	`id, name, lastmodified, submitter`: sorting by id, name, lastmodified date and submitter of item
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 204: no content 400: bad request 500: internal server error }}
Response details

Content searching

...

Name and description	Value and notes
Base URI:
Description:	Returns a list of all objects found by searching criteria
HTTP method:	`GET`
Optional parameters:
Sorting fields supported:	`id, name, lastmodified, submitter`: sorting by id, name, last modifed date or submitter of item
Sorting/ordering modifiers:	`title, issueDate, author, subject, submitter`
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 204: no content 400: bad request 500: internal server error }}
Response details

Name and description	Value and notes
Base URI:
Description:	Returns a list of all objects that have been created, modified or withdrawn within specified time range
HTTP method:	`GET`
Optional parameters:
Sorting/ordering modifiers:	`id, name, lastmodified, submitter`: information on item returned
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 204: no content 400: bad request 500: internal server error }}
Response details

Item status/info and retrieval

...

Name and description	Value and notes
Base URI:	`/items/{id`}
Description:	Returns detailed information about an item
HTTP method:	`GET`
Required parameters:	{`id`}: item id
Sorting fields supported:	`id, name, lastmodified, submitter`: sorting by id, name, last modifed date or submitter of item
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 204: no content 400: bad request 500: internal server error }}
Response details	Contains an information about an item including resource name, metadata, owning collection, collections stored in, communities stored in, bundle ids, last modified date, archival/withdrawn status and submitter of an item

Name and description	Value and notes
Base URI:	`/items/{id}/permissions`
Description:	Returns status of user permissions on this item
HTTP method:	`GET`
Required parameters:	{`id`}: item id
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 400: bad request 500: internal server error }}
Response details	Boolean variable, stating can user edit the listed item

Name and description	Value and notes
Base URI:
Description:	Returns communities this item is part of
HTTP method:	`GET`
Required parameters:
Sorting fields supported:	`id, name, countitems`: community properties used for sorting
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 400: bad request 500: internal server error }}
Response details	Communities listed

Name and description	Value and notes
Base URI:
Description:	Returns collections this item is part of
HTTP method:	`GET`
Required parameters:
Sorting fields supported:	`id, name, countitems`: collection parameters
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 400: bad request 500: internal server error }}
Response details	Collections listed

Name and description	Value and notes
Base URI:	`/bitstream/{id`}
Description:	Returns bitstream object - usually the library item file
HTTP method:	`GET`
Required parameters:	{`id`}: bitstream item id
Response formats:	`json`, `xml` (not yet complete)
Status codes	{{ 200: OK 404: Not found 400: bad request 401: Unauthorized 403: Forbidden 500: internal server error }}
Response details	Includes all information about referenced bitstream, including file name, licence, corresponding ittem etc. It is possible only to get information for particular bitstreams. When the request is made without parameters/references, the blank list is presented (there is no list of all bitstreams in the system available).

Name and description	Value and notes
Base URI:	`/bitstream/{id}/receive`
Description:	Returns checksum of bitstream
HTTP method:	`GET`
Required parameters:	{`id`}: bitstreamitem id
Response formats:	`binary`
Status codes	{{ 200: OK 400: bad request 401: Unauthorized 403: Forbidden 500: internal server error }}
Response details	Receive full bitstream

...

Name and description	Value and notes
Base URI:
Description:	Returns list containing id, name and email of persons (optionally matching a query)
HTTP method:	`GET`
Optional parameters:
Sorting fields supported:	`id, name, lastname, fullname, language`: sorting properties of user(submitter) supported
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 204: no content 400: bad request 500: internal server error }}
Response details	List with information on particular user. Additionaly only identifiers are sent if idOnly is true.

...

Name and description	Value and notes
Base URI:	`/stats`
Description:	Returns general statistics
HTTP method:	`GET`
Response formats:	`json`, `xml`
Status codes	{{ 200: OK 400: bad request (if there is no stats package available) 500: internal server error }}
Response details	Returns cummulative list of statistics data for the system currently available

...

We have something more like

Panelcode
/resource/{id}/related?relation=ds:isPartOfCommunity&idOnly=false&immediateOnly=true

Rather than: /communities/{id}/children?idOnly=false&immediateOnly=tru

We have

Panelcode
/resource/{id}/related?relation=ds:hasCommunityPart&idOnly=false&immediateOnly=true

I think we need to make sure the REST interfaces clearly map to 2.0 Services and the actions that can be performed on them. So harvest, stats and users make sense to me. But, Community, Collection, Item and Bitstream do not and we should be consolidating these under some service path like "content/" or "resource/" or the like.

...

Creates a new relationship in the object. Adds the specified relationship to the object's RELS-EXT datastream. If the Resource Index is enabled, the relationship will be added to the Resource Index.

The DSpace + 2.0 proposed mapping to Fedora places RDF references for ds:hasCollection/ds:isPartOfCollection, ds:hasCommunity/ds:isPartOfCommunity directly into the RELS-EXT as relationships between Fedora representations of DSpace objects.

URL Syntax

Panelcode
/objects/{pid} ? [relationship] [object] [isLiteral] [datatype]

Parameters:

Panel
pid: The PID of the object. relationship: The predicate. object: The object. isLiteral: A boolean value indicating whether the object is a literal. datatype: The datatype of the literal. Optional.

...

Get next pid, /objects/nextPID ? [DSPACE:type]

Code Block

 /objects/nextPID?type="http://purl.org/dspace/model/Bitstream"

 /objects/\{bundlePid\}?relationship="http://purl.org/dspace/model/hasBitstream"&object=\{bitstreamPid\}

 /objects/\{bitstreamPid\} ? ... see [http://www.fedora-commons.org/documentation/3.0/userdocs/server/webservices/rest/index.html#addDatastream addDatastream]

(b) Creates metadata properties attached to any of the above DSpace Objects.

Panelcode
/objects/{pid} ? relationship=http://purl.org/elements/1.1/title&object="My Title"&isLiteral=true

addDatastream

URL Syntax

Panelcode
/objects/{pid}/datastreams/{dsID} ? [controlGroup] [dsLocation] [altIDs] [dsLabel] [versionable] [dsState] [formatURI] [checksumType] [checksum] [logMessage]

--Mark Diggory 15:58, 12 July 2009 (EDT)

...

Page tree

Versions Compared

Old Version 4

New Version Current

Key

Content searching

Item status/info and retrieval

addDatastream