OAI PMH

Owned by Alexis Rombaut
Last updated: Dec 20, 2024
2 min read

From version 23.3 OAI-PMH is only available upon request

Introduction

  • OAI-PMH is an open standard designed for harvesting metadata

  • The full documentation can be found online

  • The complete API reference is also available

  • The OAI is from version 23.3 only available upon request.

OAI

Upon activation of the component you can access it using

https://<Your MediaHaven URL>/mediahaven-oai/oai

The Integration installation of MediaHaven always contains the latest release from MediaHaven

https://integration.mediahaven.com/mediahaven-oai/oai

Delete Support

From version 22.1 the engine now has delete support for OAI meaning

  • Logically deleted records are present in OAI responses

    • These records are marked with <header status="deleted"> as mandated by the OAI spec

  • When a record is logically deleted, the Administrative.LastModifiedDate changes and there will be a corresponding harvest for the corresponding date

Cookbook

List of metadata formats

See Metadata Formats for additional information.

Format

Description

Includes children from intellectual objects

https://mediahaven.atlassian.net/wiki/spaces/CS/pages/4486791184

Includes children from ensembles

Since

Format

Description

Includes children from intellectual objects

https://mediahaven.atlassian.net/wiki/spaces/CS/pages/4486791184

Includes children from ensembles

Since

oai_dc

A small subset of Dublin core made for OAI

 

 

 

mhs-head

The most recent Metadata Sidecar

 

 

 

mhs

The Metadata Sidecar 20.3

 

 

 

mets-mhs-head

METS format with as embedded metadata the most recent Metadata Sidecar

 

 

 

mets-mhs

METS format with as embedded metadata the Metadata Sidecar 20.3

 

 

 

mets

METS format with as embedded metadata the obsolete External Metadata

 

 

mets-mhs-tree

METS format with as embedded metadata the Metadata Sidecar 20.3 and the inclusion of children.

25.1

mets-mhs-tree-head

METS format with as embedded metadata the most recent Metadata Sidecar and the inclusion of children.

25.1

Selective harvesting

Select harvesting is the most useful feature of OAI-PMH, allowing for querying the API for recent changes and for keeping another platform in sync with changes. Open Archives Initiative - Protocol for Metadata Harvesting - v.2.0 describes in “Selective harvesting” how to achieve this.

Get metadata

Query Parameter

Description

Example

Query Parameter

Description

Example

format

The metadata format as described in the previous section

mhs-head

from

Return records that have been modified after this date (inclusive)

2020-07-05

until

Return records that have been modified before this date (inclusive)

2020-07-06

resumptionToken

Use this token to receive additional records matching between the time interval [from,until]. See OAI Reference for more details.

e21ldGFkYXRhUHJlZml4PW1ocy1oZW...

(base 64 string)

The parameters from and until are calculated against the metadata field Administrative.LastModifiedDate. See Metadata Fields for the complete reference.

Authentication

  • From version 23.2 the basic authentication is deprecated and strongly discouraged from use because of security reasons

  • The standard OAuth2.0 authentication must be used instead and is already available since at least 22.1

  • From version 25.1 the basic authentication support is removed