Skip to content
Snippets Groups Projects
Commit 87755856 authored by Stefan E. Funk's avatar Stefan E. Funk
Browse files

Merge branch 'develop' into 111-update-elasticsearch-client-version-to-7-9-3

parents 77ecf940 90d610ed
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
docs_dhrep/index.rst
+ 26
− 35
View file @ 87755856
......@@ -15,6 +15,8 @@ All objects stored in the DARIAH-DE Repository are indexed within and are delive
API Documentation
-----------------
DARIAH-DE Repository OAI-PMH base URL: https://repository.de.dariah.eu/1.0/oaipmh/oai
All requests are implemented to be consistent with the OAI-PMH `The Open Archives Initiative Protocol for Metadata Harvesting <https://www.openarchives.org/OAI/openarchivesprotocol.html>`_
Two metadata formats are provided for the DARIAH-DE Repository: The mandatory DC metadata format (*oai_dc*) and the enhanced DataCite format according to `OpenAIRE Guidelines for Data Archives <https://guidelines.openaire.eu/en/latest/data/index.html>`_ (*oai_datacite*).
......@@ -23,53 +25,42 @@ Two metadata formats are provided for the DARIAH-DE Repository: The mandatory DC
Query Examples
--------------
Get the OAI-PMH service's version:
<https://repository.de.dariah.eu/1.0/oaipmh/oai/version>
[Identify] Get basic information:
<https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=Identify>
[ListMetadataFormats] Get provided metadata formats:
<https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListMetadataFormats>
[ListSets] List all public TextGrid projects as OAI-POMH sets:
<https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListSets>
[ListRecords] Get all Edition records (*oai_dc*):
<https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListRecords&metadataPrefix=oai_dc>
[ListRecords] Get all Edition records (*oai_datacite*):
<https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListRecords&metadataPrefix=oai_datacite>
Get the OAI-PMH service's version: https://repository.de.dariah.eu/1.0/oaipmh/oai/version
[ListRecords] Get all Edition records of a set (*oai_dc*):
Identify
""""""""
<https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListRecords&set=hdl:21.11113/0000-000B-C8F2-2&metadataPrefix=oai_dc>
* Get basic information: https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=Identify
[ListIdentifiers] Get all Edition records (*oai_dc*):
ListMetadataFormats
"""""""""""""""""""
<https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListIdentifiers&metadataPrefix=oai_dc>
* Get provided metadata formats: https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListMetadataFormats
[ListIdentifiers] Get all Edition record identifiers (*oai_datacite*):
ListSets
""""""""
<https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListIdentifiers&metadataPrefix=oai_datacite>
* List all DARIAH-DE Repository collections as OAI-POMH sets: https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListSets
[ListIdentifiers] Get all Edition record identifiers of a set (*oai_datacite*):
ListRecords
"""""""""""
<https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListIdentifiers&set=hdl:21.11113/0000-000B-C8F2-2&metadataPrefix=oai_dc>
* Get all records (*oai_dc*): https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListRecords&metadataPrefix=oai_dc
* Get all records (*oai_datacite*): https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListRecords&metadataPrefix=oai_datacite
* Get all records of a set (*oai_dc*): https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListRecords&set=hdl:21.11113/0000-000B-C8F2-2&metadataPrefix=oai_dc
[GetRecord] Get a single Edition record (*oai_dc):
ListIdentifiers
"""""""""""""""
<https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=GetRecord&identifier=hdl:21.11113/0000-000B-C9ED-8&metadataPrefix=oai_dc>
* Get all record identifiers (*oai_dc*): https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListIdentifiers&metadataPrefix=oai_dc
* Get all record identifiers (*oai_datacite*): https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListIdentifiers&metadataPrefix=oai_datacite
* Get all record identifiers of a set (*oai_datacite*): https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=ListIdentifiers&set=hdl:21.11113/0000-000B-C8F2-2&metadataPrefix=oai_dc
[GetRecord] Get a single Edition record (*oai_datacite):
GetRecord
"""""""""
<https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=GetRecord&identifier=hdl:21.11113/0000-000B-C9ED-8&metadataPrefix=oai_datacite>
* Get a single record (*oai_dc): https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=GetRecord&identifier=hdl:21.11113/0000-000B-C9ED-8&metadataPrefix=oai_dc
* Get a single Edition record (*oai_datacite): https://repository.de.dariah.eu/1.0/oaipmh/oai?verb=GetRecord&identifier=hdl:21.11113/0000-000B-C9ED-8&metadataPrefix=oai_datacite
Sources
......
docs_tgrep/index.rst
+ 28
− 39
View file @ 87755856
......@@ -6,14 +6,16 @@
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 <https://search.de.dariah.eu>`_ can index all the data that is entered into the `DARIAH-DE Collection Registry <https://colreg.de.dariah.eu>`_.
The TextGrid OAI-PMH Service is the service to harvest all metadata from the editions stored in the TextGrid Repository (public editions only). For example the `DARIAH-DE Generic Search <https://search.de.dariah.eu>`_ can index all the data that is entered into the `DARIAH-DE Collection Registry <https://colreg.de.dariah.eu>`_.
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 <https://textgridlab.org/doc/services/submodules/aggregator/docs/index.html>`_.
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 <https://textgridlab.org/doc/services/submodules/aggregator/docs/index.html>`_.
API Documentation
-----------------
TextGrid Repository OAI-PMH base URL: https://textgridlab.org/1.0/tgoaipmh/oai
All requests are implemented to be consistent with the OAI-PMH `The Open Archives Initiative Protocol for Metadata Harvesting <https://www.openarchives.org/OAI/openarchivesprotocol.html>`_
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 <https://guidelines.openaire.eu/en/latest/data/index.html>`_ (*oai_datacite*).
......@@ -22,53 +24,40 @@ Two metadata formats are provided for the TextGrid Repository: The mandatory DC
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>
Get the OAI-PMH service's version: https://textgridlab.org/1.0/tgoaipmh/oai/version
[ListIdentifiers] Get all Edition records (*oai_dc*):
Identify
""""""""
<https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListIdentifiers&metadataPrefix=oai_dc>
* Get basic information: https://textgridlab.org/1.0/tgoaipmh/oai?verb=Identify
[ListIdentifiers] Get all Edition record identifiers (*oai_datacite*):
ListMetadataFormats
"""""""""""""""""""
* Get provided metadata formats: https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListMetadataFormats
<https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListIdentifiers&metadataPrefix=oai_datacite>
ListSets
""""""""
* List all public TextGrid projects as OAI-POMH sets: https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListSets
[ListIdentifiers] Get all Edition record identifiers of a set (*oai_datacite*):
ListRecords
"""""""""""
<https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListIdentifiers&set=project:TGPR-8b44ca41-6fa1-9b49-67b7-6374d97e29eb&metadataPrefix=oai_dc>
* Get all Edition records (*oai_dc*): https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListRecords&metadataPrefix=oai_dc
* Get all Edition records (*oai_datacite*): https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListRecords&metadataPrefix=oai_datacite
* 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
[GetRecord] Get a single Edition record (*oai_dc):
ListIdentifiers
"""""""""""""""
<https://textgridlab.org/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:40wr9.0&metadataPrefix=oai_dc>
* Get all Edition records (*oai_dc*): https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListIdentifiers&metadataPrefix=oai_dc
* Get all Edition record identifiers (*oai_datacite*):https://textgridlab.org/1.0/tgoaipmh/oai?verb=ListIdentifiers&metadataPrefix=oai_datacite
* 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_datacite):
GetRecord
"""""""""
<https://textgridlab.org/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:40wr9.0&metadataPrefix=oai_datacite>
* Get a single Edition record (*oai_dc*): https://textgridlab.org/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:40wr9.0&metadataPrefix=oai_dc
* Get a single Edition record (*oai_datacite*): https://textgridlab.org/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:40wr9.0&metadataPrefix=oai_datacite
Sources
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment