Workiva 連接器指令

要將 Workiva 平台內的任務自動化為連鎖的一部分，例如啟用與其他資料來源的資料交換，請新增包含 Workiva 連線指令的步驟。

要啟用這些指令，IT 管理員首先設定一個 Workiva 連結器。

清除工作表資料

若要清除工作表中的所有資料，請使用Clear sheet data 指令。

等效 API 調用：https://developers.workiva.com/2022-01-01/updatelegacyspreadsheetdataasync.html

摘要資訊

摘要資訊	詳細資訊
試算表 ID	輸入要清除工作表的試算表唯一識別碼。
工作表 ID/名稱	輸入要清除工作表的名稱或唯一識別碼。

输出

無

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

建立檔案

若要上載逗號分隔值 (CSV)、Javascript 物件符號 (JSON) 或壓縮 ZIP 檔案，並列出其記錄，請使用Create file 指令。您也可以將 URL 上傳至檔案，例如將 Amazon S3® 簽署的 URL 上傳至 S3 收件匣中的檔案。

如果是 JSON 檔案，則每行必須有單一 JSON 記錄 - JSON 檔案是以換行符分隔的一系列 JSON 物件。
如果是 ZIP 檔案，則必須包含單一 CSV 或 JSON 檔案，其名稱用於命名匯入的檔案。再次下載檔案會下載來源。
如果是 URL，端點會使用簡單的未認證GET 請求來取得檔案。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-uploadfile/

摘要資訊

摘要資訊	詳細資訊
表格 ID	輸入要列出檔案的表格 ID。
檔案	輸入要上傳的檔案。如果輸入下載網址，則會忽略。備註：檔案必須具有 .CSV 或 .JSON 副檔名，或為包含具有 .CSV 或 .JSON 副檔名的檔案的 ZIP 檔案。
名稱	如果輸入Download URL ，請輸入要上傳的檔案名稱；預設為Download URL 的基準名稱。
下載 URL	輸入指向要下載檔案的 URL，例如 Amazon S3 簽署的 URL。若輸入File 則為選項。註記：此指令針對 URL 進行簡單的`GET` 請求，不需要驗證。

输出

輸出	輸出類型
結果	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

建立新的記錄編輯

若要根據提供的屬性建立新的記錄編輯，請使用Create new record edits 指令。每個編輯至少需要一個操作和 targetId。

限制： 每次要求者最多可處理 1000 個編輯。

等效 API 調用： https://developers.workiva.com/platform-v1/platform-createedits/

摘要資訊

摘要資訊	詳細資訊
開刀	選擇要執行的操作。選項: 建立記錄刪除記錄建立關係刪除關係設定屬性
標籤	輸入描述兩筆記錄之間關係的標籤。用於建立或刪除關係。
摘要資訊	輸入與記錄類型相關的屬性。用於建立記錄或設定其內容。
記錄 ID	輸入來源的 ID 或臨時記錄 ID。用於建立或刪除關係。
目標 ID	輸入目標記錄的 ID。如果建立記錄，您可以使用記錄 ID 或臨時記錄 ID；如果刪除記錄，則必須使用實際記錄 ID。
臨時記錄 ID	輸入建立記錄時使用的臨時 ID；此臨時 ID 會在處理時更換。您可以在同一請求中使用此 ID，在已建立的記錄之間建立關係。
類型	輸入要建立的記錄類型。

输出

輸出	輸出類型
透視檢視	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

建立透視表

要根據查詢和查詢結果建立新的 Wdata 檢視，請使用Create pivot view 指令。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-createpivotview/

摘要資訊

摘要資訊	詳細資訊
名稱	輸入唯一的名稱，以協助識別檢視。
查詢 ID	輸入要建立檢視的查詢結果 ID。
查詢結果 ID	輸入要建立檢視的查詢結果 ID。
附加元資料	輸入使用者定義的元資料，以 JSON 物件附加到檢視 (選用)。

输出

輸出	輸出類型
透視檢視	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

建立預覽查詢

若要在資料表建立可執行的臨時預覽查詢，請使用Create preview query 指令。

等效的 API 呼叫： 不適用

摘要資訊

摘要資訊	詳細資訊
表格 ID	輸入要查詢的資料表 ID。
限制	輸入要返回的最大結果數。
檔案	如果指定，請輸入要查詢的資料表中的檔案名稱。

输出

輸出	輸出類型
查詢	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

建立查詢

若要建立新的 Wdata 查詢，請使用Create query 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-createquery/

摘要資訊

摘要資訊	詳細資訊
名稱	輸入唯一的名稱，以協助識別查詢。
說明	輸入查詢的描述。
主要結果 ID	如果指定，請輸入預設結果的 ID，以便在查詢結果中填入。
查詢文字	以 Presto SQL 語法輸入查詢定義，，如同在查詢的 SQL 編輯器中一樣。
暫存	若要暫時產生查詢，使其不會而非出現在您的工作區中，請勾選此方塊。
參數	輸入執行查詢所需的參數。

输出

輸出	輸出類型
查詢	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

建立記錄

此指令僅可透過 Platform API 使用。若要建立新記錄，請使用Create new record edits 端點。

建立選擇清單

若要為多重選擇查詢參數建立值清單，請使用Create select list 指令。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-createselectlist/

摘要資訊

摘要資訊	詳細資訊
名稱	輸入唯一的名稱，以協助識別選擇清單。
說明	若要進一步識別選擇清單，請輸入其值或參數的說明。
值類型	選擇清單數值的資料類型，如字串或整數。
值	輸入清單的值。

输出

輸出	輸出類型
建立選擇清單元資料	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

建立工作表

若要在電子表格中新增工作表，請使用Create sheet 指令。

等效的 API 呼叫： https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/

摘要資訊

摘要資訊	詳細資訊
試算表 ID	輸入要新增工作表的試算表唯一識別碼。
名稱	輸入有助於識別工作表的唯一名稱。
工作表索引	輸入電子表格中新工作表的索引。備註：預設情況下，該命令會將工作表新增為最上工作表。
父工作表 ID	輸入要在其下建立工作表的父工作表 ID。要添加到根電子表格，請留空。

输出

輸出	輸出類型
工作表元資料	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

建立試算表

若要建立新的試算表，請使用Create spreadsheet 指令。

等效 API 調用：https://developers.workiva.com/2022-01-01/createlegacyspreadsheet.html

摘要資訊

摘要資訊	詳細資訊
名稱	輸入唯一的名稱，以協助識別試算表。

输出

輸出	輸出類型
工作表元資料	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

建立數據表

若要在工作區中建立新的 Wdata 資料表，請使用Create table 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-createtable/

摘要資訊

摘要資訊	詳細資訊
名稱	輸入唯一的名稱，以協助識別表。
說明	輸入新表的描述。
類型	選擇是否要建立資料 (或事實) 或查詢 (或尺寸) 表。
資料欄	添加要包含在表中的列：若要手動新增欄位，請為每一列按一下新增，然後輸入其名稱、資料類型、別名和說明。對於Mode ，保留預設為 Nullable。若要以 JavaScript Object Notation (JSON) 方式新增欄位的詳細資訊，請啟用Variable ，並輸入 JSON 物件或變數。

输出

輸出	輸出類型
表格	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

刪除檔案

要從 Wdata 工作區刪除檔案，請使用Delete file 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-deletefile/

摘要資訊

摘要資訊	詳細資訊
檔案 ID:	輸入要刪除檔案的 ID。

输出

無

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

刪除透視表

若要從工作區刪除 Wdata 檢視，請使用Delete pivot view 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-deletepivotview/

摘要資訊

摘要資訊	詳細資訊
ID	輸入要刪除的檢視的 ID。

输出

無

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

刪除查詢

若要從工作區刪除 Wdata 查詢，請使用 Delete query 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-deletequery/

摘要資訊

摘要資訊	詳細資訊
查詢 ID	輸入要刪除的查詢 ID。

输出

無

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

刪除記錄

此指令僅可透過 Platform API 使用。要刪除記錄，請使用建立新的記錄編輯命令。

刪除工作表

要從試算表中刪除工作表及其子工作表（遞迴），請使用刪除工作表 命令。

等效 API 調用： https://developers.workiva.com/2022-01-01/deletelegacysheet.html

摘要資訊

摘要資訊	詳細資訊
試算表 ID	輸入要刪除工作表的試算表唯一識別碼。
工作表 ID/名稱	輸入要刪除工作表的名稱或唯一識別碼。

输出

無

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

刪除試算表

若要從工作區刪除試算表，請使用Delete spreadsheet 指令。

等效的 API 呼叫： https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/

摘要資訊

摘要資訊	詳細資訊
試算表 ID	輸入要刪除試算表的唯一識別碼。

输出

無

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

刪除表格

若要從工作區刪除 Wdata 資料表，請使用Delete table 指令。

等效的 API 調用： https://developers.workiva.com/wdata-v1/wdata-deletetable/

摘要資訊

摘要資訊	詳細資訊
表格 ID	輸入要刪除資料表的唯一識別碼

输出

無

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

下載檔案

若要從 Wdata 工作區下載資料集，請使用Download file 指令。

註：此指令與其他物件類型不相容，例如試算表、表格或查詢。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/

摘要資訊

摘要資訊	詳細資訊
檔案 ID:	輸入要下載檔案的 ID。

输出

輸出	輸出類型
檔案	檔案

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

<!--

Download Pivot View

Downloads the content from a pivot view

Inputs

Input	Detail
ID	Enter the ID of the pivot view to download

Outputs

Output	Output Type
Pivot View Content	File

Exit Codes

Code	Type	Detail
0	Success	Success
1	Error	Error

--> <!--

Download pivot view

To download the contents of a view, use a Download pivot view command.

Properties

Property	Detail
ID	Enter the ID of the view to download.

Outputs

Output	Output Type
Pivot view content	File

Exit codes

Code	Type	Detail
0	Success	Success
1	Error	Error

-->

下載查詢結果

若要下載 Wdata 查詢結果到檔案，請使用Download query result 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/

摘要資訊

摘要資訊	詳細資訊
查詢結果 ID	輸入要下載的查詢結果 ID。

输出

輸出	輸出類型
查詢結果	檔案

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

編輯

此指令僅可透過 Platform API 使用。若要編輯記錄，請使用Create new record edits 端點。

匯出檔案至試算表

若要將資料集從 Wdata 表格匯出到新的或現有的試算表，請使用Export file to spreadsheet 指令。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/

摘要資訊

摘要資訊	詳細資訊
檔案 ID:	輸入要匯出的表格資料集 ID。
試算表 URL	輸入要匯出至的試算表 URL。若要建立新的試算表，請留空。

输出

輸出	輸出類型
工作表資訊	檔案

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

匯出查詢結果

要將 Wdata 查詢結果匯出到新的或現有的試算表，請使用Export query result 指令。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/

摘要資訊

摘要資訊	詳細資訊
查詢結果 ID	輸入要匯出的查詢結果 ID。
試算表 URL	輸入要匯出至的試算表 URL。若要建立新的試算表，請留空。
匯出為資料集	當勾選時，資料會以連線資料集的形式匯出，且只能透過更新試算表中的資料集來編輯儲存格。

输出

無

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

取得檔案屬性

要檢索 Wdata 工作區中檔案的屬性，請使用Get file properties 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-getfile/

摘要資訊

摘要資訊	詳細資訊
檔案 ID:	輸入要取得屬性的檔案 ID。

输出

輸出	輸出類型
檔案屬性	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

取得透視表

若要擷取 Wdata 檢視的元資料，請使用Get pivot view 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-getpivotview/

摘要資訊

摘要資訊	詳細資訊
ID	輸入要從中樞檢視取得元資料的 ID。

输出

輸出	輸出類型
透視檢視	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

取得查詢元資料

要擷取 Wdata 查詢的元資料，請使用Get query metadata 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-getquery/

摘要資訊

摘要資訊	詳細資訊
查詢 ID	輸入要取得元資料的查詢 ID。

输出

輸出	輸出類型
查詢	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

取得記錄

此指令僅可透過 Platform API 使用。若要取得記錄，請使用Retrieve a single record 端點。

取得記錄

此指令僅可透過 Platform API 使用。若要取得多筆記錄，請使用Retrieve a list of records 端點。

取得報告

若要從組織的 SOX 與內部稽核資料庫帳戶擷取所有報告，請使用Get reports 指令。

等效 API 調用：https://developers.workiva.com/platform-v1/platform-graphreportexport/

摘要資訊

無

输出

輸出	輸出類型
報告	檔案
報告計數	整數

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

取得選擇清單

若要根據清單 ID 擷取多重選擇查詢參數的值清單，請使用Get select list 指令。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-getselectlist/

摘要資訊

摘要資訊	詳細資訊
選擇清單 ID	輸入要擷取的選擇清單的唯一識別碼。

输出

輸出	輸出類型
取得選擇清單有效負載	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

取得工作表資料

若要擷取工作表指定區域中的所有資料，請使用Get sheet data 指令。

等效的 API 呼叫： https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/

摘要資訊

摘要資訊	詳細資訊
試算表 ID	輸入要從工作表取得資料的試算表唯一識別碼。
工作表 ID/名稱	輸入要從工作表取得資料的名稱或唯一識別碼。
地區	輸入儲存格或範圍的 A1 式表示，例如`[起始列][起始行]:[停止列][停止行]` 。若要讓範圍在任何或所有方向上不受邊界限制，請略過對應的列或行。
值樣式	選擇是否回傳原始或計算的儲存格數值。例如，如果單元格的值為`=1+:1` ，請選擇 Raw 以取得 =1+1，或選擇 Calculated 以取得計算值 2。
修訂	輸入要擷取資料的工作表版本。對於目前版本，請輸入 -1。
使用平台 API	當此方塊被標記時，此命令使用標準小數位符號回傳工作表資料。如果是空白，工作表資料會使用科學符號來報酬。這將強制命令使用從工作表端點擷取資料，而非試算表 API 的從區域端點回報資料。

輸出

輸出	輸出類型
行數	整數
資料	檔案

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

取得工作表元資料

若要擷取試算表中工作表的元資料，請使用Get sheet metadata 指令。

等效 API 調用： https://developers.workiva.com/2022-01-01/getsheetdata.html

摘要資訊

摘要資訊	詳細資訊
試算表 ID	輸入要從工作表取得元資料的試算表唯一識別碼。
工作表 ID/名稱	輸入要取得元資料的工作表名稱或唯一識別碼。

输出

輸出	輸出類型
工作表元資料	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

取得試算表元資料

若要擷取試算表的元資料，請使用Get spreadsheet metadata 指令。

等效 API 調用： https://developers.workiva.com/2022-01-01/getplatformspreadsheetbyid.html

摘要資訊

摘要資訊	詳細資訊
試算表 ID	輸入要從電子表格取得元資料的唯一識別碼。

输出

輸出	輸出類型
試算表元資料	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

取得資料表元資料

要擷取 Wdata 資料表的元資料，請使用Get table metadata 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-gettable/

摘要資訊

摘要資訊	詳細資訊
表格 ID	輸入要取得元資料的資料表的唯一識別碼。

输出

輸出	輸出類型
表格	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

取得類型

此指令僅可透過 Platform API 使用。若要取得記錄，請使用Retrieve a single record 端點。

取得類型

此指令僅可透過 Platform API 使用。若要取得多個記錄類型，請使用Retrieve a list of types endpoint。

健康檢查

要檢查 Wdata API 的健康狀況，請使用健康檢查 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-healthcheck/

摘要資訊

無

输出

輸出	輸出類型
回覆	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

將檔案匯入資料表

要將檔案匯入 Wdata 資料表，請使用Import file into table 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-importfile/

摘要資訊

摘要資訊	詳細資訊
表格 ID	輸入要將檔案匯入表格的 ID。
檔案 ID:	輸入要匯入資料表的檔案 ID。
欄位對應	將檔案中的每一列映射到資料表的列。
以非同步方式執行	若要讓命令以異步方式執行，且而非要等到匯入完成後才繼續連鎖，請勾選此方塊。
標記	若要包含組織追蹤資料的元資料，請新增標籤並選擇其名稱和值。

输出

輸出	輸出類型
檔案匯入	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

將電子表格匯入表格

若要將電子表格匯入表格並傳回檔案元結果，請使用Import spreadsheet into table 指令。

對應的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/

摘要資訊

摘要資訊	詳細資訊
表格 ID	輸入要匯入檔案的表格的唯一識別碼。
檔案 ID:	輸入要匯入試算表的檔案唯一識別碼（可選）。
檔案名稱	輸入匯入表格時要賦予檔案的唯一名稱。
試算表 URL	輸入要從電子表格匯入資料的完整 URL。
以非同步方式執行	若要讓命令以異步方式執行，且而非要等到匯入完成後才繼續連鎖，請勾選此方塊。
標記	若要包含組織追蹤資料的元資料，請新增標籤並選擇其名稱和值。

输出

輸出	輸出類型
檔案匯入	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

列出連線

要列出 Workiva 平台功能之間的資料，請使用List connections 指令。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-listconnections/

摘要資訊

摘要資訊	詳細資訊
來源類型	使用下拉式功能表，選擇要從中取得資料的檔案或項目的類型。
目的地類型	使用下拉式功能表，選擇要傳送資料的檔案或項目的類型。
來源 ID	輸入要從中取得資料的檔案或項目的唯一識別碼。
目的地 ID	輸入要傳送資料的檔案或項目的唯一識別碼。

注意：您的請求必須包含Source Type + Source ID 或Destination Type + Destination ID ；如果其中一個配對不存在，請求將失敗。

输出

輸出	輸出類型
連線	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

列出檔案錯誤

若要列出與檔案相關的錯誤，例如匯入造成的錯誤，請使用List file errors 指令。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-geterrors/

摘要資訊

摘要資訊	詳細資訊
檔案 ID:	輸入要取得錯誤的檔案 ID。

输出

輸出	輸出類型
錯誤清單	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

列出檔案

若要擷取 Wdata 表中的檔案清單及其元資料，請使用List files 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-getfiles/

摘要資訊

摘要資訊	詳細資訊
表格 ID	輸入要從中取得檔案的資料表 ID。

输出

輸出	輸出類型
檔案清單	檔案

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

列出透視表

若要列出工作區中的 Wdata 檢視並擷取其元資料，請使用List pivot views 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-listpivotviews/

摘要資訊

無

输出

輸出	輸出類型
樞軸檢視	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

列出查詢

若要列出工作區中的 Wdata 查詢，並擷取其元資料，請使用List queries 指令。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-listqueries/

摘要資訊

無

输出

輸出	輸出類型
查詢	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

列出查詢結果

若要列出 Wdata 查詢的可用結果，請使用List query results 指令。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-listqueryresults/

摘要資訊

摘要資訊	詳細資訊
查詢 ID	輸入要取得結果的查詢 ID。

输出

輸出	輸出類型
查詢結果	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

列出選擇清單

若要列出工作區中多重選擇查詢參數的所有值清單，並擷取其元資料，請使用List select lists 指令。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-listselectlists/

摘要資訊

無

输出

輸出	輸出類型
列出選擇清單	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

列出工作表

要列出電子表格中的所有工作表並擷取其元資料，請使用List sheets 指令。

等效 API 調用： https://developers.workiva.com/2022-01-01/getlegacysheets.html

摘要資訊

摘要資訊	詳細資訊
試算表 ID	輸入要列出工作表的試算表唯一識別碼。

输出

輸出	輸出類型
工作表	JSON
張數	整數

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

列表表格

若要列出工作區中的所有 Wdata 表並擷取其元資料，請使用List tables 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-gettables/

摘要資訊

無

输出

輸出	輸出類型
表格清單	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

列出使用者

要擷取組織使用者的詳細資訊清單，請使用List users 指令。您指定的整合使用者必須具有「組織管理員」角色，才能執行此指令。

類似於組織管理員的「人員檢視」匯出，詳細資料會依顯示名稱排序，並包括使用者的：電子郵件地址：

使用者名稱
電子郵件地址
SAML ID
上次登入
工作區成員資格
授權與角色

等效 API 調用： https://developers.workiva.com/admin-v1/admin-getorgreportusers/

摘要資訊

摘要資訊	詳細資訊
組織 ID	輸入要列出使用者的組織的唯一識別碼。

输出

輸出	輸出類型
使用者報告	檔案
記錄數量	整數

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

覆寫工作表資料

要清除工作表中的所有單元格，並以檔案中提供的值取代，請使用Overwrite sheet data 指令。

等效 API 調用： https://developers.workiva.com/2022-01-01/updatesheet.html#

摘要資訊

摘要資訊	詳細資訊
試算表 ID	輸入要覆寫工作表資料的電子表格唯一識別碼。
工作表 ID/名稱	輸入要覆寫資料的工作表名稱或唯一識別碼。
資料檔案	輸入包含要填充工作表資料的 CSV 檔案。
分隔符號	輸入資料檔案中使用的分隔符。
使用平台 API	若要使用電子表格儲存格數值的輸入於格式，請勾選此方塊。

输出

輸出	輸出類型
已寫入的行	整數
寫入的儲存格	整數

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

發佈試算表

若要在電子表格中發佈連結，請使用Publish spreadsheet 指令。

等效 API 調用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/

摘要資訊

摘要資訊	詳細資訊
試算表 ID	輸入要發佈試算表的唯一識別碼。
發佈所有鏈接	選擇要發佈的試算表連結：若要發佈所有連結，請勾選此方塊。若要只發佈您擁有的連結，請清除此方塊。

输出

輸出	輸出類型
訊息	字串

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

重新整理連線

若要根據 ID 更新特定連線，請使用Refresh connection 指令。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-refreshconnection/

摘要資訊

摘要資訊	詳細資訊
連線 ID	輸入要刷新連線的唯一識別碼。
使用先前的來源參數	勾選此方塊以使用上一次執行的來源參數；這會取代您指定的任何其他來源參數。此輸入將被 "Refresh batch of connections" 端點忽略。
來源參數*	輸入要在成功刷新時傳送給來源的參數。 (如果啟用「使用先前的來源參數」，這些參數將被忽略）。
使用先前的目的地參數	勾選此方塊以使用上一次執行的目的地參數；這會取代您指定的任何其他目的地參數。此輸入將被 "Refresh batch of connections" 端點忽略。
目的地參數*	輸入要在成功刷新時傳送至目的地的參數。 (如果啟用「使用先前的目的地參數」，這些參數將被忽略）。

注意：目前不支援多選參數。

输出

輸出	輸出類型
刷新狀態	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

批次重新整理連線

若要一次刷新多個連線，請使用Refresh batch of connections 指令。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-refreshbatch/

摘要資訊

摘要資訊	詳細資訊
連線	切換啟用或停用變數的使用。啟用時可從左邊的功能表中選擇可用變數。無法新增新連線。
連線 ID	輸入要刷新連線的唯一識別碼。
使用先前的來源參數	勾選此方塊以使用上一次執行的來源參數；這會取代您指定的任何其他來源參數。此輸入將被 "Refresh batch of connections" 端點忽略。
來源參數	輸入要在成功刷新時傳送給來源的參數。 (如果啟用「使用先前的來源參數」，這些參數將被忽略）。
使用先前的目的地參數	勾選此方塊以使用上一次執行的目的地參數；這會取代您指定的任何其他目的地參數。此輸入將被 "Refresh batch of connections" 端點忽略。
目的地參數	輸入要在成功刷新時傳送至目的地的參數。 (如果啟用「使用先前的目的地參數」，這些參數將被忽略)。

输出

輸出	輸出類型
批次刷新狀態	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

移除邊緣

此指令僅可透過 Platform API 使用。若要移除邊緣，請使用Create new record edits 端點。

擷取記錄清單

若要傳回符合所提供篩選條件的記錄清單，請使用Retrieve a list of records 指令。總是需要至少一個篩選條件。

等效 API 調用： https://developers.workiva.com/platform-v1/platform-getrecords/

摘要資訊

詳細資訊

展開

傳回與主資源內嵌的相關資源。

選項:

無 (預設)
關係

篩選

要篩選結果的屬性。

输出

輸出	輸出類型
批次刷新狀態	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

擷取類型清單

要返回記錄類型及其屬性清單，請使用Retrieve a list of types 命令。此指令可讓您知道擷取記錄的預期結果。

等效 API 調用： https://developers.workiva.com/platform-v1/platform-gettypes/

摘要資訊

摘要資訊	詳細資訊
展開	傳回與主資源內嵌的相關資源。選項: 無 (預設) 關係

输出

輸出	輸出類型
批次刷新狀態	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

擷取單一記錄

若要擷取單一記錄，請使用Retrieve a list of records 指令。唯一識別碼通常是 UUID，但也可能不同。

等效 API 調用： https://developers.workiva.com/platform-v1/platform-getrecordbyid/

摘要資訊

詳細資訊

展開

傳回與主資源內嵌的相關資源。

選項:

無 (預設)
關係

記錄 ID

輸入記錄的唯一識別碼。

输出

輸出	輸出類型
批次刷新狀態	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

擷取單一類型

若要擷取單一記錄，請使用Retrieve a list of records 指令。唯一識別碼通常是 UUID，但也可能不同。

等效 API 調用： https://developers.workiva.com/platform-v1/platform-gettypebyid/

摘要資訊

詳細資訊

展開

傳回與主資源內嵌的相關資源。

選項:

無 (預設)
關係

記錄 ID

輸入記錄的唯一識別碼。

输出

輸出	輸出類型
批次刷新狀態	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

執行查詢

若要執行 Wdata 查詢並擷取其結果，請使用Run query 指令。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-runquery/

摘要資訊

摘要資訊	詳細資訊
查詢 ID	輸入要執行的查詢 ID。
參數	如果查詢已定義參數，請新增其名稱和值的對應圖。注意：在多選參數中輸入任何多選參數的值。
以非同步方式執行	若要以非同步方式執行查詢，且而非等待查詢完成後才完成指令，請勾選此方塊。
多選參數	如果查詢已定義多選參數，請加入每個參數的名稱和值。

输出

輸出	輸出類型
查詢結果	JSON

注意：查詢結果輸出包含一個 ID，可用於下載和匯出結果。

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

執行報告

若要在組織的 SOX 與內部稽核資料庫帳戶中執行儲存的報告，並將其結果以 CSV 檔案形式傳回，請使用Run report 指令。

等效 API 調用： https://developers.workiva.com/platform-v1/platform-getreportascsv/

摘要資訊

摘要資訊	詳細資訊
報表 ID	輸入包含已儲存報告的報告的唯一識別碼。
預覽內容	若要在指令的記錄中包含報告結果的預覽，請勾選此方塊。

输出

輸出	輸出類型
報告	檔案

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

設定邊緣

此指令僅可透過 Platform API 使用。若要設定邊緣，請使用Create new record edits 端點。

設定記錄屬性

此指令僅可透過 Platform API 使用。若要設定記錄屬性，請使用Create new record edits 端點。

從表中取消匯入檔案

若要從 Wdata 資料表取消匯入及移除檔案，請使用Un-import file From table 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-unimportfile/

摘要資訊

摘要資訊	詳細資訊
表格 ID	輸入要從表移除檔案的唯一識別碼。
檔案 ID:	輸入要從表中移除的檔案的唯一識別碼。

输出

輸出	輸出類型
檔案匯入	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

更新透視表

要更新 Wdata 檢視的元資料，請使用Update pivot view 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-updatepivotview/

摘要資訊

摘要資訊	詳細資訊
ID	輸入要更新的檢視的 ID。
名稱	輸入檢視的新名稱。
查詢 ID	輸入要建立檢視的查詢結果 ID。
查詢結果 ID	輸入要建立檢視的查詢結果 ID。
附加元資料	輸入要附加到檢視的使用者定義元資料，為 JSON 物件（可選）。

输出

輸出	輸出類型
透視檢視	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

更新查詢定義

要更新 Wdata 查詢的屬性，請使用更新查詢定義 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-updatequery/

摘要資訊

摘要資訊	詳細資訊
查詢 ID	輸入要更新的查詢 ID。
名稱	輸入查詢的新名稱。
說明	輸入查詢的新說明。
主要結果 ID	如果指定，請輸入預設結果的 ID，以便在查詢結果中填入。
查詢文字	以 Presto SQL 語法輸入查詢定義，就像在查詢的 SQL 編輯器中輸入.
臨時	若要暫時產生查詢，使其不會而非顯示在您的工作區中，請勾選此方塊。
參數	輸入執行查詢所需的參數。

输出

輸出	輸出類型
查詢	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

更新選擇清單

若要更新多重選擇查詢參數的值清單的屬性或項目，請使用Update select list 指令。

等效 API 調用： https://developers.workiva.com/wdata-v1/wdata-updateselectlist/

摘要資訊

摘要資訊	詳細資訊
ID	輸入要更新的選擇清單 ID。
名稱	輸入選擇清單的新名稱。
說明	輸入選擇清單的新說明。
值類型	選擇清單數值的資料類型，如字串或整數。
值	輸入清單的值，包括任何更新。

输出

輸出	輸出類型
更新選擇清單	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

更新工作表元資料

要更新電子表格中工作表的元資料，請使用更新工作表元資料 指令。

等效的 API 呼叫： https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/

摘要資訊

摘要資訊	詳細資訊
試算表 ID	輸入要更新元資料的工作表電子表格的唯一識別碼。
工作表 ID/名稱	輸入要更新元資料的工作表名稱或唯一識別碼。
名稱	輸入工作表的新名稱。
工作表索引	輸入電子表格中工作表的新索引。預設情況下，指令會將工作表更新為最上工作表。
父工作表 ID	輸入要在其下建立工作表的父工作表 ID。要添加到根電子表格，請留空。

输出

無

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

更新試算表元資料

要更新試算表的元資料，請使用更新試算表元資料 指令。

等效 API 調用： https://developers.workiva.com/2022-01-01/updatesheet.html

摘要資訊

摘要資訊	詳細資訊
試算表 ID	輸入要更新元資料的工作表電子表格的唯一識別碼。
名稱	輸入試算表的新名稱。

输出

無

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

更新表格

要更新 Wdata 表的列，請使用Update table 指令。

等效的 API 呼叫： https://developers.workiva.com/wdata-v1/wdata-updatetable/

摘要資訊

摘要資訊	詳細資訊
表格 ID	輸入要更新的資料表的唯一識別碼。
名稱	輸入要更新的資料表的名稱。
說明	輸入要更新的資料表的描述。
類型	選擇是否要更新資料-或事實-或查詢-或尺寸-表。
資料欄	新增要更新資料表的欄位。為每一列輸入名稱、資料類型、別名和說明。對於模式，保留預設為 Nullable。

输出

輸出	輸出類型
表格	JSON

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

寫入工作表資料

若要將 CSV 資料集中的資料寫入工作表的特定區域，請使用Write sheet data 指令。

摘要資訊

摘要資訊	詳細資訊
試算表 ID	輸入要寫入資料的工作表的電子表格唯一識別碼。
工作表 ID/名稱	輸入要寫入資料的工作表唯一識別碼。
資料檔案	輸入要寫入工作表資料的 CSV 檔案。資料的範圍不得超過區域。
分隔符號	輸入資料檔案中使用的分隔符。
地區	輸入工作表中要寫入資料的 A1 表示儲存格或儲存格範圍。要使範圍在任何或所有方向上不受邊界限制，請將對應的列或行留空。
使用異步	若要以非同步方式載入資料，例如大型資料集，請勾選此方塊。注意: 使用 async 時，您必須自行新增輪詢以確定工作的狀態。
使用平台 API	若要使用Region 單元值的 entered-in 格式，請勾選此方塊。這將強制命令使用更新範圍端點中的值，而不是電子表格 API 的將資料寫入區域端點。注意: 使用平台 API 時，此命令將始終以非同步方式執行。您必須自行加入輪詢以確定工作的狀態。

输出

輸出	輸出類型
已寫入的行數	整數
寫入的儲存格	整數

退出代碼

代碼	類型	詳細資訊
0	成功	成功
1	錯誤	錯誤

Workiva 支援中心

清除工作表資料

摘要資訊

输出

退出代碼

建立檔案

摘要資訊

備註： 檔案必須具有 .CSV 或 .JSON 副檔名，或為包含具有 .CSV 或 .JSON 副檔名的檔案的 ZIP 檔案。

註記： 此指令針對 URL 進行簡單的GET 請求，不需要驗證。

输出

退出代碼

建立新的記錄編輯

摘要資訊

输出

退出代碼

建立透視表

摘要資訊

输出

退出代碼

建立預覽查詢

摘要資訊

输出

退出代碼

建立查詢

摘要資訊

输出

退出代碼

建立記錄

建立選擇清單

摘要資訊

输出

退出代碼

建立工作表

摘要資訊

備註： 預設情況下，該命令會將工作表新增為最上工作表。

输出

退出代碼

建立試算表

摘要資訊

输出

退出代碼

建立數據表

摘要資訊

输出

退出代碼

刪除檔案

摘要資訊

输出

退出代碼

刪除透視表

摘要資訊

输出

退出代碼

刪除查詢

摘要資訊

输出

退出代碼

刪除記錄

刪除工作表

摘要資訊

输出

退出代碼

刪除試算表

摘要資訊

输出

退出代碼

刪除表格

摘要資訊

输出

退出代碼

下載檔案

註： 此指令與其他物件類型不相容，例如試算表、表格或查詢。

摘要資訊

输出

退出代碼

Download Pivot View

Inputs

Outputs

Exit Codes

備註：檔案必須具有 .CSV 或 .JSON 副檔名，或為包含具有 .CSV 或 .JSON 副檔名的檔案的 ZIP 檔案。

註記：此指令針對 URL 進行簡單的`GET` 請求，不需要驗證。

備註：預設情況下，該命令會將工作表新增為最上工作表。

註：此指令與其他物件類型不相容，例如試算表、表格或查詢。