EDINBURGH DATASHARE DSpace REST API
For a plain-English guide please see How to use the DataShare REST API .
Server path: https://datashare.ed.ac.uk/rest
Reports (GUI)
Index
- GET / - Return this page.
- GET /test - Return the string "REST api is running" for testing purposes.
Communities
- GET /communities - Return an array of all communities in DSpace.
- GET /communities/top-communities - Returns an array of all top-leve communities in DSpace.
- GET /communities/{communityId} - Returns a community with the specified ID.
- GET /communities/{communityId}/collections - Returns an array of collections of the specified community.
- GET /communities/{communityId}/communities - Returns an array of subcommunities of the specified community.
Collections
- GET /collections - Return all DSpace collections in array.
- GET /collections/{collectionId} - Return a collection with the specified ID.
- GET /collections/{collectionId}/items - Return all items of the specified collection.
Items
- GET /items - Return a list of items.
- GET /items/{item id} - Return the specified item.
- GET /items/{item id}/metadata - Return metadata of the specified item.
- GET /items/{item id}/bitstreams - Return bitstreams of the specified item.
Bitstreams
- GET /bitstreams - Return all bitstreams in DSpace.
- GET /bitstreams/{bitstream id} - Return the specified bitstream.
- GET /bitstreams/{bitstream id}/policy - Return policies of the specified bitstream.
- GET /bitstreams/{bitstream id}/retrieve - Return the contents of the specified bitstream.
Hierarchy
- GET /hierarchy - Return hierarchy of communities and collections in tree form. Each object is minimally populated (name, handle, id) for efficient retrieval.
Metadata and Schema Registry
- GET /registries/schema - Return the list of metadata schemas in the registry
- GET /registries/schema/{schema_prefix} - Returns the specified metadata schema
- GET /registries/schema/{schema_prefix}/metadata-fields/{element} - Returns the metadata field within a schema with an unqualified element name
- GET /registries/schema/{schema_prefix}/metadata-fields/{element}/{qualifier} - Returns the metadata field within a schema with a qualified element name
- GET /registries/metadata-fields/{field_id} - Return the specified metadata field
Query/Reporting Tools
- GET /reports - Return a list of report tools built on the rest api
- GET /reports/{nickname} - Return a redirect to a specific report
- GET /filters - Return a list of use case filters available for quality control reporting
- GET /filtered-collections - Return collections and item counts based on pre-defined filters
- GET /filtered-collections/{collection_id} - Return items and item counts for a collection based on pre-defined filters
- GET /filtered-items - Retrieve a set of items based on a metadata query and a set of filters