API Manual
Bei der API zur Nutzung der Datenbank handelt es sich um die ediarum.WEB API
Weitere Informationen zur API von ediaraum finden sie hier.
Grundlegendes
Mit dem Befehl api? wird die appconfig angezeigt, in der alle PArameter aufgeführt sind, welche im Projekt genutzt wurden
Dadurch können sie direkt in der URL https://db.kolophone.de/exist/apps/workshop.web/api? sich alles ausgeben lassen
Sie liefert maschinenlesbare Daten (JSON) zu Objekt- und Relationstypen der Edition.
Objekte und Objektabfragen
Zur Abfrage von Objekten sind alle Endpunkte relativ zu dieser URL: https://db.kolophone.de/exist/apps/workshop.web/api/Objekt-ID
| Objekt | Beschreibung | Objekt-ID |
|---|---|---|
| Manuskripte | TEI-Dokumente mit Handschriften | obj-manuskripte |
| Kolophone | Einzelne Kolophone innerhalb von Handschriften | obj-kolophone |
| Personen | Personen aus dem Register | obj-personen |
| Orte | Orte aus dem Register | obj-orte |
| Werke | Werke aus dem Register | obj-werke |
Wenn man sich also eine Liste aller Manuskripte ausgeben lassen möchte, so kann man einfach mit
https://db.kolophone.de/exist/apps/workshop.web/api/obj-manuskripte sich eine Liste aller
Manuskripte ausgeben lassen, die die id, label und type enthält
Eine Einzelanischt der Objekte ist auch möglich. Dafür muss hinter dem Objekt die ID des Objekts hinzugefügt werden z.B api/obj-manuskripte/Objekt-ID
Filter für:
Manuskripte
Wenn sie nun also nach bestimmten Aspekten Filtern möchten, verknüpfen sie die Objekt-ID mit einem "?" und mit der Filter-ID: z.B. https://db.kolophone.de/exist/apps/workshop.web/api/obj-manuskripte?fil-ms-repo:Augsburg
Die genaue Angaben aller filterbaren Kategorien finden sie unter api?
| Bezeichnung | Filter-ID |
|---|---|
| Aufbewahrungsort | fil-ms-repo |
| Faksimile vorhanden | fil-ms-facs |
| Typisierung der Handschrift | fil-ms-class |
| Anzahl Kolophone | fil-ms-kol-count |
Kolophone
Ähnlich verhält es sich bei den Kolophonen. Wenn sie nun also die Kolophone nach der Semantik "pragmatisch" Filtern möchten, verknüpfen sie die Objekt-ID wiedermit einem "?" und mit der Filter-ID: z.B. https://db.kolophone.de/exist/apps/workshop.web/api/obj-kolophone?fil-kol-semantik:pragmatic
Die genaue Angaben aller filterbaren Kategorien finden unter api?
| Bezeichnung | Filter-ID |
|---|---|
| Semantik Kolophon | fil-kol-semantik |
| Typisierung Handschrift | fil-kol-type |
| Geschlechtermarkierung Schreibinstanz | fil-kol-geschlecht |
| Namensnennung Schreibinstanz | fil-kol-namensnennung |
| Gestaltung Kolophon | fil-kol-design |
| Text vor Kolophon | fil-kol-relatedWorks |
| Illustration/Miniatur in der Nähe des Kolophons | fil-kol-illustration |
| Sigle | fil-kol-manuscripts |
| Faksimile vorhanden | fil-kol-facs |
| Aufbewahrungsort | fil-kol-repo |
| Fremdsprachig | fil-kol-lang |
| Personen | fil-kol-pers |
| Schreibort nach Kolophonen | fil-kol-schrort |
| Datierung Handschrift | fil-kol-date |
Filter für Register (Personen, Orte und Werke)
| Bezeichnung | Filter-ID |
|---|---|
| Alphabetisch | fil-per-alphabet |
| Rolle | fil-per-type |
| Kolophonename | fil-per-kolophonename |
| Geschlecht | fil-per-sex |
| Häufigkeit Personennennung | fil-per-kol-count |
| Alphabetisch | fil-orte-alphabet |
| Verwendung | fil-orte-kol |
| Alphabetisch | fil-work-alphabet |
| GND | fil-work-gnd |
| Titel | fil-work-title |
Relationen von Objekten untereinander
| Beziehungs-ID | Von (Subjekt) | Zu (Objekt) | Bezeichnung | Beschreibung |
|---|---|---|---|---|
rel-pers-kol |
Kolophone | Personen | Personen | Personen, die in einem Kolophon genannt werden |
rel-pers-ms |
Manuskripte | Personen | PersonenMS | Personen, die irgendwo im Manuskript erwähnt werden |
rel-orte-kol |
Kolophone | Orte | Orte | Mit einem Kolophon verbundene Orte (z. B. Schreibort) |
rel-ms-kol |
Manuskripte | Kolophone | Manuskripte | Kolophone, die zu einem Manuskript gehören |