Workiva Support Center

介绍

本文以您已设置的 API 集合为基础，解释了如何使用 Workiva API 从 Workiva 导出文件。本指南适用于以下导出情况：

• 文档格式为 .PDF、 .DOCX或 .XHTML
• 电子表格格式为 .XLSX、 .PDF或 .CSV
• 演示文稿格式为 .PDF 或 .PPTX

还可以选择以 .tar.gz 格式导出 Workiva 原生文件。

先决条件

在继续操作之前，请确保您已完成 将 Workiva API 集合导入 Postman 指南中的所有步骤。

验证

1. 打开 Postman 工作区，并确保已选择正确的环境。

2. 展开 IAM 服务 集合，打开 OAuth2 文件夹，然后选择 检索令牌。

   

3. 点击 发送 生成身份验证令牌。令牌会自动存储在 {{access_token}} 环境变量中，并将被所有后续请求使用。

注意： 访问令牌将在 600 秒（10 分钟）后过期。过期后，重复此步骤以生成新令牌。

启动文件导出（文档、演示文稿、电子表格）

本示例重点介绍如何将 Workiva 文档导出为 .PDF、 .DOCX或 .XHTML格式。导出 电子 表格或演示文稿 时，也适用相同的概念。

1. 展开 平台 API 集合，然后导航至 文档 → 文档 ID → 导出。
2. 打开 发起文档导出 请求。
3. 在 参数 选项卡中，输入 documentId。
4. 更新请求正文以指定 导出格式:

   • 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. 发送导出请求。这个过程包括三个步骤：

   • 发送 POST 请求。响应包含一个 Location 标头，其中包含一个 URL。

     

   • 向 Location 标头中的 URL 发出 GET 请求，以检查导出状态，并在处理完成后检索 资源 URL 。

     

   • 使用 资源 URL 发出最终的 GET 请求以下载导出的文件。

     

导出的文件可能以二进制数据的形式返回。这是预期行为。只需使用适当的扩展名保存文件即可（例如， .pdf、 .docx或 .xhtml）。

接下来，回顾 如何使用API Collection 导入文件。