DSpace REST API
Excerpt |
---|
This is a wiki page for DSpace REST API addon. The project is in development phase, but can be tested by the users. For the details please check this page. |
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
|
Details
Project Title: | DSpace REST API |
Author: | Bojan Suzic |
Mentors (at GSoC): | Aaron Zeckoski, Mark Diggory |
Contacting author: | bojan.suzic AT gmail _DOT _com - using subject line DSpace REST |
SCM Location for Project: |
Project description
The REST approach promotes simplification and decoupling of software architecture, enabling further scalability, portability, granularity and simplified interaction of software systems and components.
The aim of this project is to provide DSpace with REST capable API and underlying component, which will enable developers and end-users to exploit the advantages of such approach.
...
Based on REST API for DSpace the new GSoC (2011) project is started. Vibhaj Rajan DSpace UI Client based on JavaScript and appropriate framework (JQuery). More information: Client UI REST API
Important: During Q1-Q3 of 2012 thanks to Hayden Young and other contributors from Wijiti Pty Ltd a great effort has been invested to continue the development of REST API for DSpace. They reworked the code base, refreshed the project to be compatible with newest DSpace 1.8.1 version, fixed the bugs and provided the integration of DSpace, REST API and Joomla CMS. There are also other numerous improvements introduced. Their contribution can be reached via GitHub, including development site and documentation update.
Release plan and issues
It is expected to have working and tested code for DSpace 1.8 release. According to relevant discussions on DSpace developer meetings, there is possibility to have this code released asynchronously of DSpace, as independent module. After initial release the code will be actively maintained.
...
Earlier Implementation Description - GSoC09
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
| Returns a list of all communities on the system or return just top level communities. | - | The list of communities containing respective fields . |
| |||||||||
|
|
| Return detailed information about |
|
| - | Fields describing community. |
| |||||||
|
|
| Return a particular data field found in the community
element ): id - entity identifier, internal to the system name - entity name countItems - number of items under community handle - handle of the community (unique persistent resource identifier) type - entity type (object type in the system) collections - collections contained in the community, ordered by id canedit - states user persmission on the community (editing) anchestor - anchestors of the community children - subcommunities, ordered by id administrators - group administrators, ordered by id recent - recent items in the community shortDescription - short description copyrightText - copyright text sidebarText - sidebar text introductoryText - introductory text logo - community logo; to retrieve use returned id with /bistream/receive endpoint |
| Respective field info |
| |||||||||
|
|
| Return a list of all collections in the system. | - | The list of the collections containing respective fields. |
| |||||||||
|
|
| Return detailed information about |
| Fields of the collection entity. |
| |||||||||
|
|
| Return a particular data field found in the collection
element ): id - entity identifier, internal to the system name - collection name licence - collection licence items - items contained in collection handle - handle of the collection (unique persistent resource identifier) canedit - states user permission on the collection (edit) communities - communities collection is a part of countItems - number of the items in the collection type - entity type (object type in the system) shortDescription - short description of the collection introText - introductory text for the collection copyrightText - copyright text for the collection sidebarText - sidebar text for the collection provenance - provenance logo - information about collection's logo (to retrieve use logo id in /bitstream/receive endpoint) |
|
| Respective field info |
| ||||||||
|
|
| Return a list of the items in the system | - | - | The list of the items containing related fields . |
|
| |||||||
|
|
| Return detailed information about an item. |
|
| Fields of the item entity. |
| 200, 204, 400, 500 | |||||||
|
|
| Return a particular data field fould in the item
element ): metadata - item metadata submitter - submitter group isArchived - archival status of the item isWithdrawn - states if the item is withdrawn owningCollection - owning collection of the item lastModified - last modified time collections - collections the item appears in communities - communities the item appears is name - name of the item bitstreams - bitstreams related to the item handle - item handle (unique identified) canedit - states can user edit the item id - item id type - element type bundles - bundles related to the item |
| - | Respective field info |
| 200, 204, 400, 500 | |||||||
|
|
| Return bitstream object - usually the library item file. |
| - | - | Fields of the bitstream entity. |
| 200, 400, 401, 403, 404, 500 | ||||||
|
|
| Return a particular data field found in bitstream
Supported fields (for element ): mimeType - mime type of file bundles - bundles the bitstream is a part of checkSum - checksum of the file checkSumAlgorithm - checksum algorithm used description - bitstream description formatDescription - file format description sequenceId - sequence id of the file size - size of the file source - source (typically filename with path information) storeNumber - asset store number where the bitstream is stored userFormatDescription - user's format description name - bitstream name handle - unique id of the bitstream id - internal id of the bitstream type - type of the entity (referring to bitstream) Note: bitstream can be not only the content of the item (like book pdf file etc), but also licence file or logo of community |
| - | Respective field info |
| 200, 400, 401, 403, 404, 500 | |||||||
|
|
| Return bitstream |
| - | - | Return bitstream |
| 200, 400, 401, 403, 404, 500 | ||||||
|
|
| Return a list of the groups in the system | - | - | The list of the groups containing related fields . |
| 200, 204, 400, 500 | |||||||
|
|
| Return a group object |
| - | Fields of the group entity. |
| 200, 204, 400, 500 | |||||||
|
|
| Return a particular data field found in the group entity
Supported fields (for element ): handle - unique id (external) id - internal id of the gruop isEmpty - is the group empty members - group members (as users) memberGroups - group members (as groups) name - group name type - entity type (referring to group) |
| - | Respective field info |
| 200, 204, 400, 500 | |||||||
|
|
| Return a list of the users in the system | - | - | The list of the users containing related fields . |
| 200,204,400,500 | |||||||
|
|
| Return a user info |
| - | Fields of the user entity. |
| 200,204,400,500 | |||||||
|
|
| Return a particular data field found in the user
Supported fields (for element ): email - user's email firstName - first name fullName - full name handle - handle (unique, external) id - internal id of the user language - preferred language lastName - last name name - name netId - network id requireCertificate - requires certificate to login selfRegistered - is user self registered type - type of the object |
| - | Respective field info |
| 200,204,400,500 |
Note: modifier idOnly
is referred only to first layer of the results. For all other layers (e.g. nested results) only ids are returned in some cases, due to possible loops. Example: for community containing collections, on second level the response contains only ids for some elements where multiple loops may be created (community->has_collection->has_community....). Other data is modified according to idOnly
flag.
Optional parameters
Parameter | Description | ||||||
---|---|---|---|---|---|---|---|
topLevelOnly | returns only top level communities | ||||||
idOnly | if true return only the identifiers for the record | ||||||
immediateOnly | return only direct parent community | ||||||
isAuthorized | return only collections user has permission to work on | ||||||
inArchive | return archived items for respective collection | ||||||
detail | parameters: |
Sorting fields:
Info | ||
---|---|---|
| ||
The sorting of the fields / output results is currently partially supported. This part of the application is implemented independently of the endpoints and will be worked on after the most of endpoints are completed. |
Parameter | Description | Ordering supported | ||||||
---|---|---|---|---|---|---|---|---|
id | sort results by entity id |
| ||||||
name | sort results by entity name |
| ||||||
countitems | sort results by number of items contained |
| ||||||
lastmodified | sort results by date of last item modification |
| ||||||
submitterName | sort results by submitter name |
| ||||||
submitterId | sort results by submitter id |
|
Controlling results
Parameter | Description | Default | Example |
---|---|---|---|
| position of the first entity to return | 0 (first) |
|
| page of data to display | 0 (first) |
|
| number of results to show on each page | 0 (all) |
|
| maximum number of entities to return | 0 (all) |
|
|
| the sort order to return entities in |
|
...
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Response Data | Formats | Response codes |
---|---|---|---|---|---|---|---|---|
|
|
| Action to be done under community |
| - |
|
| 200, 400, 401, 403, 500 |
|
| /communities/{id}/{element} | Update the field |
| - | Response code |
| 200, 400, 401, 403, 500 |
|
|
| Set the logo for community |
| - | Response code | binary | 200, 400, 401, 403, 500 |
|
|
| Delete community from the system |
| - | Response code | | 200, 400, 401, 403, 500 |
|
|
| Remove attribute/value |
| - | Response code |
|
|
|
|
| Action to be done under collection |
| - | Id ow newly created element |
| 200, 400, 401, 403, 500 |
|
|
| Update field |
| - | Response code |
| 200, 400, 401, 403, 500 |
|
|
| Delete collection from the system - CANNOT BE DONE DIRECTLY | - | - | Response code |
| 200, 400, 401, 403, 500 |
|
|
| Remove attribute/value |
|
| Response code |
| 200,400,401,403,500 |
• |
|
| Set the logo for collection |
|
| Response code | binary | 200,400,401,403,500 |
• |
|
| Action to be done under item |
|
| Id of newly created element |
| 200,400,401,403,500 |
• |
|
| Update field |
| - | Response code |
| 200,400,401,403,500 |
• |
|
| Delete item from the system |
| - | Response code |
| 200,400,401,403,500 |
• |
|
| Delete element/attribute |
| - | Response code |
| 200,400,401,403,500 |
Content searching
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
---|---|---|---|---|---|---|---|---|---|
|
|
| Return a list of all objects found by searching criteria. | - | modifiers{{query= |
| Item info with basic metadata for the search results. Additionally return only |
| 200, 204, 400, 500 |
|
|
| Return a list of all objects that have been created, modified or withdrawn within specified time range. | - |
| - | Contains item info including id, name, handle, metadata, bitstreams according to |
| 200, 204, 400, 500 |
Statistical info
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
---|---|---|---|---|---|---|---|---|---|
|
|
| Return general statistics. | - | - | - | Cummulative list of statistics data for the system currently available. |
| 200, 400, 500 |
...
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
---|---|---|---|---|---|---|---|---|---|
• | GET | /resource/{handle}/relations | Return entities according to relation and parameters specified |
|
| - | ontains entities selected and sorted in conformance to request parameters. For more details see description of |
|
...
Parameter | Description | Values | Example | ||||||
---|---|---|---|---|---|---|---|---|---|
property | Return entities satisfying requested property relation | Structural properties |
| ||||||
rtype | restriction on type - only entity with specifed type(s) would be returned |
|
| ||||||
| restriction on fields - return only selected fields; by default all fields are returned | id | rfield=id,name - return only entity id and name in response |
...
It is planned to consult two external subjects for cooperation and the assistance during integration process (LMS and national library internal automation process). More information coming soon - awaiting approval of other parties.
Documentation tasks
Although provided software module exposes basic documentation automatically to the end user, in order to make it easier for other developers and users the documentation in the following forms is additionaly to be provided:
...
Panel | ||
---|---|---|
Update: Current version includes this update (thanks Peter!). This explanation will be shortly removed. Note: The code for the REST API from the Google Summer of Code 2010 may be out of date with the latest version of dspace. It may help to import the latest stable version of DSpace through the REST-API pom. To do so, modify [dspace-rest-api-source]/pom.xml
|
...
Modify [dspace-source]/dspace/pom.xml by adding the path to the checked out rest code.
Code Block |
---|
--- a/dspace/pom.xml
+++ b/dspace/pom.xml
@@ -505,6 +505,7 @@
-->
<modules>
<module>modules</module>
+ <module>../../../dspace-rest-gsoc10</module>
</modules>
<build>
|
Once you rebuild your dspace-src code with mvn package and ant update, you will additionally need to copy the compiled .war file produced in the dspace-rest-gsoc10 target directory to tomcat's webapps directory.
Code Block |
---|
cp /path/to/dspace-rest-gsoc10/target/dspace.war /var/lib/tomcat6/webapps/rest.war
|
...
6) Add a <profile> to dspace-src/dspace/modules/pom.xml.
7) Rebuild your project.
Possible problems:
- If you have trouble starting the application, check the dspace-config
variable and make sure it points to the location of the dspace.cfg
file. Use absolute addressing (see comment in src/main/webapp/WEB-INF/web.xml).
...