Workiva Support Center

Einführung

Dieser Artikel zeigt, wie man eine Datei in Wdata mit Hilfe der Workiva APIs ersetzt. Sie rufen die vorhandene Datei ab, heben den Import auf, löschen sie und laden dann eine neue Version hoch.

Voraussetzungen

Bevor Sie beginnen, stellen Sie sicher, dass Sie alle Schritte in der Anleitung Importing Workiva API Collections into Postman ausgeführt haben. Dadurch wird sichergestellt, dass Ihre API-Sammlung und Ihre Umgebungsvariablen korrekt konfiguriert sind.

Authentifizierung

1. Öffnen Sie Ihren Postman-Arbeitsbereich und stellen Sie sicher, dass Sie die richtige Umgebung verwenden.
2. Erweitern Sie die Sammlung IAM Services, öffnen Sie den Ordner oauth2 und wählen Sie die Anforderung Retrieve a token.
3. Klicken Sie auf Senden Sie, um Ihr Authentifizierungs-Token zu generieren. Das Token wird automatisch in der Umgebungsvariablen {{access_token}} gespeichert und wird bei allen nachfolgenden API-Aufrufen verwendet.

Hinweis: Token verfallen nach 600 Sekunden (10 Minuten). Wenn dies der Fall ist, wiederholen Sie einfach diesen Schritt, um eine neue Datei zu erstellen.

Abrufen der Datei-ID mit der API zum Abrufen einer Liste von Dateien

Bevor Sie eine Datei in eine Wdata-Tabelle hochladen oder ersetzen, prüfen Sie, ob die Datei bereits existiert. Sie können dazu die API Retrieve a List of Files verwenden, um die Datei zu finden und ihre File ID zu erhalten.

Folgen Sie den nachstehenden Schritten.

1. Öffnen Sie den API-Endpunkt
   • Gehen Sie zu Wdata API → File → Retrieve a List of Files.
2. Geben Sie die gewünschten Parameter ein
   • TableId: Ihre Wdata-Tabellen-ID
   • SearchText: der Dateiname (z. B. Kontrolltabelle (3).csv)
3. Ausführen der Anfrage
   • Die API wird alle Dateien zurückgeben, die Ihrer Suche entsprechen.
4. Finden Sie die Datei-ID
   • Suchen Sie in der JSON-Antwort nach:
     • id → die Datei-ID
     • name → bestätigt die richtige Datei

(Optional) Überprüfen in Wdata
Öffnen Sie den Datensatz in der Benutzeroberfläche und überprüfen Sie die Übereinstimmung der Datei-ID.

Unimportieren Sie die Datei mit Hilfe der Datei-ID

Verwenden Sie den Endpunkt Unimport a single file, um eine importierte Datei aus einer Wdata-Tabelle zu entfernen. Mit diesem Schritt wird die Tabelle für die Aufnahme einer Ersatzdatei vorbereitet.

1. Öffnen Sie in Postman die Anfrage Unimport a single file.
2. In Pfadvariablen, setzen Sie:
   • TableId zu Ihrer Wdata-Tabellen-ID.
   • FileId zu der im vorherigen Schritt abgerufenen Datei-ID.
3. Klicken Sie auf Senden, um die Anfrage auszuführen.
4. Bestätigen Sie im Antworttext, dass der Datensatz jetzt einen aktualisierten Status aufweist (z. B. verschoben zurück nach staged). 
   
5. Öffnen Sie unter Wdata → Datasets den Datensatz und überprüfen Sie, ob die Datei nicht mehr als importiert angezeigt wird. 
   

Löschen Sie die Datei mit Hilfe der Datei-ID

1. Öffnen Sie in Postman die Anfrage Eine einzelne Datei löschen.
2. In Pfadvariablen, fügen Sie die gleiche fileId ein.
3. Senden Sie die Anfrage.
4. Bestätigen Sie, dass der Antwortkörper zurückgibt, dass fileId, dies bestätigt, dass die Datei aus der Tabelle gelöscht worden ist.

Optional: Unimport und Löschen der Datei in einem Schritt mit force=true

Wenn eine Datei nicht importiert wird, wird sie standardmäßig aus der Tabelle entfernt und in den Bereitstellungsmodus zurückgesetzt, aber nicht gelöscht. Um die Datei als Teil eines einzigen Vorgangs dauerhaft zu entfernen, fügen Sie den Abfrageparameter force hinzu.

Wenn force=true angegeben ist, wird die Datei in einer einzigen Anfrage unimportiert und gelöscht. Ein separater Löschen einer einzelnen Datei API-Aufruf ist nicht erforderlich.

Beispiel:

DELETE /api/v1/tabelle/{tableId}/import/{fileId}?force=true 

Hochladen der neuen Datei

Nachdem Sie die vorherige Datei entfernt haben, führen Sie die Schritte in der Anleitung Upload and Import a File aus, um die neue Version hochzuladen und zu importieren.