Informationen zum Dienst abrufen (noch nicht implementiert)
NOTE
Das Veröffentlichungsdatum für diese Funktion ist noch nicht festgelegt.
Gibt Informationen zum Dienst zurück, z. B. Funktionen und Funktionen. Adobe Workfront verwendet diese Informationen, um die Benutzeroberfläche in Workfront anzupassen. Wenn die Webhook-Implementierung beispielsweise einige benutzerdefinierte Aktionen enthält, sollte die JSON diese Vorgänge in der JSON auflisten. Benutzer können diese Aktionen dann über Workfront aufrufen.
URL
GET /serviceInfo
Abfrageparameter
Keine. Darüber hinaus sollten Aufrufe an diesen Endpunkt keine Authentifizierung erfordern.
Antwort
JSON mit Informationen zu diesem Dienst
Name
Typ
Beschreibung
webhookVersion
Zeichenfolge
Die von diesem Dienst implementierte Webhook-Version. Dies ist die Versionsnummer, die oben in dieser Spezifikation aufgeführt ist.
version
Zeichenfolge
Die interne Versionsnummer für diesen Dienst. Diese Nummer wird vom Webhook-Dienstleister bestimmt und nur zu Informationszwecken verwendet.
publisher
Zeichenfolge
Der Name des Unternehmens, das die Webhook-Implementierung bereitstellt.
availableEndpoints
Zeichenfolge
Eine Liste mit den von diesem Dienst implementierten API-Endpunkten. Dies kann verwendet werden, um sicherzustellen, dass die Benutzeroberfläche in Workfront die vom Webhook-Provider bereitgestellten Funktionen widerspiegelt. Jedes Element in der Liste muss den Namen des Endpunkts enthalten (z. B. "Suche").
customActions
Zeichenfolge
Eine Liste mit den von diesem Webhook implementierten benutzerdefinierten Vorgängen. 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 Endpunkt /customAction aufgerufen wird.
Beispiel: https://www.acme.com/api/serviceInfo
return
{
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" },
]
}
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43