本文中的命令與Workiva Chains connector 一起使用。要查找您的鏈 ID，請查看這篇文章在 Workiva 中查找 ID 。
連接至 Workiva Rest API
除非另有指示，否則請設定值以符合您的 Appspot。
| 輸入 | 類型 | AppSpot | 詳細資訊 |
| 基底 URL | TextField | Prod (US) | https://h.app.wdesk.com/s/wdata/oc/api/ |
| 基底 URL | TextField | Prod-EU | https://h.eu.wdesk.com/s/wdata/oc/api/ |
| 基底 URL | TextField | Prod-APAC | https://h.apac.wdesk.com/s/wdata/oc/api/ |
執行鏈
執行連鎖並等待其完成。
等效的 API 呼叫:https://developers.workiva.com/chains-v1/chains-startchain/
注意: 雖然此指令可在需要動態鏈 ID 時使用，但我們建議在大多數情況下使用Run Chain 事件 。Run Chain 事件與正在執行的鏈關係更密切，提供更簡單的使用者體驗。
輸入
| 輸入 | 類型 | 詳細資訊 |
| 環境 ID | TextField | 環境的 ID。 |
| 鏈 ID | TextField | 連鎖的 ID。 |
| 運行時間變數 | GroupField | 連鎖中使用的執行時間變數值。 |
| 輪詢間隔 | NumberField | 可選的 ：檢查連鎖是否完成前要等待的時間（秒）。預設為五秒，只有當您期望連鎖執行很長時間時，才應該調整。 |
输出
| 輸出 | 輸出類型 |
| 鏈條運行 | 檔案 |
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |
依輸入值尋找鏈結執行
擷取包含所提供文字的所有連鎖執行。
等效 API 呼叫:https://developers.workiva.com/chains-v1/chains-chaininputssearch/
輸入
| 輸入 | 類型 | 詳細資訊 |
| 環境 ID | TextField | 您要搜尋的環境 ID。 |
| 搜尋文字 | TextField | 要搜尋的輸入值。 |
| 最大結果 | 數字字段 | 要擷取的最大結果數。使用 0 擷取所有項目。 |
输出
| 輸出 | 輸出類型 |
| 鏈條運行 | 檔案 |
| 鏈條運行數目 | 整數 |
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |
取得鏈結
擷取連鎖的屬性。
等效 API 調用：https://developers.workiva.com/chains-v1/chains-getchain/
輸入
| 輸入 | 類型 | 詳細資訊 |
| 環境 ID | TextField | 目標環境的 ID。 |
| 鏈 ID | TextField | 連鎖的 ID。 |
输出
| 輸出 | 輸出類型 |
| 鏈 | 檔案 |
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |
取得連鎖指令
擷取連鎖中所有指令的屬性。
等效的 API 呼叫:https://developers.workiva.com/chains-v1/chains-getcommands/
輸入
| 輸入 | 類型 | 詳細資訊 |
| 環境 ID | TextField | 目標環境的 ID。 |
| 鏈 ID | TextField | 連鎖的 ID。 |
输出
| 輸出 | 輸出類型 |
| 命令 | 檔案 |
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |
取得鏈結歷程紀錄
擷取某個連鎖的歷史連鎖運行記錄。
等效的 API 呼叫:https://developers.workiva.com/chains-v1/chains-chainrunhistory/
輸入
| 輸入 | 類型 | 詳細資訊 |
| 環境 ID | TextField | 目標環境的 ID。 |
| 鏈 ID | TextField | 連鎖的 ID。 |
| 最大結果 | 數字字段 | 要擷取的最大結果數。使用 0 擷取所有項目。 |
| 開始日期 | TextField | 篩選在指定開始日期之後發生的連鎖執行。此值可使用 ISO8601 格式或 Unix 時間戳記。 |
| 結束日期 | TextField | 篩選在指定結束日期前發生的連鎖執行。此值可使用 ISO8601 格式或 Unix 時間戳記。 |
输出
| 輸出 | 輸出類型 |
| 鏈條運行 | 檔案 |
| 鏈條運行數目 | 整數 |
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |
Get Chain Run
取得連鎖執行的詳細資訊。
等效 API 呼叫:https://developers.workiva.com/chains-v1/chains-getchainrun/
輸入
| 輸入 | 類型 | 詳細資訊 |
| 鏈運行 ID | TextField | 鏈運行的 ID。 |
输出
| 輸出 | 輸出類型 |
| 鏈條運行 | 檔案 |
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |
取得具有節點的鏈結執行
取得連鎖執行的詳細資訊，包括節點詳細資訊。
等效 API 調用:https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
輸入
| 輸入 | 類型 | 詳細資訊 |
| 鏈運行 ID | TextField | 鏈運行的 ID。 |
输出
| 輸出 | 輸出類型 |
| 鏈條運行 | 檔案 |
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |
取得鏈
擷取特定環境中的所有連鎖及其屬性。
等效 API 調用:https://developers.workiva.com/chains-v1/chains-getchains/
輸入
| 輸入 | 類型 | 詳細資訊 |
| 環境 ID | TextField | 目標環境的 ID。 |
输出
| 輸出 | 輸出類型 |
| 鏈結 | 檔案 |
| 鏈數 | 整數 |
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |
取得環境
擷取特定環境的屬性。
等效 API 呼叫:https://developers.workiva.com/chains-v1/chains-getenvironment/
輸入
| 輸入 | 類型 | 詳細資訊 |
| 工作區 ID | TextField | 環境所在工作區的 ID。 |
| 環境 ID | TextField | 目標環境的 ID。 |
输出
| 輸出 | 輸出類型 |
| 環境 | 檔案 |
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |
取得環境
擷取工作區中的環境清單。
等效 API 呼叫:https://developers.workiva.com/chains-v1/chains-getenvironments/
輸入
| 輸入 | 類型 | 詳細資訊 |
| 工作區 ID | TextField | 包含環境的工作區 ID。 |
输出
| 輸出 | 輸出類型 |
| 環境 | 檔案 |
| 環境數量 | 整數 |
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |
取得工作區
擷取工作區及其屬性。
等效的 API 呼叫:https://developers.workiva.com/chains-v1/chains-getworkspace/
輸入
| 輸入 | 類型 | 詳細資訊 |
| 工作區 ID | TextField | 工作區的 ID。 |
输出
| 輸出 | 輸出類型 |
| 工作區 | 檔案 |
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |
取得工作區
擷取公司所有工作區的清單。
等效 API 呼叫:https://developers.workiva.com/chains-v1/chains-getworkspaces/
輸入
無
输出
| 輸出 | 輸出類型 |
| 工作區 | 檔案 |
| 工作區數量 | 整數 |
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |
發布對應群組
根據映射群組 GUID 的指定，發佈映射群組。
等效的 API 呼叫:https://developers.workiva.com/chains-v1/chains-publish/
輸入
| 輸入 | 類型 | 詳細資訊 |
| 映射群組 GUID | TextField | 映射群組的 GUID。 |
输出
無
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |
搜尋鏈運行
搜尋符合給定篩選條件的連鎖運行。
等效的 API 呼叫:https://developers.workiva.com/chains-v1/chains-chainfiltersearch/
註: 超級使用者或 org 管理員不需要environment_id 參數 。
輸入
| 輸入 | 類型 | 詳細資訊 |
| 篩選條件 | GroupField | 適用於搜尋的篩選條件。 |
| 最大搜尋結果 | 數字字段 | 要擷取的最大結果數。使用 0 擷取所有項目。 |
输出
| 輸出 | 輸出類型 |
| 鏈條運行 | 檔案 |
| 鏈條運行數目 | 整數 |
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |
停止連鎖
停止目前正在執行的 Chain。
等效的 API 呼叫:https://developers.workiva.com/chains-v1/chains-stopchain/
輸入
| 輸入 | 類型 | 詳細資訊 |
| 鏈運行 ID | TextField | 要停止的連鎖執行的 ID。 |
输出
| 輸出 | 輸出類型 |
| 鏈條運行 | 檔案 |
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |
上傳對應規則
上傳映射群組 GUID 所指定的映射群組規則集。
等效 API 調用:https://developers.workiva.com/chains-v1/chains-updaterules/
輸入
| 輸入 | 類型 | 詳細資訊 |
| 映射群組 GUID | TextField | 映射群組的 GUID。 |
| 上傳模式 | DropdownField | 上傳模式。當mode=published 時，會更新並重新發表目前已發表的版本。當mode=draft 時，僅更新草稿。當mode=both 時，已發佈版本和草稿都會更新。 |
| 映射規則檔案 | 檔案欄位 | 包含要上傳的映射規則的檔案。 |
输出
| 輸出 | 輸出類型 |
| 上傳錯誤 | 檔案 |
| 上傳結果 | 檔案 |
| 上傳規則數量 | 整數 |
| 錯誤次數 | 整數 |
退出代碼
| 結束代碼 | 類型 | 詳細資訊 |
| 0 | 成功 | 成功 |
| 1 | 錯誤 | 一般故障 |
| 2 | 錯誤 | 驗證失敗 |