Wo ist die Dokumentation zur REST-API?

Lily · 4. Mai 2023

Unter folgendem Link [klick] wird zwar darauf verwiesen, dass sich die vollständige Dokumentation unter irgendeinem "Modul" befände, einen Link liefert sie aber nicht.

Habe nun die letzte Stunde danach gesucht, ohne Ergebnis.

Erbitte ein Link zur vollständigen Dokumentation der REST-API von Agorum.

annkatrin.goepfert · 4. Mai 2023

Hallo Lily,

in dieser Doku liegen dir zur Nutzung passende Infos vor Eigenen (custom) JavaScript API Service erstellen

Unsere Api-Dokumentation selbst liegt dir auf der Startseite unserer Software vor. Melde dich dazu als Administrator an:

Lily · 4. Mai 2023

annkatrin.goepfert Danke für Ihre Antwort. Die in Ihrem Link bereitgestellte Dokumentation verwirrt dennoch.

Unter dem Abschnitt Aktionen des CustomService kennenlernen steht Öffnen Sie links in der Seitenleiste Weitere Apps und dann API-Dokumentation,

aber auch diese Links kann ich nicht finden. Bezieht sich diese Referenzen ebenfalls auf die auf der Startseite bereitgestellte API-Dokumentation? Ich habe agorum noch nicht installiert, sondern wollte mich vorher über die Schnittstellen informieren. Sind diese Hilfestellungen nur in der Dokumentation vom installiertem Agorum vorzufinden?

volker.trotte · 5. Mai 2023

Lily Die API-Dokumentation, die sich auf swagger als Dokugrundlage bezieht, findet sich tatsächlich nur in der jeweiligen agorum Instanz auf der Startseite bzw. unter weitere Apps. Somit passt die Doku auch immer zur jeweiligen agorum Version - man kann auch direkt die Funktionalität der API ohne weitere Entwicklung testen. Sie müssen also agorum herunterladen/installieren und starten.

Ich meine, dass die open source version von agorum die entsprechende Doku auch mitbringt. Per Virtualbox kann man so schnell und kostenfrei einen Blick auf die Doku werfen: Link zum Download

Lily · 5. Mai 2023

Hallo,

vielen Dank für die Hilfe bisher. Ich habe mir nun eine kostenlose Agorum-Version heruntergeladen, diese installiert und zum Laufen bekommen. Ich konnte in der mitgelieferten Hilfe auch schon ein paar wertvolle Informationen zur REST-API sammeln. Was ich aber nicht gefunden habe, ist eine Möglichkeit, um Dokumente über die REST-API downzuloaden. Gibt es diese Option nicht, oder übersehen ich da nur etwas?

Vielen Dank im Voraus für die eifrige Hilfe.

volker.trotte · 8. Mai 2023

Guten Morgen Lily,
Dokumente können wie folgt heruntergeladen werden:

Der Link lädt das Dokument direkt vom agorum core-Server im Original herunter. Dabei können Sie die ID oder UUID (empfohlen) angeben.

Code

http://agorum-core-server/api/rest/object/download/[ID oder UUID]

Falls Sie das Dokument im Browser nur anzeigen und nicht herunterladen möchten, führen Sie nachfolgenden Aufruf aus, etwa für Bilder oder PDF-Dateien:

Code

http://agorum-core-server/api/rest/object/embed/[ID oder UUID]

Weitere Infos: Doku Dateidownload

annkatrin.goepfert · 8. Mai 2023

volker.trotte

Danke für deinen Input!!

annkatrin.goepfert · 14. Mai 2025

Auch wenn der Forumseintrag bereits etwas älter ist, möchte ich an der Stelle ergänzen, dass die agorum core 11 mit einer neuen, öffentlichen API ausgeliefert wird.

Für mehr Informationen siehe: agorum core High-level API

Wo ist die Dokumentation zur REST-API?

Jetzt Teil von agorum Community werden!

Teilen

Tags