Skip to content
Snippets Groups Projects
index.rst 3.69 KiB

TextGrid OAI-PMH

The TextGrid OAI-PMH Service is the service to harvest all metadata from the collections stored in the TextGrid Repository (public objects only). For example the DARIAH-DE Generic Search can index all the data that is entered into the DARIAH-DE Collection Registry.

The TextGrid OAI-PMH Service is delivering all public projects as OAI-PMH sets (no objects from the sandbox at the moment), and all Edition objects within the projects. You can get to the project's data by using the TextGrid Search service, please see TG-search <https://textgridlab.org/doc/services/submodules/tg-search/docs/index.html> `_, or the `TextGrid Aggregator.

API Documentation

All requests are implemented to be consistent with the OAI-PMH The Open Archives Initiative Protocol for Metadata Harvesting

Two metadata formats are provided for the TextGrid Repository: The mandatory DC metadata format (oai_dc) and the enhanced DataCite format according to OpenAIRE Guidelines for Data Archives (oai_datacite).

Query Examples

Get the OAI-PMH service's version:

<https://textgridlab.org/1.0/tgoaipmh/oai/version>

[Identify] Get basic information:

<https://textgridlab.org/1.0/tgoaipmh/oai?verb=Identify>

[ListMetadataFormats] Get provided metadata formats:

<https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListMetadataFormats>

[ListSets] List all public TextGrid projects as OAI-POMH sets:

<https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListSets>

[ListRecords] Get all Edition records (oai_dc):

<https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListRecords&metadataPrefix=oai_dc>

[ListRecords] Get all Edition records (oai_datacite):

<https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListRecords&metadataPrefix=oai_datacite>

[ListRecords] Get all Edition records of a set (oai_dc):

<https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListRecords&set=project:TGPR-8b44ca41-6fa1-9b49-67b7-6374d97e29eb&metadataPrefix=oai_dc>

[ListIdentifiers] Get all Edition records (oai_dc):

<https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListIdentifiers&metadataPrefix=oai_dc>

[ListIdentifiers] Get all Edition record identifiers (oai_datacite):

<https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListIdentifiers&metadataPrefix=oai_datacite>

[ListIdentifiers] Get all Edition record identifiers of a set (oai_datacite):

<https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListIdentifiers&set=project:TGPR-8b44ca41-6fa1-9b49-67b7-6374d97e29eb&metadataPrefix=oai_dc>

[GetRecord] Get a single Edition record (*oai_dc):

<https://textgridlab.org/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:40wr9.0&metadataPrefix=oai_dc>

[GetRecord] Get a single Edition record (*oai_datacite):

<https://textgridlab.org/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:40wr9.0&metadataPrefix=oai_datacite>

Sources

See oaipmh_sources

Bugtracking

See oaipmh_bugtracking

License

See LICENCE