Workiva Support Center

介绍

本文将介绍如何使用 Workiva API 在 Wdata 中替换文件。您将检索现有文件，取消导入并将其删除，然后上传新版本。

先决条件

在开始之前，请确保您已完成 将 Workiva API 集合导入 Postman 指南中的所有步骤。这样可以确保您的 API 集合和环境变量配置正确。

验证

1. 打开 Postman 工作区，确认您使用的是正确的环境。
2. 展开 IAM 服务 集合，打开 oauth2 文件夹，然后选择 检索令牌 请求。
3. 点击 发送 以生成您的身份验证令牌。令牌会自动存储在 {{access_token}} 环境变量中，并将用于所有后续 API 调用。

注意： 令牌将在 600 秒（10 分钟）后过期。如果出现这种情况，只需重复此步骤即可生成一个新的。

使用“检索文件列表”API 获取文件 ID

在 Wdata 表中上传或替换文件之前，请确认该文件是否已存在。您可以使用 检索文件列表 API 来查找文件并获取其 文件 ID。

请按照以下步骤操作。

1. 打开 API 端点
   • 转到 Wdata API → 文件 → 检索文件列表。
2. 请输入所需参数
   • TableId: 您的 Wdata 表 ID
   • SearchText: 文件名（例如， Control Table (3).csv）
3. 运行请求
   • API 将返回所有符合您搜索条件的文件。
4. 查找文件 ID
   • 在 JSON 响应中，查找：
     • id → 文件 ID
     • 名称 → 确认文件正确

（可选）在 Wdata 中验证
在 UI 中打开数据集并确认文件 ID 匹配。

使用文件 ID 取消导入文件

使用 取消导入单个文件 端点从 Wdata 表中删除导入的文件。此步骤准备表格以接收替换文件。

1. 在 Postman 中，打开 取消导入单个文件 请求。
2. 在 路径变量中，设置：
   • TableId 指向您的 Wdata 表 ID。
   • FileId 为上一步检索到的文件 ID。
3. 点击 发送 以运行请求。
4. 在响应正文中，确认文件记录现在显示更新后的 状态 （例如，已移回 暂存）。 
   
5. 在 Wdata → Datasets中，打开数据集并验证该文件是否不再显示为已导入。 
   

使用文件 ID 删除文件

1. 在 Postman 中，打开 删除单个文件 请求。
2. 在 路径变量中，粘贴相同的 文件 ID。
3. 发送请求。
4. 确认响应正文返回 fileId ，这确认文件已从表中删除。

可选：使用 force=true 一步完成文件卸载和删除

默认情况下，当文件被取消导入时，它会从表中移除并返回到暂存模式，但不会被删除。要通过一次操作永久删除文件，请包含 force 查询参数。

当指定 force=true 时，文件将在一次请求中被取消导入并删除。无需 单独调用 API来删除单个文件。

例子：

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

上传新文件

删除先前文件后，请按照 上传和导入文件 指南中的步骤上传和导入新版本。