Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Standardize underscores in REST API paths (driving me crazy!)

...

HTTP methodREST endpointDescription
GET/bitstreams

Return an array of all the bitstreams in the repository. The results are paginated.

Example:

http://demo.dspace.org/rest/bitstreams

GET/bitstreams/{bitstream id}Return the specified bitstream.
GET/bitstreams/{bitstream id}/policyReturn bitstream policies.
GET/bitstreams/{bitstream id}/retrieveReturn data of bitstream.
POST/bitstreams/{bitstream id}/policyAdd policy to item. You must post a resourcepolicy object data type.
PUT/bitstreams/{bitstream id}/dataUpdate the data/file of the specified bitstream. You must put the data.
PUT/bitstreams/{bitstream id}Update metadata of the specified bitstream. You must put a Bitstream, does not alter the file/data.
DELETE/bitstreams/{bitstream id}Delete the specified bitstream.
DELETE/bitstreams/{bitstream id}/policy/{policy _ id}Delete the specified resource policy of the specified bitstream.

...

HTTP methodREST endpointDescription
GET/registries/schemaReturn an array of all the schema in the registry
GET/registries/schema/{schema prefix}Return the specified schema
GET/registries/schema/{schema prefix}/metadata-fields/{element}Return the metadata field within a schema with an unqualified element name
GET/registries/schema/{schema prefix}/metadata-fields/{element}/{qualifier}Return the metadata field within a schema with a qualified element name
POST/registries/schema/Add a schema to the schema registry
POST/registries/schema/{schema _ prefix}/metadata-fieldsAdd a metadata field to the specified schema
GET/registries/metadata-fields/{field _ id}Return the specified metadata field
PUT/registries/metadata-fields/{field id}Update the specified metadata field
DELETE/registries/metadata-fields/{field id}Delete the specified metadata field from the metadata field registry
DELETE/registries/schema/{schema id}Delete the specified schema from the schema registry


Note: since the schema object contains no data fields, the following method has not been implemented:  PUT PUT /registries/schema/{schema _ id}

Report Tools

Reporting Tools that allow a repository manager to audit a collection for metadata consistency and bitstream consistency.  See REST Based Quality Control Reports for more information or test the Collection Report Tool or Metadata Query Tool on demo.dspace.org.

HTTP methodREST endpointDescription
GET/reportsReturn a list of report tools built on the rest api
GET/reports/{nickname}Return a redirect to a specific report
GET/filtersReturn a list of use case filters available for quality control reporting
GET/filtered-collectionsReturn 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-itemsRetrieve a set of items based on a metadata query and a set of filters

...