5. REST-Schnittstelle

In PubMan steht die Schnittstellen „REST“ zur Verfügung.

5.1 Daten-Export über die REST-Schnittstelle durchführen

Die REST-Schnittstelle ermöglicht das Einbinden von PubMan-Daten in ein externes System, zum Beispiel eine Homepage. Um Datensätze aus PubMan zu exportieren, gehen Sie folgendermaßen vor:

  • Führen Sie eine Suchabfrage in der detaillierten Suche durch. Nähere Informationen dazu entnehmen Sie Abschnitt 3.2.
  • Übernehmen Sie die Suchabfrage in die REST-Schnittstelle. Weitere Informationen finden Sie im Abschnitt 3.24.
  • Legen Sie im Abschnitt „Sortierung“ weitere Einstellungen für die Datenausgabe fest. Im Feld „Sortierschlüssel“ können Sie mit Hilfe eines Sortierschlüssels die Sortierung der Trefferliste bestimmen. Die Liste mit den Sortierschlüsseln befindet sich oberhalb des Feldes. Hier ist es auch möglich, innerhalb eines Kriteriums nach einem weiteren Kriterium zu sortieren. Nähere Hinweise finden Sie im Abschnitt 5.4.
  • Wählen Sie im Feld „Sortierreihenfolge“ aus, ob die Sortierung aufsteigend (ascending) oder absteigend (descending) sein soll.
  • Legen Sie im Abschnitt „Ergebnisumfang“ fest, welche Datensätze der kompletten Ergebnisliste angezeigt werden sollen. Diese Funktion ist vor allem relevant, wenn nur ein bestimmter Ausschnitt einer sehr umfangreichen Ergebnisliste angezeigt werden soll. Die Datensätze werden dazu auf der Trefferliste durchnummeriert. Geben Sie jeweils die Nummer des ersten und des letzten Datensatzes ein. Die Datensätze dazwischen werden angezeigt.
  • Legen Sie im Abschnitt „Export Optionen“ das Export- und Ausgabe-Format fest. Bei Export-Formaten mit Zitation erscheint ein weiteres Feld, in dem Sie das Ausgabe-Format auswählen.
  • Sie können die Ergebnisse im gewählten Export-Format mit dem Button „Exportdatei herunterladen“ speichern. Oder den „Curl Befehl herunterladen“.

  • Es kann ein Link für ein Such Feed im ATOM-Format abgefragt werden. Rufen Sie dafür den Link von „Atom, version 1.0“ ab.

5.2 Nach mehreren Kriterien sortieren

Über die REST-Schnittstelle kann mit Hilfe der Sortierschlüssel auf mehreren Ebenen, „geschachtelt“ sortiert werden.

Gehen Sie folgendermaßen vor:

  • Führen Sie in der Detailsuche eine Suche nach einem bestimmten Institut durch.
  • Geben Sie dazu den Namen des Instituts in das Feld „Organisation“ ein. Nach der Eingabe dreier Buchstaben erscheint eine Autosuggest-Liste. Wählen Sie den Namen der Organisation aus der Autosuggest-Liste aus.
  • Lösen Sie die Suche aus, in dem Sie auf die Schaltfläche „Suche starten“ rechts unten klicken. Weitere Informationen zur Suche entnehmen Sie Abschnitt 3. Die Trefferliste erscheint.
  • Übernehmen Sie die Abfrage in die REST-Schnittstelle, in dem Sie auf die Schaltfläche „In die REST-Schnittstelle übernehmen“ klicken. Diese Schaltfläche befindet sich über den angezeigten Treffern.
  • Einzelne Sortierschlüssel können im Formular zur Erstellung der Curl-Befehle, bzw. von Downloads direkt eingetragen werden in das entsprechende Feld.
    Um eine Sortierung auf erster Ebene alphabetisch aufsteigend nach dem Titel zu bekommen, geben Sie in der REST-Schnittstellenmaske den entsprechenden Sortierschlüssel mit folgender Syntax in die Eingabezeile „Sortierschlüssel“ eingegeben: metadata.title.keyword.

    Hinweis für die Nutzer des Max-Planck-Repositories: Die Liste der zur Verfügung stehenden Zitierstile finden Sie hier: INGe-REST Sortierschlüssel.

  • Für eine mehrstufige Sortierung laden Sie zuerst den „Curl Befehl“ herunter. Anschließend wird der Sortier-Befehl in einem Editor ergänzt. Der Sortier-Befehl kann wie folgt aussehen:
    "sort": [{"metadata.genre" : {"order" : "ASC"}},{"sort-metadata-creators-first" : {"order": "ASC"}},{"sort-metadata-dates-by-category" : {"order" : "ASC"}}]

  • Dieser wird in den Curl-Befehl vor "size" integriert. Fertig könnte ein Curl-Befehl wie folgt aussehen:
    curl -X POST "https://qa.pure.mpdl.mpg.de/rest/items/search?format=docx&citation=APA" -H 'Cache-Control: no-cache' -H 'Content-Type: application/json' -d '{"query" : {"bool":{"must":[{"term":{"publicState":{"value":"RELEASED","boost":1.0}}},{"term":{"versionState":{"value":"RELEASED","boost":1.0}}},{"bool":{"should":[{"term":{"metadata.creators.person.organizations.identifierPath":{"value":"ou_persistent25","boost":1.0}}},{"term":{"metadata.creators.organization.identifierPath":{"value":"ou_persistent25","boost":1.0}}}],"adjust_pure_negative":true,"boost":1.0}}],"adjust_pure_negative":true,"boost":1.0}},"sort" : [{"sort-metadata-creators-compound,,sort-metadata-dates-by-category" : {"order" : "ASC"}}]"size" : "50","from" : "0"}'

  • Mit diesem Befehl können Sie mit einem HTTP Request Werkzeug, wie zum Beispiel Postman, die Datensätze verwenden.

  • Zukünftig wird es möglich sein, über die Eingabemaske eine mehrstufige Sortierung vorzunehmen. Sollten Sie bis dahin eine mehrstufig sortierte Liste benötigen und diese nicht selbst erzeugen, hilft Ihnen das PubMan-Support-Team. Bitte senden Sie dafür den entsprechenden Curl-Befehl an den PubMan-Support-Team.

results matching ""

    No results matching ""