Durchführen einer benutzerdefinierten Aktion (noch nicht implementiert)

Letzte Aktualisierung: 31. Dezember 2024
  • Themen:

Erstellt für:

  • Entwickler

Dieser Endpunkt ermöglicht es einem Adobe Workfront-Benutzer (oder einem automatisierten Workflow-Ereignis), eine Aktion im externen System durchzuführen. Der /customAction-Endpunkt akzeptiert einen „name“-Parameter, mit dem der Webhook-Anbieter mehrere benutzerdefinierte Vorgänge implementieren kann.

Der Webhook-Anbieter registriert benutzerdefinierte Aktionen bei Workfront, indem er die Aktionen in die /serviceInfo-Antwort unter customActions aufnimmt. Workfront lädt diese Liste, wenn Sie den Webhook-Anbieter unter Einrichtung > Dokumente > Benutzerdefinierte Integrationen einrichten oder aktualisieren.

Benutzerinnen und Benutzer können die benutzerdefinierte Aktion mit Triggern versehen, indem sie den Abschnitt unter „Dokumentaktionen“ auswählen

URL

GET/customAction

Abfrageparameter

-NameBeschreibung
nameDie Kennung, die den Typ der auszuführenden Aktion angibt. Dieser Wert entspricht einem der customAction-Werte, die vom Endpunkt /serviceInfo zurückgegeben werden.
documentIdDie Workfront-Dokument-ID, für die die Aktion ausgeführt wird.
documentVersionIdDie ID der Workfront-Dokumentversion, für die die Aktion ausgeführt wird.

Antwort

Eine JSON-Zeichenfolge, die Erfolg oder Fehler anzeigt, wie im Abschnitt Fehlerbehandlung unten angegeben. Bei einem Fehler (d. h. Status = „Fehler„) zeigt Workfront dem Benutzer die bereitgestellte Fehlermeldung an.

Beispiel:

https://sample.com/webhooks/customName?name=archive&documentId=5502082c003a4f30 ddec2fb2b739cb7c&documentVersionId=54b598a700e2342d6971597a5df1a8d3

Antwort

{
status: "success"
}
Vorherige SeiteDokument oder Ordner umbenennen (noch nicht implementiert)
Nächste SeiteDocument Webhooks-API

Workfront