Workiva Support Center

Einführung

Aufbauend auf der Einrichtung der API-Sammlung wird in diesem Artikel erklärt, wie man die Workiva-API nutzt, um Dateien aus Workiva zu exportieren. Dieser Leitfaden gilt für den Export:

• Dokumente als .PDF, .DOCX, oder .XHTML
• Tabellenkalkulationen als .XLSX, .PDF, oder .CSV
• Präsentationen als .PDF oder .PPTX

Eine zusätzliche Option ist verfügbar, um native Workiva-Dateien im .tar.gz Format zu exportieren.

Voraussetzungen

Bevor Sie fortfahren, stellen Sie sicher, dass Sie alle Schritte in der Anleitung Importing Workiva API Collections into Postman ausgeführt haben.

Authentifizierung

1. Öffnen Sie Ihren Postman-Arbeitsbereich und stellen Sie sicher, dass die richtige Umgebung ausgewählt ist.

2. Erweitern Sie die Sammlung IAM Services, öffnen Sie den Ordner OAuth2 und wählen Sie Retrieve a token.

   

3. Klicken Sie auf Senden Sie, um ein Authentifizierungstoken zu generieren. Das Token wird automatisch in der Umgebungsvariablen {{access_token}} gespeichert und wird bei allen nachfolgenden Anfragen verwendet.

Hinweis: Das Zugriffstoken läuft nach 600 Sekunden (10 Minuten) ab. Nach Ablauf der Gültigkeit wiederholen Sie diesen Schritt, um ein neues Token zu erzeugen.

Dateiexport einleiten (Dokumente, Präsentationen, Tabellenkalkulationen)

Dieses Beispiel konzentriert sich auf den Export von Workiva-Dokumenten als .PDF, .DOCX, oder .XHTML. Die gleichen Konzepte gelten für den Export von Tabellenkalkulationen oder Präsentationen.

1. Erweitern Sie die Sammlung Platform API und navigieren Sie zu Documents → Document ID → Export.
2. Öffnen Sie die Seite . Initiieren Sie einen Dokumentenexport .
3. Geben Sie auf der Registerkarte Parameter die documentId ein.
4. Aktualisieren Sie den Anfragetext, um das Exportformat anzugeben:

   • PDF

     { "pdfOptions": { "includeAlternateRowFill": true, "includeAttachmentLabels": true, "includeComments": true, "includeDraftWatermark": true, "includeHyperlinks": true, "includeLeaderDots": true, "includeTrackChanges": true, "tagForWebAccessibility": true, "useCmykColorspace": true }, "format": "pdf", "sections": [] }

   • DOCX

     { "docxOptions": { "includeLeaderDots": true, "showTableCellShading": true }, "format": "docx", "sections": [] }

   • XHTML

     { "xhtmlOptions": { "editableSimple": true, "editableXhtml": false, "includeExternalHyperlinks": false, "includeHeadersAndFooters": false }, "format": "xhtml", "sections": [] }

5. Senden Sie die Anfrage, um den Export zu starten. Dieser Prozess besteht aus drei Schritten:

   • Senden Sie die POST-Anfrage. Die Antwort enthält einen Location Header, der eine URL enthält.

     

   • Stellen Sie eine GET-Anforderung an die URL in der Kopfzeile Location, um den Exportstatus zu prüfen und die URL resource nach Abschluss der Verarbeitung abzurufen.

     

   • Führen Sie eine abschließende GET-Anfrage unter Verwendung der resource URL durch, um die exportierte Datei herunterzuladen.

     

Die exportierte Datei kann als Binärdaten zurückgegeben werden. Dies ist ein erwartetes Verhalten. Speichern Sie die Datei einfach mit der entsprechenden Erweiterung (z. B. .pdf, .docx, oder .xhtml).

Als Nächstes erfahren Sie, wie Sie eine Datei mithilfe der API-Sammlung importieren können.