Workiva 支援中心

若要與 Box® 磁碟機互動，請在使用 Box 連線指令的連線中加入步驟。例如：

• 上傳、下載、移動、搜尋或刪除檔案
• 建立和刪除資料夾
• 擷取檔案和資料夾 URL

若要啟用這些指令，IT 管理員首先建立一個 Box 連接器 。

複製檔案

若要在 Box 中複製檔案，請使用 Copy file 指令。

對應的 API 呼叫： https://developer.box.com/reference/post-file-requests-id-copy/

摘要資訊

摘要資訊	詳細資訊
檔案 ID:	輸入要複製的檔案 ID。
檔案名稱	輸入要複製的檔案名稱。可選擇是否輸入檔案 ID 。
父資料夾名稱	輸入包含要複製的檔案的資料夾名稱。可選擇是否輸入檔案 ID 。
目的地資料夾 ID	輸入要將檔案複製到的目標資料夾 ID （選用）。對於根目錄，請輸入0 。
目的地資料夾名稱	輸入要複製到的資料夾名稱。可選，如果您輸入Destination Folder ID 。
名稱	若要重新命名檔案的副本，請輸入其名稱（可選）。

输出

輸出	輸出類型
檔案	JSON
檔案 ID:	字串

退出代碼

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

複製資料夾

若要複製 Box 中的資料夾，請使用複製資料夾 指令。

對應的 API 呼叫： https://developer.box.com/guides/folders/single/copy/

摘要資訊

摘要資訊	詳細資訊
資料夾 ID	輸入要複製的資料夾 ID。
資料夾名稱	輸入要複製的資料夾名稱。可選擇是否輸入資料夾 ID 。
目的地資料夾 ID	輸入要將複本儲存到的資料夾 ID。
目的地資料夾名稱	輸入要複製儲存至的資料夾名稱。可選，如果您輸入目的地資料夾 ID 。
新資料夾名稱	若要重新命名檔案複本，請輸入其名稱（選用）。

输出

輸出	輸出類型
資料夾	JSON
資料夾 ID	字串

退出代碼

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

建立資料夾

若要在 Box 中建立資料夾，請使用Create folder 指令。

等效的 API 呼叫： https://developer.box.com/guides/folders/single/create/

摘要資訊

摘要資訊	詳細資訊
資料夾名稱	輸入新資料夾的名稱。
目的地資料夾 ID	輸入目的地資料夾 ID。對於根目錄，請輸入0 。
目的地資料夾名稱	輸入目的地資料夾的名稱（選用）。

输出

輸出	輸出類型
資料夾	JSON
資料夾 ID	字串

退出代碼

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

刪除檔案

若要刪除 Box 中的檔案，請使用Delete file 指令。

等效的 API 調用： https://developer.box.com/guides/file-requests/delete/

摘要資訊

摘要資訊	詳細資訊
檔案 ID:	輸入要刪除檔案的 ID
檔案名稱	輸入要刪除的檔案名稱。可選擇是否輸入檔案 ID.
父資料夾名稱	輸入包含要刪除檔案的資料夾名稱。可選擇是否輸入檔案 ID 。

输出

輸出	輸出類型
檔案 ID:	字串

退出代碼

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

刪除資料夾

若要刪除 Box 中的資料夾，請使用Delete folder 指令。

等效的 API 呼叫： https://developer.box.com/guides/folders/single/delete/

輸入

摘要資訊

摘要資訊	詳細資訊
資料夾 ID	輸入要刪除的資料夾 ID
資料夾名稱	輸入要刪除的資料夾名稱。可選擇是否輸入資料夾 ID.
父資料夾名稱	輸入包含要刪除的資料夾的資料夾名稱。可選擇是否輸入資料夾 ID 。
RECURSIVE	若要在資料夾中包含項目時遞延刪除資料夾，請勾選此方塊。

输出

輸出	輸出類型
資料夾 ID	字串

退出代碼

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

下載檔案

若要從 Box 下載檔案，請使用Download file 指令。

等效的 API 呼叫： https://developer.box.com/guides/downloads/file/

摘要資訊

摘要資訊	詳細資訊
檔案 ID:	輸入要下載檔案的 ID。
檔案名稱	輸入要下載的檔案名稱。可選擇是否輸入檔案 ID.
父資料夾名稱	輸入包含要下載檔案的資料夾名稱。可選擇是否輸入檔案 ID 。

输出

輸出	輸出類型
線條	整數
檔案	檔案

退出代碼

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

取得檔案資訊

若要擷取 Box 中檔案的元資料，請使用Get file info 指令。

等效的 API 呼叫： https://developer.box.com/reference/get-files-id/

摘要資訊

摘要資訊	詳細資訊
檔案 ID:	輸入要查詢元資料的檔案 ID。
檔案名稱	輸入要查詢元資料的檔案名稱。可選擇是否輸入檔案 ID 。
父資料夾名稱	輸入包含要查詢元資料的檔案的資料夾名稱。可選擇是否輸入檔案 ID 。

输出

輸出	輸出類型
檔案資訊	JSON
檔案 ID:	字串

退出代碼

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

取得資料夾資訊

若要擷取 Box 中資料夾的元資料，請使用Get folder info 指令。

等效 API 調用： https://developer.box.com/reference/get-folders-id/

摘要資訊

摘要資訊	詳細資訊
資料夾 ID	輸入要取得元資料的資料夾 ID。
資料夾名稱	輸入要取得元資料的資料夾名稱。可選擇是否輸入資料夾 ID.

输出

輸出	輸出類型
資料夾資訊	JSON

退出代碼

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

取得資料夾項目

若要擷取 Box 資料夾內的所有項目，請使用Get folder items 指令。

等效的 API 呼叫： https://developer.box.com/reference/get-folders-id-items/

摘要資訊

摘要資訊	詳細資訊
資料夾 ID	輸入要檢索項目的資料夾 ID。
資料夾名稱	輸入要檢索項目的資料夾名稱。可選擇是否輸入資料夾 ID 。
父資料夾名稱	輸入包含要從中擷取項目之資料夾的資料夾名稱。可選擇是否輸入資料夾 ID 。
方向	選擇資料夾項目的排序順序。
限制	輸入退回項目的限制。

输出

輸出	輸出類型
總計	整數
參賽作品	JSON

退出代碼

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

搜尋

若要在 Box 中搜尋物件，請使用Search 指令。

等效的 API 呼叫： https://developer.box.com/guides/search/

摘要資訊

摘要資訊	詳細資訊
查詢	輸入搜尋查詢。
檔案副檔名	輸入要限制搜尋結果的檔案副檔名。
類型	選取要尋找的物件類型。對於所有類型，請留空。
限制	輸入要返回的結果數目。

输出

輸出	輸出類型
參賽作品	JSON
總計	整數

退出代碼

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

更新檔案資訊

若要更新 Box 中檔案的名稱、描述或父資料夾，請使用Update file info 指令。

等效的 API 呼叫： https://developer.box.com/guides/file-requests/update/

摘要資訊

摘要資訊	詳細資訊
檔案 ID:	輸入要更新檔案的 ID。
檔案名稱	輸入要更新的檔案名稱。可選擇是否輸入檔案 ID.
父資料夾名稱	輸入包含要更新檔案的資料夾名稱。可選擇是否輸入檔案 ID 。
名稱	輸入檔案的新名稱。
描述	輸入檔案的描述。
目的地資料夾 ID	輸入要將檔案移動到的資料夾 ID （選用）。
目的地資料夾名稱	輸入要將檔案移動到的資料夾名稱。如果輸入目的地資料夾 ID ，則可選。

输出

輸出	輸出類型
檔案	JSON
檔案 ID:	字串

退出代碼

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

更新資料夾

若要更新 Box 中資料夾的名稱、描述或父資料夾，請使用Update folder 指令。

對應的 API 呼叫： https://developer.box.com/reference/put-folders-id/

摘要資訊

摘要資訊	詳細資訊
資料夾 ID	輸入要更新的資料夾 ID。
資料夾名稱	輸入要更新的資料夾名稱。可選擇是否輸入資料夾 ID 。
目的地資料夾 ID	輸入要將資料夾移動到的資料夾 ID （選用）。對於根目錄，請輸入0 。
目的地資料夾名稱	輸入要將資料夾移動到的資料夾名稱。可選擇是否輸入Destination Folder ID 。
名稱	輸入資料夾的新名稱。
描述	輸入資料夾描述。

输出

輸出	輸出類型
資料夾	JSON

退出代碼

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

上傳檔案

若要上載檔案到 Box，請使用Upload file 指令。

等效的 API 呼叫： https://developer.box.com/guides/file-requests/update/

摘要資訊

摘要資訊	詳細資訊
檔案	輸入要上傳的檔案。
目的地資料夾 ID	輸入要儲存檔案的目的地資料夾 ID。
目的地資料夾名稱	輸入要儲存檔案的目的地資料夾名稱。可選擇是否輸入目的地資料夾 ID 。
名稱	輸入檔案的新名稱。

输出

輸出	輸出類型
檔案	JSON
檔案 ID:	字串

退出代碼

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

上傳檔案版本

若要上載新版本的檔案到 Box，請使用Upload file version 指令。

等效 API 調用： https://developer.box.com/guides/uploads/direct/file-version/

摘要資訊

摘要資訊	詳細資訊
檔案	輸入要上傳新版本的檔案。
檔案 ID:	輸入要建立新版本的檔案 ID。
名稱	輸入要上傳新版本的檔案名稱。可選擇是否輸入檔案 ID.
父資料夾名稱	輸入包含要上傳新版本檔案的資料夾名稱。可選擇是否輸入檔案 ID 。

输出

輸出	輸出類型
線條	整數
檔案	JSON
檔案 ID:	字串

退出代碼

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