Workiva 連接器命令使用 Workiva 平台 API。目前的版本是 2022-01-01，但這將會停用。為了維持您的鏈結正常運作，我們將把每個 Workiva 連接器命令移至版本 2026-01-01。
大多數 Workiva 連接器命令將在 2026 年 11 月 30 日自動移至 2026-01-01，您無需執行任何操作。如需完整清單，請參閱 Workiva 連接器：移動到平台 API 2026-01-01 的命令 。「 執行報告」 和 「列出使用者」 命令中有變更，需要您採取動作，因此您必須選擇何時切換它們。您必須在 2027 年 10 月 31 日之前進行這些變更。當天，這些命令將變更為新的 API，且在正確設定之前無法運作。
API 版本選取
這兩個命令現在都有 API 版 本欄位，可讓您指定 2022 或 2026。預設值為 2022，因此沒有值的命令將使用 2022。
其他變更
注意： 輸出成果名稱將保持不變，因此鏈結的其餘部分將可繼續運作。
- 現在，執行報表 會在下載前匯出報表。如果匯出所花費的時間超過約 5 分鐘，這可能需要更長時間並且失敗。執行時間不應超過 10 分鐘。
- 列出使用者 需要 組織
：讀取 範圍以包含在 OAuth2 授予中。
有關 API 變更（包括試算表命令變更）的更多資訊，請參閱 Workiva 支援頁面 Workiva 連接器：移至平台 API 的命令 2026-01-01。
執行報告
維持不變的項目
- 輸入：
報表 ID、 預覽內容。 - 輸出： 報告 CSV 檔案。
- 命令僅在檔案準備就緒後完成。
2026-01-01 中有哪些變化
- 此命令開始報表的匯出，大約每秒鐘檢查一次狀態，然後下載 CSV。
- 鏈結記錄將顯示「正在檢查作業狀態...」，狀態為 「已確認」、 「已排隊」或 「已啟動」，以及「已成功完成作業」。命令是否正確完成。如果命令未正確完成，則會在記錄中記錄訊息「操作失敗」。
- 與在 2022-01-01 版本中相比，此命令可能需要更長的時間執行，因為連接器最多檢查匯出內容 300 次或最多 10 分鐘，以先到者為準。按每秒一次的檢查計算，大約需要 5 分鐘。如果此時匯出尚未完成，命令將失敗。
- 提示： 如果鏈結命令超時時間比匯出命令的時間短，請將時間提高以便檔案可以到達。
- 錯誤的報表 ID 通常會失敗，並顯示「操作失敗」。
- 不需要新的權限。OAuth2 授予仍需要
chart:read。
將命令切換為 2026
- 開啟鏈結並選取 「執行報表」(Run Report) 命令。
- 將 API Version 設定為 2026。
- 儲存並執行鏈結。
- 檢查 報表 輸出是否包含您預期的資料。
疑難排解
| 訊息 | 該怎麼做 |
|---|---|
超過 300 的嘗試時間限制 |
報表匯出未及時完成。減少報表大小或篩選條件，或將命令重新設定為「2022」並聯絡支援人員。 |
操作失敗或操作 已取消 |
檢查報表 ID。如果無誤，請使用記錄中顯示的 ID 聯絡支援人員。 |
錯誤: 無法產生使用者報告。 |
檢查報告 ID 以及授予是否有 graph:read。後續訊息包含 API 詳細資料。 |
列出使用者
維持不變的項目
- 輸入：
組織 ID。 - 輸出： 使用者報告 JSON 檔案和 記錄計數。
- OAuth2 授予使用者必須是組織管理員。
2026-01-01 中有哪些變化
- 連線使用的 OAuth2 授與需要具有 組織
:讀取 範圍。 - 如果沒有該範圍，該命令將失敗，並返回「未經授權 (401)」或「禁止訪問 (403)」HTML 錯誤，而不是傳回使用者清單。
將命令切換為 2026
-
組織安全管理
員新增 組織:讀取 至 API 授權，其用戶端 ID 儲存在您的 Workiva 連線中：- 按一下右上角的使用者圖示，選取 Admin，然後 選取 Organization admin。
- 在左側選單中，選取 Security，然後選取 Provisioning 索引標籤。
- 找到該授予並從 「動作」 功能表中開啟。
- 在 Scopes中，選取
組織：讀取 並儲存。用戶端密碼保持不變。
注意：
organization:read是組織範圍。它不是從工作區設定指派的。如需
更多資訊，請參閱 Workiva 支援頁面 在組織管理員中建立和管理 API 授與。 - 開啟鏈結並選取 「列出使用者」(List Users) 命令。
- 將 API Version 設定為 2026。
- 儲存並執行鏈結。
- （可選，但建議）記錄「 記錄計數」 值。
- 將 API Version 值改回 2022，然後再次執行鏈結。
- 確認兩次執行的 「記錄計數」 值相同。
附註
- 預設 API 版本為 2022-01-01，這是沒有值的命令將使用的版本。
- 應將新命令設定為 2026。
- 您可以為每個 「執行報表 並 列出使用者」 命令執行個體選擇 2022 或 2026。
- 2022-01-01 版本將於 2027 年 11 月 30 日停止運作。您需要將命令移至該日期之前的 2026 年。
- 其他 Workiva 連接器圖表命令將於 2026 年 11 月 30 日自動移至 2026-01-01，您無需變更這些命令。
- 他們的 JSON 輸出成果可以以不同的順序列出欄位和項目。值相同。
疑難排解
| 訊息 | 該怎麼做 |
|---|---|
錯誤: 無法擷取使用者報表。，錯誤表中的狀態為 401 或 403 |
檢查 API 授予是否 有組織：讀取 ，並且授予使用者是否是組織管理員。然後再次執行命令。 |
錯誤: 無法擷取使用者報表。，具有其他狀態 |
檢查組織 ID 是否正確。錯誤表格包含 API 詳細資料。 |
試算表命令變更
這些也將自動更新，無需編輯鏈結。輸入和輸出不會變更，但運作方式會有所不同：
- 刪除試算表 會將試算表移至垃圾桶，而不是將其永久刪除。
- 取得工作表資料 會忽略修訂值，並傳回最新資料，但附警告。
- 現在，寫入、 覆寫、 清除工作表資料、 更新工作表中繼資料、 發布試算表和 刪除試算表 等到變更完成，並忽略 使用異步 設定。如果變更所花費的時間超過 5 分鐘左右，則這些命令將會失敗。
- Get Sheet Data、 Write Sheet Data和 Overwrite Sheet Data 會忽略 Use Platform API 設定。
如果我什麼都不做呢？
使用這些命令的命令將繼續使用 2022-01-01 直到 2027 年 10 月 31 日。在該日期之後，設定為 2022-01-01 的命令將停止運作。
需要協助嗎？
聯絡 Workiva 支援。