Verwenden der API zum Synchronisieren von Daten für Programme und Services
Erstellt für:
- Entwickler
Dies sind einige gängige Möglichkeiten, die API zum Synchronisieren von Daten für Programme und Services zu verwenden.
Fast Echtzeit-Updates
Adobe Workfront verwendet „Ereignisabonnements“ (auch allgemein als Webhooks bezeichnet), um nahezu in Echtzeit Aktualisierungen zu unterstützten Objekten und Aktionen über die API an Ihre gewünschten Endpunkte zu senden. Sie können davon ausgehen, dass Sie innerhalb von 5 Sekunden ein Update zu neuen Objekten und Aktionen erhalten, aber im Durchschnitt werden Aktualisierungen in etwa 1 Sekunde eintreffen. Weitere Informationen dazu, welche Objekttypen unterstützt werden, welche Aktionstypen unterstützt werden, technische Details und Beispiele zum Einrichten von Ereignisabonnements finden Sie unter Ereignisabonnement- und Bereitstellungsanforderungen für Ereignisabonnements.
Batch-Aktualisierungen
Batch-Aktualisierungen stellen eine Möglichkeit dar, Ihr System für Aktualisierungen zu konfigurieren, indem Sie regelmäßig Anfragen an Workfront-Server senden. Dazu gibt es viele Möglichkeiten, aber im Allgemeinen besteht der Prozess darin, dass Ihr Service eine Anfrage an die Workfront-API-Server sendet und nach Objekten sucht, die seit dem letzten Anforderungsaufruf erstellt oder geändert wurden. Informationen zu potenziellen Anforderungsaufrufen und hilfreichen Parametern finden Sie im Abschnitt GET-Verhalten des Artikels API-Grundlagen .
Beim Einrichten des Service für Batch-Aktualisierungen sollten Sie folgende wichtige Punkte beachten:
Eingabedaten
Eingabedaten werden mit ISO 8601-Formatierung gespeichert. Dieser Standard enthält Informationen zu Datum, Uhrzeit und Zeitzone.
Beispiel: ISO 8601-Datumsformat
2020-05-18T17:00:00:000-0600
Sowohl das Datum, an dem ein Objekt erstellt wird, als auch das letzte Datum, an dem das Objekt geändert wurde, werden als „entryDate“ bzw. „lastUpdateDate“ gespeichert. Detaillierte Informationen zu Workfront-Objekten, ihren zugehörigen Feldern und Feldnamen finden Sie im API-Explorer. Beachten Sie, dass sich das entryDate für ein bestimmtes Workfront-Objekt nicht ändert, wobei sich das lastUpdatedDate jedes Mal ändert, wenn das Objekt geändert wird.
Beispiel: GET-Anfrage für ein Anfrageobjekt, die das Feld lastUpdateDate verwendet. Diese Anfrage gibt alle Probleme zurück, die seit diesem angegebenen Datum aktualisiert wurden.
GET
https://<domain>.my.workfront.com/attask/api/v15.0/OPTASK/search?fields=ID,name,lastUpdateDate&$$LIMIT=200&lastUpdateDate=2020-05-13T18:18:37.255Z&lastUpdateDate_Mod=gte
Tagebucheintragsobjekt
Wenn Sie Änderungen zu einem bestimmten Feld eines Objekts erhalten möchten, können Sie das Objekt „Journaleintrag“ abfragen. Das Workfront-Journaleintragsobjekt kann so eingerichtet werden, dass Informationen zu bestimmten Objektfeldern jedes Mal protokolliert werden, wenn diese Felder geändert werden. Weitere Informationen finden unter „Konfigurieren von".
Wenn ein Feld so eingerichtet ist, dass es als Teil des Journaleintragsobjekts protokolliert wird, wird jedes Mal, wenn dieses Feld geändert wird, ein entsprechender Journaleintrag erstellt. Anschließend können Sie das Journaleintragsobjekt mit einem API-Aufruf ähnlich dem folgenden abfragen:
GET https://{{domain}}.my.workfront.com/attask/api/v15.0/JRNLE/search?fields=newTextVal,oldTextVal,newDateVal,oldDateVal,newNumberVal,oldNumberVal,entryDate,objObjCode,objID,fieldName&fieldName=name&objObjCode=OPTASK&entryDate=2020-05-13T18:18:37.255Z&entryDate_Mod=gte