Page History
...
Info | ||
---|---|---|
| ||
Note: You must set your request header's "Accept" property to either JSON (application/json) or XML (application/xml) depending on the format you prefer to work with. |
Example usage from command line in XML format with pretty printing:
curl -s -H "Accept: application/xml" http://localhost:8080/rest/communities | xmllint --format -
For this documentation, we will assume that the URL to the "REST" webapp will be http://localhost:8080/rest/ for production systems, this address will be slightly different, such as: http://demo.dspace.org/rest/. The path to an endpoint, will go after the /rest/, such as /rest/communities, all-together this is: http://localhost:8080/rest/communities
...
Property | stats |
---|---|
Example Value | true |
Informational Note | Boolean value indicates whether statistics should be recorded for access via the REST API; Defaults to 'false'. |
Property | max_pagination |
Example Value | 100 |
Informational Note | Integer value limiting the maximum number of items/collections/communities in a REST request return. Users can specify a lower limit in a REST call but not increase this number. |
Recording Proxy Access by Tools
...
The dspace-rest module is automatically configured to compile and build with DSpace 4.0, so a mvn+ant process will create the webapp. To make it work in your environment, you would just need to add a context entry for it in your servlet container. For example, in tomcat, one might alter tomcat$CATALINA_homeHOME/conf/server.xml and add:
Code Block | ||
---|---|---|
| ||
<Context path="/rest" docBase="/dspace/webapps/rest |
...
" |
...
/> |
Additional Information
Additional information can be found in the README for dspace-rest, and in the GitHub Pull Request for DSpace REST (Jersey).
...