Workiva 支援中心

簡介

本文逐步介紹如何使用 Workiva API 取代 Wdata 中的檔案。您將擷取現有檔案、取消匯入並刪除它，然後上傳新版本。

必要條件

開始之前，請確保您已完成 將 Workiva API 集合匯入 Postman 指南中的所有步驟。這可確保正確設定您的 API 集合和環境變數。

驗證

1. 開啟 Postman 工作區並確認您使用的是正確的環境。
2. 展開 IAM Services 集合，開啟 oauth2 資料夾，然後選取 Retrieve a token 要求。
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 中，開啟 Unimport a single file 要求。
2. 在 路徑變數中，設定：
   • TableId 複製到 Wdata 表格 ID。
   • FileId 設為在上一步中擷取的檔案 ID。
3. 按一下 傳送 以執行要求。
4. 在回應正文中，確認檔案記錄現在顯示已更新的 狀態 （例如，已移回 暫存）。 
   
5. 在 Wdata → 資料集中，開啟資料集並確認檔案是否不再顯示為已匯入。 
   

使用檔案 ID 刪除檔案

1. 在 Postman 中，開啟 刪除一個單一檔案 要求。
2. 在 Path Variables中，貼上相同的 fileId。
3. 傳送請求。
4. 確認回應正文傳回 fileId ，這表示已從表格中刪除檔案。

可選: 使用 force=true，在一步中取消匯入並刪除檔案

預設情況下，取消匯入檔案時，它會從表格中移除並返回暫存模式，但不會刪除。若要在單一操作中永久移除檔案，請包含 force 查詢參數。

當指定 force=true 時，檔案會在單一要求中取消匯入和刪除。不需要單獨的 刪除一個檔案 API 呼叫。

範例：

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

上傳新檔案

移除先前的檔案後，請按照 上傳和匯入檔案 指南中的步驟上傳和匯入新版本。