Abrufen von Informationen über den Service (noch nicht implementiert)

Letzte Aktualisierung: 25. April 2025
  • Themen:

Erstellt für:

  • Entwickler
HINWEIS
Das Veröffentlichungsdatum für diese Funktion ist noch nicht festgelegt.

Gibt Informationen zum Service zurück, z. B. Funktionen. Adobe Workfront verwendet diese Informationen, um die Benutzeroberfläche in Workfront anzupassen. Wenn die Webhook-Implementierung beispielsweise benutzerdefinierte Aktionen enthält, sollte die JSON diese Vorgänge in der JSON-Datei auflisten. Benutzer können dann diese Aktionen von Workfront aus aufrufen.

URL

GET /serviceInfo

Abfrageparameter

Keine. Darüber hinaus sollten Aufrufe an diesen Endpunkt keine Authentifizierung erfordern.

Antwort

JSON mit Informationen zu diesem Service

NameTypBeschreibung
webhookVersionZeichenfolgeDie Webhook-Version, die von diesem Service implementiert wird. Dies ist die Versionsnummer, die oben in dieser Spezifikation aufgeführt ist.
VersionZeichenfolgeDie interne Versionsnummer für diesen Service. Diese Nummer wird vom Webhook-Dienstleister festgelegt und dient nur zu Informationszwecken.
VerlegerZeichenfolgeDer Name des Unternehmens, das die Webhook-Implementierung bereitstellt.
availableEndpointsZeichenfolgeEine Liste mit den API-Endpunkten, die von diesem Service implementiert wurden. Damit kann sichergestellt werden, dass die Benutzeroberfläche in Workfront die vom Webhook-Anbieter bereitgestellten Funktionen widerspiegelt. Jedes Element in der Liste muss den Namen des Endpunkts enthalten (z. B. „Suche„).
customActionsZeichenfolgeEine Liste mit den benutzerdefinierten Vorgängen, die von diesem Webhook implementiert wurden. Jedes Listenelement enthält einen Namen und einen Anzeigenamen. Der Anzeigename wird im Dropdown-Menü „Dokumentaktionen“ in Workfront angezeigt. Durch Klicken auf das Element in der Dropdown-Liste wird die Aktion im Webhook aufgerufen, indem der /customAction-Endpunkt aufgerufen wird.

Beispiel: https://www.acme.com/api/serviceInfo

Rückgabe

{
webhook version: "1.2", version: "1.0", publisher: "Acme, LLC", availableEndpoints: ["files", "metadata", "search", "download"
"thumbnail", "uploadInit", "upload" ], customActions [
{
name: "archive", displayName: "Archive"
},
{name: "doSomethingElse", displayName: "Do Something" },
]
}
Vorherige SeiteDokument oder Ordner löschen (noch nicht implementiert)
Nächste SeiteDokument oder Ordner umbenennen (noch nicht implementiert)

Workfront