OAI-PMH

• 目的・用途

• OAI-PMHとは、データベース内のメタデータを様々な指定をして受け渡すことを可能とするプロトコルである。OAI-PMHを用いることによって様々なスキーマでメタデータの提供を可能としている。利用方法

OAI-PMHのリクエストURLは以下のようになる。以下の「値」と「verbのパラメータ」に任意の値を指定することで、メタデータを取得することができる。指定できる値については後述。

https://\[host\]/oai?verb=「値」&「verbのパラメータ」=「値」&「 verbのパラメータ」=「値」&...

• 機能内容

• Verbに指定できる値は、以下の6種類となる。

  • GetRecord
    リポジトリから個別のメタデータレコードを検索するためのverb。
    追加で指定するパラメータは次の2つになる。
    １．identifier：レコードの抽出元となるリポジトリのアイテムの固有識別子を指定する引数。必須項目。
    ２．metadataPrefix：返却レコードのメタデータ部に含まれるフォーマットを指定する引数。必須項目。

    • 以下に応答例を示す。

\

\yyyy-mm-ddThh:mm:ssZ\</responseDate>

\https://\[host\]/oai\</request>

\

\

\

\○○○○\</identifier>

\yyyy-mm-ddThh:mm:ssZ\</datestamp>

\○○○○\</setSpec>

\</header>

\

\<指定したアイテムのメタデータがここに記載される>

\</metadata>

\</record>

\</GetRecord>

\</OAI-PMH>

• Identify
  リポジトリについての情報を検索する際に使用するverb。
  追加で指定する引数はなし。

  • 以下に応答例を示す。

\

\yyyy-mm-ddThh:mm:ssZ\</responseDate>

\https://\[host\] /oai\</request>

\

\○○○○\</repositoryName>

\○○○○\</adminEmail>

\https://\[host\] /oai\</baseURL>

\2.0\</protocolVersion>

\ yyyy-mm-ddThh:mm:ssZ \</earliestDatestamp>

\transient\</deletedRecord>

\YYYY-MM-DDThh:mm:ssZ\</granularity>

\</Identify>

\</OAI-PMH>

• ListIdentifiers
  任意の引数を指定し、ヘッダの検索する際に使用するverb。
  追加で指定可能な引数は次の5つとなる。
  １．from：UTCdatetimeの任意の引数。日付による選択的ハーベスティングの下限を設定する。
  ２．until：UTCdatetimeの任意の引数。日付による選択的ハーベスティングの上限を設定する。
  ３．metadataPrefix：返却レコードのメタデータ部に含まれるフォーマットを指定する引数。必須項目。
  ４．set：Spec値を持つ任意の引数。選択的ハーベスティングを行う際のセットの基準を指定する。
  ５. resumptionToken：リポジトリが応答する際に不完全リストとセットになっている要素。この要素を指定して検索を行うことで完全リストの検索を可能とする任意の引数。

  • 以下に応答例を示す。

\

\YYYY-MM-DDThh:mm:ssZ\</responseDate>

\https://\[host\]/oai\</request>

\

\

\<指定したヘッダの情報>

\</header>

\</ListIdentifiers>

\</OAI-PMH>

• ListMetadataFormats
  リポジトリから入手可能なメタデータフォーマットを検索する際に使用するverb。
  指定可能な引数を以下に示す。
  identifier：アイテムに利用可能なメタデータフォーマットが要求されている場合に、そのアイテムの固有識別子を指定する任意の引数。

  • 以下に応答例を示す。

\

\YYYY-MM-DDThh:mm:ssZ\</responseDate>

\

\

\jpcoar\</metadataPrefix>

\https://github.com/JPCOAR/schema/blob/master/2.0/jpcoar\_scm.xsd\</schema>

\https://github.com/JPCOAR/schema/blob/master/2.0/\</metadataNamespace>

\</metadataFormat>

\

\jpcoar_1.0\</metadataPrefix>

\https://irdb.nii.ac.jp/schema/jpcoar/1.0/jpcoar\_scm.xsd\</schema>

\https://irdb.nii.ac.jp/schema/jpcoar/1.0/\</metadataNamespace>

\</metadataFormat>

\

\jpcoar_2.0\</metadataPrefix>

\https://irdb.nii.ac.jp/schema/jpcoar/2.0/jpcoar\_scm.xsd\</schema>

\https://irdb.nii.ac.jp/schema/jpcoar/2.0/\</metadataNamespace>

\</metadataFormat>

\

\oai_dc\</metadataPrefix>

\http://www.openarchives.org/OAI/2.0/oai\_dc/ http://www.openarchives.org/OAI/2.0/oai\_dc.xsd\</schema>

\http://www.w3.org/2001/XMLSchema\</metadataNamespace>

\</metadataFormat>

\

\ddi\</metadataPrefix>

\https://ddialliance.org/Specification/DDI-Codebook/2.5/XMLSchema/codebook.xsd\</schema>

\ddi:codebook:2_5\</metadataNamespace>

\</metadataFormat>

\

\jpcoar_v1\</metadataPrefix>

\https://github.com/JPCOAR/schema/blob/master/1.0/jpcoar\_scm.xsd\</schema>

\https://github.com//schema/blob/master/1.0/\</metadataNamespace>

\</metadataFormat>

\

\lom\</metadataPrefix>

\http://www.lido-schema.org http://www.lido-schema.org/schema/v1.0/lido-v1.0.xsd\</schema>

\http://ltsc.ieee.org/xsd/LOM\</metadataNamespace>

\</metadataFormat>

\</ListMetadataFormats>

\</OAI-PMH>

• ListRecord
  リポジトリからレコードを収集する際に使用するverb。
  追加で指定可能な引数は次の5つとなる。
  １．from：UTCdatetimeの任意の引数。日付による選択的ハーベスティングの下限を設定する。
  ２．until：UTCdatetimeの任意の引数。日付による選択的ハーベスティングの上限を設定する。
  ３．metadataPrefix：返却レコードのメタデータ部に含まれるフォーマットを指定する引数。必須項目。
  ４．set：Spec値を持つ任意の引数。選択的ハーベスティングを行う際のセットの基準を指定する。
  ５. resumptionToken：リポジトリが応答する際に不完全リストとセットになっている要素。この要素を指定して検索を行うことで完全リストの検索を可能とする任意の引数。

  • 以下に応答例を示す。

\

\YYYY-MM-DDThh:mm:ssZ\</responseDate>

\https://\[host\]/oai\</request>

\

\

\

\<指定したレコードの情報>

\</header>

\</record>

\</ListRecords>

\</OAI-PMH>

• ListSets
  リポジトリのセット構成を検索する際に使用するverb。
  使用可能となる引数は次のものである。
  resumptionToken：リポジトリが応答する際に不完全リストとセットになっている要素。この要素を指定して検索を行うことで完全リストの検索を可能とする任意の引数。

  • 以下に応答例を示す。

\

\YYYY-MM-DDThh:mm:ssZ\</responseDate>

\https://\[host\]/oai\</request>

\

\

\<セット構成の情報>

\</ListSets>

\</OAI-PMH>

\</OAI-PMH>\</OAI-PMH>

• リクエストに不備がある場合は以下のエラーのいずれかがOAI-PMH出力の本文内に記載される。

  • badArgument：不正な引数があるか、必須となる引数がない場合。

  • cannotDisseminateFormat：metadataPrefixの値がidentifierにより指定されたアイテムでサポートされていない場合。

  • idDoesNotExist：リポジトリでidentiferの値が不明であるか、不正なものである場合。

  • badResumptionToken：resumptionTokenの値が無効であるか期限切れである場合。

  • noRecordsMatch：from、until、setの値を組み合わせると空のリストになる場合。

  • noSetHierarchy：リポジトリがセットをサポートしていない場合。

  • noMetadataFormats：指定したアイテムで利用可能なメタデータフォーマットではない場合。

• 関連モジュール

• Invenio_oaiserver

• 更新履歴