All Versions


DSpace Documentation


Page tree

Current Release

This documentation covers the latest release of DSpace, version 6.x. Looking for another version? See all documentation.

Skip to end of metadata
Go to start of metadata

GET /rest - Summary of API Calls

The response from this call includes the set of REST report calls that are available.

  • 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

 

GET /rest/reports - List of Available Reports

The response from this call includes the set of reports that are available

  • collection: /rest/static/index.html
  • item-query: /rest/static/query.html

GET /rest/reports/[report name] - Redirect to a Specific Report

This will re-direct to the configured report

GET /rest/filters - Return filters to apply to a list of items

The response will return the list of available filters. These have been configured in rest.cfg.

 

GET /rest/filtered-collections - Return collections and item counts based on pre-defined filters

This request is similar to the call /rest/collections except that it allows the user to supply a comma separated list of filters to apply to the collection.

The response will contain

  • The total count of items for each collection
  • The count of items that match each filter 
  • The count of items that match all filters combined


GET /rest/filtered-collections/{collection_id} - Return items and item counts for a collection based on pre-defined filters

This request is similar to the call /rest/collections/{collection_id} except that it allows the user to supply a comma separated list of filters to apply to the collection.

The response will contain

  • The total count of items for the collection
  • The count of items that match each filter 
  • The count of items that match all filters combined

When combined with the expand=items parameter, this call will return the set of items that match a filter or set of filters.  It may be necessary to paginate through these results.

GET /rest/filtered-items - Retrieve a set of items based on a metadata query and a set of filters

This request allows a collection owner to construct a complex metadata query against specific metadata fields applying a number of comparison operators.

The search features of DSpace allow an end user to discover items via search.  This command allows the collection owner to audit and enforce metadata consistency within a collection.

The query will consist of the following components

  • Metadata Field Query
    • Field(s) to be searched
    • Search operator
    • Search value (if applicable)
  • Collection scope (optional)
    • Comma separated list of collections to search
  • Filters
    • A comma separated list of item filters that will be applied to all results.
    • It may be necessary to paginate through results when applying a highly selective filter

 

  • No labels