Suche über Dokument-Webhooks

Letzte Aktualisierung: 31. Dezember 2024

Erstellt für:

  • Entwickler

Gibt Metadaten für die bei einer Suche zurückgegebenen Dateien und Ordner zurück. Dies kann als Volltextsuche oder als reguläre Datenbankabfrage implementiert werden. Adobe Workfront ruft den /search-Endpunkt auf, wenn der Benutzer eine Suche über den externen Dateibrowser durchführt.

URL

GET/search

Abfrageparameter

-NameBeschreibung
AbfrageDer Suchbegriff oder die Phrase.
parentId(optional) Die Ordner-ID, von der aus die Suche ausgeführt wurde. Hinweis: Dies ist ein Platzhalter für eine zukünftige Funktion in Workfront. Derzeit gibt Workfront diesen Parameter nicht weiter.
maxDie maximale Anzahl an zurückzugebenden Elementen. Wird für die Paginierung verwendet.
VersatzDer Seitenversatz, verwendet in Verbindung mit „max“.

Antwort

JSON mit einer Liste von Metadaten für Dateien und Ordner, die mit der Abfrage übereinstimmen. Was eine „Übereinstimmung“ darstellt, wird vom Webhook-Anbieter bestimmt. Idealerweise sollte dies eine Volltextsuche sein. Eine auf Dateinamen basierende Suche funktioniert ebenfalls.

Beispiel:

Beispiel: https://www.acme.com/api/search?query=test-query

[
{ File/Folder Metadata },
{ File/Folder Metadata }
]
Vorherige SeiteElementliste des Ordnerinhalts abrufen
Nächste SeiteAbrufen von Dokumentinhalten über Webhooks

Workfront