[Kitodo] REST-API

Mo Sep 30 17:44:57 CEST 2019

Hallo Herr Hartwig und Herr Hänger,

Über die Rest-Schnittstelle können Informationen zu verfügbaren Vorgängen (einschließlich ihrer Schritte), Projekten und der Katalogkonfiguration abgerufen werden. Diese Informationen werden verteilt über verschiedene XML-Dateien und die Datenbank gespeichert. Der direkte Zugriff auf diese Informationen von außen durch zusätzliche Skripte kann kompliziert sein. Daher stellt die Restschnittstelle diese Informationen für den Zugriff von außen mit den in Production integrierten Mitteln bereit.

Verwenden Sie die folgenden URLs, um auf diese Informationen zuzugreifen:

http://server.domain.example/kitodo-production/rest/catalogueConfiguration

» Gibt die konfigurierten Katalogschnittstellen und Dokumenttypen aus. Diese Informationen sind analog zu den in opac.xml konfigurierten Informationen.

http://server.domain.example/kitodo-production/rest/projects

» Gibt die konfigurierten Projekte mit entsprechenden Produktionsvorlagen mit verfügbaren Sammlungen, und Metadatenschlüsseln aus. Die Projekte und Produktionsvorlagen sind diejenigen, die auf dem System vorhanden sind. Die Sammlungen entsprechen der Konfiguration in der collections.xml-Datei, die Metadatenschlüssel entsprechen der Konfiguration in der projects.xml-Datei (wie für das betreffende Projekt konfiguriert).

http://server.domain.example/kitodo-production/rest/processes

» Listet alle Vorgänge auf dem System auf. Die Vorgänge sind diejenigen, die auf dem System vorhanden sind.

http://server.domain.example/kitodo-production/rest/processes/PPN/steps

» Zeigt alle Schritte des Vorgangs mit der angegebenen PPN an. Beachten Sie, dass die PPN der Wert im Feld PPN digital a-Satz bzw. PPN digital f-Satz sein muss, nicht der Vorgangstitel.

Die Rest-Schnittstelle ist schreibgeschützt. Es gibt keine Möglichkeit, das System über diese Schnittstelle zu verändern. Standardmäßig wird XML zurückgegeben, es kann jedoch auch JSON zurückgegeben werden, wenn der HTTP-Accept-Header auf application/json gesetzt ist.

Ich hoffe, dass diese Informationen Ihnen weiterhelfen.

Mit freundlichen Grüßen

Matthias Ronge

________________________________

Matthias Ronge
Software Entwicklung/Software Development

[cid:Z_Logo_RGB_180px_2b974e26-85b9-4005-92dd-9bb8df881ab3.png]<http://www.zeutschel.de> <http://www.zeutschel.de>

[cid:Twitter-34x34_f9819937-1c34-4eab-b2fc-944fcf2e8938.png]<https://twitter.com/zeutschelgmbh>

[cid:YouTube-34x34_8cf03759-cc15-472e-a763-e628ea59d43b.png]<http://www.youtube.com/user/zeutschelbookscanner>

[cid:Facebook-34x34_ab94d89a-875f-49f2-81f3-e136c66e4bb5.png]<https://www.facebook.com/pages/Zeutschel-GmbH/193873073980288?fref=ts><https://plus.google.com/110507211572689796815/posts>

Zeutschel GmbH | Heerweg 2 | 72070 Tübingen | Deutschland
p: +49 (7071) 9706-62 | m: | f: +49 (7071) 9706-44
e: Matthias.Ronge at zeutschel.de<mailto:Matthias.Ronge at zeutschel.de> | w: http://www.zeutschel.de
Geschäftsführer/President: Joerg Vogler | Registergericht Stuttgart: HRB 380917

[cid:Banner-OS-Q_63e91370-8268-4a12-aec9-f048b5a97237.png]<https://www.zeutschel.de/>

-----Ursprüngliche Nachricht-----
Von: kitodo-community-bounces at kitodo.org <kitodo-community-bounces at kitodo.org> Im Auftrag von Christian Haenger
Gesendet: Freitag, 20. September 2019 14:01
An: kitodo-community at kitodo.org
Betreff: Re: [Kitodo] REST-API

Hallo Herr Hartwig,

ich habe mir fast gedacht, dass die REST-API nur Lesezugriffe erlaubt.

Wir haben ja eine ähnliche Kitodo-Geschichte wie die ULB Halle und sind

2015 von Visual Library auf Kitodo (damals noch Goobi) umgestiegen.

Allerdings haben wir wegen der damals auch noch nicht vorhandenen Exportmöglichkeiten die Alt-VL-Metadaten nicht nach Production importiert, sondern greifen nur mit Presentation darauf zu. Bei einer erneuten Bearbeitung des "Altdatensatzen" muss dann eine erneute Aufnahme in Production erfolgen.

Letztlich ist es suboptimal, nicht mit einem System, also Production, zu arbeiten, sondern Workarounds zu schaffen. Aber manchmal geht es nicht anders.

Viele Grüße

Christian Hänger

Am 20.09.2019 um 13:39 schrieb Uwe Hartwig:

> Hallo Herr Hänger,

>

> das klingt spannend. Bei uns geht es darum, unsere Strukturierung bei

> der Arbeit so weit es geht zu unterstützen, was ggf. heißt,

> Arbeitsschritte nicht über die Kitodo.Production2 Oberfläche

> durchzuführen, sondern auf anderen Wegen.

>

> Aktuell erlaubt die REST-API allerdings durchgehend nur Lesezugriffe,

> wobei mir leider das dahinterliegende Modell noch nicht klar ist

> (process vs. prozesse vs. prozesseeigenschaften vs. vorlagen vs.

> vorlageneigenschaften vs. werkstuecke vs. werkstueckeeigenschaften).

>

>

> Grüße

>

>

> On 20.09.19 13:16, Christian Haenger wrote:

>> Hallo Herr Hartwig,

>>

>> eine vergleichbare Frage wollte ich auch gerade stellen.

>>

>> Mein Problem ist, dass die Scanabteilung mehr digitalisierte Werke

>> liefert als die Metadatenabteilung beschreiben kann. Daher denke ich

>> bei Werken aus dem 19. und 20. Jahrhundert über eine Automatisierung nach.

>> Wir digitalisieren in Mannheim Fortsetzungswerke, deren Aufbau über

>> mehrere Ausgaben hinweg immer gleich bleibt. Das sind z.B.

>> Hoppenstedt Handbuch der Aktiengesellschaften. Daher denke ich

>> darüber nach, die Inhaltsverzeichnisse zu scannen und die Inhalte

>> automatisiert nach XML-DC oder XML-MODS zu überführen. Denkbar wäre

>> dann ein Import über die REST-API nach Production. Anschließend

>> erfolgt dann die manuelle weitere Bearbeitung in Kitodo.

>>

>> Hat das jemand mal gemacht oder einen anderen Lösungsvorschlag?

>>

>> In Mannheim haben wir bereits Metadaten und Imgaes automatisiert

>> übernommen, aber nur für Presentation zur Verfügung gestellt. Zuletzt:

>>

>> Viele Grüße

>>

>> Christian Hänger

>>

>>

>> Am 20.09.2019 um 11:20 schrieb Uwe Hartwig:

>>> Liebe Community,

>>>

>>> für Kitodo.Production existiert eine REST-API, die in unveränderter

>>> Form auch in Version3 übernommen wurde.

>>> Nutzt jemand aktuell diese Schnittstelle?

>>> Wird diese gepflegt bzw. gibt es Ideen für deren Weiterentwicklung?

>>>

>>>

>>> Viele Grüße

>>>

--

Dr. Christian Hänger

Abteilungsleiter Digitale Bibliotheksdienste UB Mannheim

68131 Mannheim

0049 621 181 2954

_______________________________________________

Kitodo-Community mailing list

Kitodo-Community at kitodo.org<mailto:Kitodo-Community at kitodo.org>

https://maillist.slub-dresden.de/cgi-bin/mailman/listinfo/kitodo-community
-------------- nächster Teil --------------
Ein Dateianhang mit HTML-Daten wurde abgetrennt...
URL: <http://bibservices.biblio.etc.tu-bs.de/pipermail/kitodo/attachments/20190930/ec03600a/attachment-0001.html>
-------------- nächster Teil --------------
Ein Dateianhang mit Binärdaten wurde abgetrennt...
Dateiname   : Z_Logo_RGB_180px_2b974e26-85b9-4005-92dd-9bb8df881ab3.png
Dateityp    : image/png
Dateigröße  : 4047 bytes
Beschreibung: Z_Logo_RGB_180px_2b974e26-85b9-4005-92dd-9bb8df881ab3.png
URL         : <http://bibservices.biblio.etc.tu-bs.de/pipermail/kitodo/attachments/20190930/ec03600a/attachment-0005.png>
-------------- nächster Teil --------------
Ein Dateianhang mit Binärdaten wurde abgetrennt...
Dateiname   : Twitter-34x34_f9819937-1c34-4eab-b2fc-944fcf2e8938.png
Dateityp    : image/png
Dateigröße  : 4594 bytes
Beschreibung: Twitter-34x34_f9819937-1c34-4eab-b2fc-944fcf2e8938.png
URL         : <http://bibservices.biblio.etc.tu-bs.de/pipermail/kitodo/attachments/20190930/ec03600a/attachment-0006.png>
-------------- nächster Teil --------------
Ein Dateianhang mit Binärdaten wurde abgetrennt...
Dateiname   : YouTube-34x34_8cf03759-cc15-472e-a763-e628ea59d43b.png
Dateityp    : image/png
Dateigröße  : 4355 bytes
Beschreibung: YouTube-34x34_8cf03759-cc15-472e-a763-e628ea59d43b.png
URL         : <http://bibservices.biblio.etc.tu-bs.de/pipermail/kitodo/attachments/20190930/ec03600a/attachment-0007.png>
-------------- nächster Teil --------------
Ein Dateianhang mit Binärdaten wurde abgetrennt...
Dateiname   : Facebook-34x34_ab94d89a-875f-49f2-81f3-e136c66e4bb5.png
Dateityp    : image/png
Dateigröße  : 4533 bytes
Beschreibung: Facebook-34x34_ab94d89a-875f-49f2-81f3-e136c66e4bb5.png
URL         : <http://bibservices.biblio.etc.tu-bs.de/pipermail/kitodo/attachments/20190930/ec03600a/attachment-0008.png>
-------------- nächster Teil --------------
Ein Dateianhang mit Binärdaten wurde abgetrennt...
Dateiname   : Banner-OS-Q_63e91370-8268-4a12-aec9-f048b5a97237.png
Dateityp    : image/png
Dateigröße  : 38938 bytes
Beschreibung: Banner-OS-Q_63e91370-8268-4a12-aec9-f048b5a97237.png
URL         : <http://bibservices.biblio.etc.tu-bs.de/pipermail/kitodo/attachments/20190930/ec03600a/attachment-0009.png>
-------------- nächster Teil --------------
_______________________________________________
Kitodo-Community mailing list
Kitodo-Community at kitodo.org
https://maillist.slub-dresden.de/cgi-bin/mailman/listinfo/kitodo-community