Dokumente über Filterpfade finden

Überblick

Die Find-API ermöglicht es, Dokumente anhand eines Filterpfads über die FLOWWER-REST-API zu finden. Der Filterpfad verwendet dieselbe Abfragelogik wie die Filterseite und kann dort ohne manuelles Zusammensetzen erstellt und geprüft werden. Die Funktion eignet sich beispielsweise, wenn eine eigene Integration regelmäßig genau die Dokumente abrufen soll, die einer fachlich zusammengestellten Filterkombination entsprechen.

Filterpfad erstellen

1. Öffnen Sie die Filterseite.
2. Wählen Sie die benötigten Merkmale und Werte aus.
3. Prüfen Sie die Ergebnisliste in FLOWWER.
4. Übernehmen Sie den Filterpfad aus der Adresszeile für den API-Aufruf.

Auch Mehrfachauswahlen und ODER-Gruppen sind Bestandteil des Filterpfads und werden bei der Abfrage berücksichtigt.

Abfrage über die REST-API

Die Find-Aktion für Filterpfade ist in der Swagger-Oberfläche des jeweiligen FLOWWER-Kontos dokumentiert:

https://<Ihre-FLOWWER-Kontokennung>.flowwer.de/swagger

Dort finden Sie die für Ihre FLOWWER-Version gültige Route, HTTP-Methode und Request-Struktur. Übergeben Sie den zuvor erstellten Filterpfad an die dort beschriebene Aktion.

Für den Zugriff gelten die normale Authentifizierung der FLOWWER-REST-API und die Berechtigungen des verwendeten API-Benutzers. Zurückgegeben werden nur Dokumente, auf die dieser Benutzer zugreifen darf.

Typischer Ablauf

1. Fachlichen Filter in FLOWWER zusammenstellen und testen.
2. Filterpfad in die eigene Integration übernehmen.
3. Find-API mit den Zugangsdaten eines geeigneten API-Benutzers aufrufen.
4. Die gefundenen Dokumente in der eigenen Anwendung weiterverarbeiten.

Derzeitige Abgrenzung

Dieser Endpunkt verarbeitet Filterpfade der Filterseite. Gespeicherte Suchen und Abfragen der Erweiterten Suche können derzeit nicht über dieselbe Find-Aktion ausgeführt werden. Für tabellarische Reporting-Auswertungen in Excel oder Power Query steht alternativ der OData-Reporting-Endpunkt zur Verfügung.