Metadata for Libraries and Aggregators

Metadata feeds

OAPEN enables libraries and aggregators to use the metadata of all available titles in the OAPEN Library. The metadata is available in the following formats:

OAI PMH harvesting

The base URL for OAI-PMH harvesting is https://library.oapen.org/oai/

(Example: https://library.oapen.org/oai/request?verb=ListMetadataFormats)

RSS and Atom feeds

All metadata feeds are available under a CC0 1.0 license.

Search the OAPEN Library using a REST API

Search syntax

You can search the OAPEN Library using a REST API, using the following syntax: https://library.oapen.org/rest/search?query=[search query]

Examples:

  • Full text query: “water AND fire” - https://library.oapen.org/rest/search?query=%22water%20AND%20fire%22
  • Query using dc.title: “The deliverance of open access books” - https://library.oapen.org/rest/search?query=dc.title:%22the%20deliverance%20of%20open%20access%20books%22

List all available metadata

To list all available metadata, use:

https://library.oapen.org/rest/search?query=[search query]&expand=metadata

Examples:

  • Full text query: “water AND fire” - https://library.oapen.org/rest/search?query=%22water%20AND%20fire%22&expand=metadata
  • Query using dc.title: “The deliverance of open access books” - https://library.oapen.org/rest/search?query=dc.title:%22the%20deliverance%20of%20open%20access%20books%22&expand=metadata

List all available bitstream objects

To list all available bitstream objects, use:

https://library.oapen.org/rest/search?query=[search query]&expand=bitstreams

Examples:

  • Full text query: “water AND fire” - https://library.oapen.org/rest/search?query=%22water%20AND%20fire%22&expand=bitstreams
  • Query using dc.title: “The deliverance of open access books” - https://library.oapen.org/rest/search?query=dc.title:%22the%20deliverance%20of%20open%20access%20books%22&expand=bitstreams

List all available metadata and bitstream objects

To list both metadata and bitstream objects at ones, use:

https://library.oapen.org/rest/search?query=[search query]&expand=metadata,bitstreams

Examples:

  • Full text query: “water AND fire” - https://library.oapen.org/rest/search?query=%22water%20AND%20fire%22&expand=metadata,bitstreams
  • Query using dc.title: “The deliverance of open access books” - https://library.oapen.org/rest/search?query=dc.title:%22the%20deliverance%20of%20open%20access%20books%22&expand=metadata,bitstreams

Selecting fields for your query

To find out which metadata field to use:

  • Select in the web UI an item that corresponds to a possible result of your query
  • Open its full view, using one of these options: Click the “Show full item record” link under the thumbnail or append ?show=full to the item’s URL
  • Select the metadata fields and their corresponding value.

For date fields, best to append the suffix “_dt” after the field’s name, e.g. dc.date.issued_dt if you want the filter to behave as a date and not as text.

Collections

If you want to expose collections, query the oapen.collection field (using the collection label, not an ID). The same expand options are available.

Example:

  • Find the collection “European Research Council” - https://library.oapen.org/rest/search?query=oapen.collection:%22European%20Research%20Council%22

Funders

Retrieving all publications by a funder can be achieved via the relationship metadata fields. To find the actual ID for a funder, search by funder name, using the grantor name field.

Example:

  • Find the funder “Austrian Science Fund (FWF)“ - https://library.oapen.org/rest/search?query=grantor.name:Austrian+Science+Fund+%28FWF%29&expand=metadata
  • The ID can be found with the <UUID> tag: <UUID>6c9e728b-5e84-472c-a792-21775da55aa0</UUID>

Expose the publications, by querying the oapen.relation.isFundedBy field

Example:

  • The ID of funder Austrian Science Fund is 6c9e728b-5e84-472c-a792-21775da55aa0 - https://library.oapen.org/rest/search?query=oapen.relation.isFundedBy:%226c9e728b-5e84-472c-a792-21775da55aa0%22

If needed, you can expand metadata, bitstreams or both.

Note that querying grantor.name also lists all publications funded by that funder - under the repeated “oapen.relation.funds” field – without the details. Therefore, use the above query to get all details at once instead of using one query per item to get their detailed metadata / files.

More information

You can find more information on the REST API in the Lyrasis wiki.