Rest Api

twytec · 8. September 2023

Hallo,

ich arbeite mich grade in Agorum Rest Api ein und werde nicht ganz schlau.

Mein Ziel ist es die Metadaten einer Datei auszulesen und zwar aus einer externen Anwendung.

Login habe ich hinbekommen aber wie muss der Get Aufruf aufgebaut ein?

Z.B. ein Aufruf mit der Swagger API

/api/rest/object?provider=note&source=b8b8cef0-4c2e-11ee-9df0-080027198b6f&sessionId=xxx

Code

{
  "success": true,
  "errorClass": 0,
  "errorCode": 0,
  "errorKey": 0,
  "message": "",
  "total": 0,
  "data": [],
  "meta": {}
}

Was mache ich falsch?

Gruß

Thomas

twytec · 8. September 2023

Ein Aufruf kann so aussehen:

http://192.168.1.116:80/api/rest/object/{id}?properties=~~&sessionId={sessionId}

Damit bekommt man die Metadaten aus agorum core basic archive.

Ganz ehrlich am besten öffnet man die DevTools des Browsers navigiert dort hin wo die Infos angezeigt werden und schau sich die Kommunikation zwischen WebApp und Server an. Die Dokumentation zu lesen macht wenig sinn.

volker.trotte · 11. September 2023

twytec
Wir benutzen für spezifische Dinge immer eine Custom API - diese kann in der Regel auch recht schnell integriert werden.
Das ist aus unserer Sicht häufig einfacher, da wir hier mehr Kontrolle darüber haben, was passiert.

zum Debuggen empfehlen wir tools wie z.B. Talend API Tester o.ä.

Doku: Eigenen (custom) JavaScript-API-Service erstellen

twytec · 12. September 2023

Danke für den Tipp

Dominik Katzenmaier · 14. September 2023

Metadaten werden nur ausgespuckt, wenn diese mit dem query-parameter "properties" angefragt werden.

properties=~ gibt alle Metadaten aus (..naja, zumindest die selbst definierten und grundlegende wie area,identifier),

properties=~metadatum spuckt ein bestimmtes Metadaten aus.

Die Tilde (~) signalisiert in der API, dass es sich um ein Metadatum handelt. Denn mit properties können auch Objektdaten wie "name" oder "description" abgefragt werden, die werden dann ohne Tilde angegeben.

Auch vielleicht noch wissenswert, "properties" kann mehrfach angegeben werden, um weitere Einzelwerte abzufragen.

Rest Api

Jetzt Teil von agorum Community werden!

Teilen

Ähnliche Themen

"Waiting until the server becomes available ..." wird sporadisch angezeigt

Wo ist die Dokumentation zur REST-API?

Tutorials zu agorum core

Gesammelte Metrik-Daten per REST-Request bei SOLR abholen