Box
Box 連接器可讓您連線至 Box 後端,並使用 SQL 擷取及更新 Box 資料。
支援的版本
這個連接器支援 Box Content API 2.0 版。
事前準備
使用 Box 連接器前,請先完成下列工作:
- 在 Google Cloud 專案中:
- 確認已設定網路連線。如要瞭解網路模式,請參閱「網路連線」。
- 將 roles/connectors.admin IAM 角色授予設定連線器的使用者。
- 將下列 IAM 角色授予要用於連接器的服務帳戶:
roles/secretmanager.viewerroles/secretmanager.secretAccessor
服務帳戶是特殊的 Google 帳戶類型,主要用於代表需要驗證且必須取得授權才能存取 Google API 資料的非人類使用者。如果您沒有服務帳戶,請建立服務帳戶。連接器和服務帳戶必須屬於相同專案。詳情請參閱「建立服務帳戶」。
- 啟用下列服務:
secretmanager.googleapis.com(Secret Manager API)connectors.googleapis.com(Connectors API)
如要瞭解如何啟用服務,請參閱「啟用服務」。
如果先前未啟用這些服務或權限,系統會在設定連結器時提示您啟用。
設定連接器
連線專屬於資料來源。也就是說,如果有多個資料來源,您必須為每個資料來源建立個別的連結。如要建立連結,請按照下列步驟操作:
- 在 Cloud 控制台中,前往「Integration Connectors」>「Connections」頁面,然後選取或建立 Google Cloud 專案。
- 按一下「+ 建立新連線」,開啟「建立連線」頁面。
- 在「位置」部分中,選擇連線的位置。
- 區域:從下拉式清單中選取位置。
如需所有支援區域的清單,請參閱「地點」一文。
- 點按「下一步」。
- 區域:從下拉式清單中選取位置。
- 在「連線詳細資料」部分,完成下列步驟:
- 連接器:從可用連接器的下拉式清單中選取「Box」。
- 連接器版本:從可用版本的下拉式清單中選取連接器版本。
- 在「連線名稱」欄位中,輸入連線執行個體的名稱。
連線名稱必須符合下列條件:
- 連線名稱可使用英文字母、數字或連字號。
- 字母必須為小寫。
- 連線名稱開頭須為英文字母,結尾則須為英文字母或數字。
- 連結名稱不得超過 49 個半形字元。
- 視需要輸入連線執行個體的「Description」(說明)。
- 或者,可啟用 Cloud Logging,然後選取記錄層級。記錄層級預設為
Error。 - 服務帳戶:選取具備必要角色的服務帳戶。
- 視需要設定「連線節點設定」:
- 節點數下限:輸入連線節點的數量下限。
- 節點數上限:輸入連線節點數上限。
節點是用來處理交易的連線單位 (或備用資源)。如要處理更多連線交易,就需要更多節點;反之,如要處理較少的交易,則需要較少的節點。如要瞭解節點對連線器價格的影響,請參閱「 連線節點的定價」。如未輸入任何值,系統預設會將節點下限設為 2 (提高可用性),節點上限則設為 50。
- 使用者身分模擬模式:指定使用者身分模擬類型。應為使用者模式或管理員模式。
- (選用) 在「進階設定」部分,選取「使用 Proxy」核取方塊,為連線設定 Proxy 伺服器,並設定下列值:
-
「Proxy Auth Scheme」(Proxy 驗證方案):選取要用於 Proxy 伺服器的驗證類型。支援的驗證類型如下:
- 基本:基本 HTTP 驗證。
- 摘要:摘要 HTTP 驗證。
- Proxy 使用者:用於向 Proxy 伺服器驗證的使用者名稱。
- Proxy Password:使用者密碼的 Secret Manager 密碼。
-
Proxy SSL Type:連線至 Proxy 伺服器時要使用的 SSL 類型。支援的驗證類型如下:
- 自動:預設設定。如果網址是 HTTPS 網址,則會使用「Tunnel」(通道) 選項。如果網址是 HTTP 網址,系統會使用「永不」選項。
- 「Always」(一律):連線一律啟用 SSL。
- 「永不」:連線未啟用 SSL。
- 通道:連線是透過通道 Proxy 建立。Proxy 伺服器會開啟與遠端主機的連線,流量會透過 Proxy 來回傳輸。
- 在「Proxy 伺服器」部分,輸入 Proxy 伺服器的詳細資料。
- (選用) 按一下「+ 新增標籤」,以鍵/值組合的形式為連線新增標籤。
- 點按「下一步」。
-
在「驗證」部分,輸入驗證詳細資料。
- 選取「驗證類型」,然後輸入相關詳細資料。
Box 連線支援下列驗證類型:
- JWT 驗證
- OAuth 2.0 - 授權碼
- Box JSON
- OAuth 2.0 - 用戶端憑證
- 點按「下一步」。
如要瞭解如何設定這些驗證類型,請參閱「設定驗證」。
- 選取「驗證類型」,然後輸入相關詳細資料。
- 檢查:檢查連結和驗證詳細資料。
- 點選「建立」。
設定驗證機制
根據要使用的驗證方式輸入詳細資料。
-
JWT 驗證
- 用戶端 ID:Box 為您建立的應用程式提供的用戶端 ID。
- 用戶端密鑰:Secret Manager 密鑰,內含您所建立應用程式的用戶端密鑰。
- 密鑰版本:用戶端密鑰的版本。
- 私密金鑰:Secret Manager 密鑰,內含私密金鑰檔案的內容。私密金鑰應與提供給連線器的公開金鑰/憑證相符。
- 密鑰版本:私密金鑰密鑰的版本。
- 私密金鑰密碼:包含私密金鑰檔案密碼 (同義詞) 的 Secret Manager 密鑰。
- 密鑰版本:私密金鑰密碼的版本。
- Box 應用程式存取層級:Box 應用程式的應用程式存取層級。
- 企業 ID/使用者 ID:如果應用程式層級為企業,則為企業 ID;如果應用程式層級為使用者,則為使用者 ID
- OAuth JWT 公開金鑰 ID:JWT 公開金鑰的 ID。
- 驗證架構:Box 連接器的驗證架構。
- 啟動 OAuth:啟動 Box 連接器的 OAuth 參數。
- OAuth JWT 憑證類型:Box 連接器的 OAuth JWT 憑證類型。
- OAuth 2.0 - 授權碼
- 用戶端 ID:Box 為您建立的應用程式提供的用戶端 ID。
- 範圍:權限範圍。例如,
root_readonly。如要瞭解範圍的運作方式,以及查看 Box 的所有可用範圍,請參閱「範圍」。 - 用戶端密鑰: 選取 Secret Manager 密鑰。 設定這項授權前,請務必先建立 Secret Manager 密鑰。
- 密鑰版本: 用戶端密鑰的 Secret Manager 密鑰版本。
-
Box JSON
- Box JSON for JWT Auth:包含 Box 提供 JSON 檔案內容的密碼。
- 密鑰版本:JSON 檔案密鑰的版本。
-
OAuth 2.0 - 用戶端憑證
- OAuth 用戶端 ID:Box 為您建立的應用程式提供的用戶端 ID。
- 用戶端密鑰:Secret Manager 密鑰,內含您所建立應用程式的用戶端密鑰。
- 密鑰版本:用戶端密鑰的版本。
- 主體 ID:應用程式要求委派存取權的使用者主體。
- Box 應用程式存取層級:Box 應用程式的存取層級。
如果是 Authorization code 驗證類型,建立連線後,您必須執行幾個額外步驟來設定驗證。詳情請參閱「建立連線後的其他步驟」。
連線設定範例
本節列出您在建立連線時設定的各個欄位範例值。
OAuth JWT 權杖方法連線類型
| 欄位名稱 | 詳細資料 |
|---|---|
| 位置 | us-central1 |
| 連接器 | Box |
| 連接器版本 | 1 |
| 連線名稱 | box-conn |
| 啟用 Cloud Logging | 是 |
| 服務帳戶 | XXXX@serviceaccount |
| 模擬使用者模式 | 使用者 |
| 節點數量下限 | 2 |
| 節點數量上限 | 2 |
| 驗證 | JWT 驗證 |
| 用戶端 ID | XXXX |
| 用戶端密鑰 | XXXX |
| Secret 版本 | 1 |
| 私密金鑰 | XXXX |
| Secret 版本 | 1 |
| 私密金鑰密碼 | XXXX |
| Secret 版本 | 1 |
| Box 應用程式存取層級 | Enterprise |
| 企業 ID/使用者 ID | XXXX |
| OAuth JWT 公開金鑰 ID | XXXX |
| 驗證方案 | OAuthJWT |
| 啟動 OAuth | GETANDREFRESH |
| OAuth JWT 憑證類型 | PEMKEY_BLOB |
您可以從 Box 帳戶存取用戶端 ID、用戶端密鑰、Box 應用程式存取層級和企業 ID/使用者 ID。
您可以從下載的 Private keypair.json 檔案存取私密金鑰和私密金鑰密碼。詳情請參閱「公開和私密金鑰組資訊」。此外,在傳遞私密金鑰密碼之前,請將 json 檔案中的 \n 換行。
OAuth 授權碼連線類型
| 欄位名稱 | 詳細資料 |
|---|---|
| 位置 | us-central1 |
| 連接器 | Box |
| 連接器版本 | 1 |
| 連線名稱 | box-conn |
| 啟用 Cloud Logging | 是 |
| 服務帳戶 | XXXX@serviceaccount |
| 模擬使用者模式 | 使用者 |
| 授權 | OAuth 2.0 - 授權碼 |
| 節點數量下限 | 2 |
| 節點數量上限 | 2 |
| 用戶端 ID | XXXX |
| 範圍 | root_readwrite |
| 用戶端密鑰 | XXXX |
| Secret 版本 | 1 |
如要瞭解 Box OAuth 設定,請參閱「建立 OAuth 應用程式」。
Box Json,適用於 JWT 驗證方法連線類型
| 欄位名稱 | 詳細資料 |
|---|---|
| 位置 | us-central1 |
| 連接器 | Box |
| 連接器版本 | 1 |
| 連線名稱 | gcp-box-conn-new |
| 啟用 Cloud Logging | 是 |
| 服務帳戶 | XXXX@serviceaccount |
| 模擬使用者模式 | 使用者 |
| 以使用者 ID 劃分 | XXXX |
| 節點數量下限 | 2 |
| 節點數量上限 | 2 |
| 驗證 | Box JSON |
| JWT 驗證的 Box JSON | XXXX |
| Secret 版本 | 1 |
您可以使用 Box 帳戶設定 Box Json,進行 JWT 驗證。如要瞭解如何為 JWT 設定 Box Json,請參閱 JWT 權杖建立步驟 。
從下載的 Private keypair.json 檔案存取 Box Json for JWT 驗證值。詳情請參閱「公開和私密金鑰組資訊」。您必須在「Box Json for JWT Auth」(JWT 驗證的 Box JSON) 欄位中,傳遞 .json 檔案的完整內容。
OAuth 用戶端憑證連線類型
| 欄位名稱 | 詳細資料 |
|---|---|
| 位置 | us-central1 |
| 連接器 | Box |
| 連接器版本 | 1 |
| 連線名稱 | oauth-clientcred-conn |
| 啟用 Cloud Logging | 是 |
| 服務帳戶 | XXXX@serviceaccount |
| 模擬使用者模式 | 使用者 |
| 以使用者 ID 劃分 | XXXX |
| 節點數量下限 | 2 |
| 節點數量上限 | 2 |
| 驗證 | OAuth 用戶端憑證 |
| OAuth 用戶端 ID | XXXX |
| OAuth 用戶端密鑰 | XXXX |
| Secret 版本 | 1 |
| 主題 ID | XXXX |
| Box 應用程式存取層級 | 企業 |
您可以從 Box 帳戶存取用戶端 ID、用戶端密鑰、Box 應用程式存取層級和企業 ID/使用者 ID。
重新授權授權碼
如果您使用 Authorization code 驗證類型,且在 Box 應用程式中進行任何設定變更,則必須重新授權 Box 連線。如要重新授權連結,請按照下列步驟操作:
- 在「連線」頁面中,按一下所需連線。
系統隨即會開啟連線詳細資料頁面。
- 按一下「編輯」即可編輯連結詳細資料。
- 在「Authentication」部分,驗證「OAuth 2.0 - 授權碼」詳細資料。
視需要進行必要變更。
- 按一下 [儲存]。系統會將您導向連線詳細資料頁面。
- 在「驗證」部分中,按一下「編輯授權」。系統會顯示「Authorize」(授權) 窗格。
- 按一下「Authorize」。
建立連結後需執行的其他步驟
如果您選取 OAuth 2.0 - Authorization code 進行驗證,建立連線後必須執行下列額外步驟:
- 在「連線」頁面中,找出新建立的連線。
請注意,新連接器的「狀態」會顯示「需要授權」。
- 按一下「需要授權」。
系統隨即會顯示「編輯授權」窗格。
- 將「重新導向 URI」值複製到外部應用程式。
- 確認授權詳細資料。
- 按一下「Authorize」。
實體、作業和動作
所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化存取應用程式的物件。抽象化會以實體、作業和動作的形式呈現。
- 實體: 實體可以視為已連結應用程式或服務中的物件,或是屬性集合。實體的定義與連接器對連接器不同。舉例來說,在資料庫連接器中,資料表是實體;在檔案伺服器連接器中,資料夾是實體;在訊息系統連接器中,佇列是實體。
不過,連接器可能不支援或沒有任何實體,在這種情況下,
Entities清單會是空白。 - 作業: 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作:
從可用清單中選取實體,系統會產生該實體可用的作業清單。如需作業的詳細說明,請參閱連線器工作中的實體作業。 不過,如果連接器不支援任何實體作業,
Operations清單就不會列出這類不支援的作業。 - 動作: 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體,且因連接器而異。一般來說,動作會有一些輸入參數和輸出參數。不過,連接器可能不支援任何動作,此時
Actions清單會是空白。
動作
本節列出 Box 連線支援的所有動作。
DownloadFile 動作
這項操作可讓您從 Box 執行個體下載檔案。
DownloadFile 動作的輸入參數
| 參數名稱 | 資料類型 | 必填 | 說明 |
|---|---|---|---|
| FileID | 字串 | 是 | 要下載的檔案 ID。 |
| HasBytes | 布林值 | 是 | 指定是否要將檔案下載為字串或 Base64 編碼字串。 |
DownloadFile 動作的輸出參數
這項動作會傳回狀態 200 (OK),以及指出結果的回應主體。
| 參數名稱 | 資料類型 | 說明 |
|---|---|---|
| 成功 | 字串 | 指出檔案是否下載成功。 |
| ContentBytes | 字串 | 檔案內容 (Base64 編碼字串)。 |
如要瞭解如何設定 DownloadFile 動作,請參閱動作範例。
UploadFile 動作
這項動作可讓你將檔案上傳至 Box 執行個體。
UploadFile 動作的輸入參數
| 參數名稱 | 資料類型 | 必填 | 說明 |
|---|---|---|---|
| ParentID | 字串 | 是 | 要上傳檔案的資料夾 ID。如果未指定這個參數,檔案會上傳至 Box 帳戶的根目錄。預設值為 0。 |
| 內容 | 字串 | 是 | 要上傳的檔案內容。 |
UploadFile 動作的輸出參數
這項動作會傳回狀態 200 (OK),以及指出結果的回應主體。
| 參數名稱 | 資料類型 | 說明 |
|---|---|---|
| 成功 | 字串 | 指出檔案是否上傳成功。 |
| ID | 字串 | 新建立的檔案 ID。 |
| VersionID | 字串 | 檔案特定版本的 ID。 |
| 雜湊 | 字串 | 檔案的 SHA1 雜湊。 |
| ETag | 字串 | 檔案或資料夾的 Etag 值。預設值為 0。 |
如要瞭解如何設定 UploadFile 動作,請參閱動作範例。
CopyFile 動作
這項操作可讓您從 Box 執行個體複製檔案。
CopyFile 動作的輸入參數
| 參數名稱 | 資料類型 | 必填 | 說明 |
|---|---|---|---|
| FileID | 字串 | 是 | 要複製的檔案 ID。 |
| DestinationFolderId | 字串 | 否 | 要複製檔案的目標資料夾 ID。如未指定任何值,系統會複製檔案的最新版本。 |
| NewName | 字串 | 是 | 複製檔案的新檔案名稱。 |
CopyFile 動作的輸出參數
這項動作會傳回狀態 200 (OK),以及指出結果的回應主體。
| 參數名稱 | 資料類型 | 說明 |
|---|---|---|
| 成功 | 字串 | 指出檔案是否成功複製。 |
| ID | 字串 | 複製檔案的 ID。 |
如要瞭解如何設定 CopyFile 動作,請參閱動作範例。
CopyFolder 動作
這項操作可讓你從 Box 執行個體複製整個資料夾。
CopyFolder 動作的輸入參數
| 參數名稱 | 資料類型 | 必填 | 說明 |
|---|---|---|---|
| FolderID | 字串 | 是 | 要複製的資料夾 ID。 |
| DestinationFolderId | 字串 | 是 | 要複製資料夾的目標資料夾 ID。 |
| NewName | 字串 | 否 | 複製資料夾的新檔案名稱。 |
CopyFolder 動作的輸出參數
這項動作會傳回狀態 200 (OK),以及指出結果的回應主體。
| 參數名稱 | 資料類型 | 說明 |
|---|---|---|
| 成功 | 字串 | 指出資料夾是否成功複製。 |
| ID | 字串 | 複製的資料夾 ID。 |
如要瞭解如何設定 CopyFolder 動作,請參閱動作範例。
動作範例
本節說明如何在這個連接器中執行部分動作。
範例 - 下載檔案
- 在
Configure connector task對話方塊中,按一下Actions。 - 選取「
DownloadFile」動作,然後按一下「完成」。 - 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "FileID": "1283194869422", "HasBytes": true }
這個範例會將檔案下載為 Base64 編碼字串。如果動作成功,連接器工作的回應參數 connectorOutputPayload 會包含類似下列的值:
[ { "Success": "True"}, {"ContentBytes": "JVBERi0xLjQKJcfl9OXwCjIgMCBvYmoKJSBbMjRdIAo8PAovRmlsdGVy"} ]
範例 - 上傳檔案
- 在
Configure connector task對話方塊中,按一下Actions。 - 選取「
UploadFile」動作,然後按一下「完成」。 - 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "ParentId": "0", "Content": "12345" }
這個範例會將字串內容上傳為檔案。如果動作成功,連接器工作的回應參數 connectorOutputPayload 會包含類似下列的值:
[{ "Success": "true", "ID": "1283902965389", "VersionID": "1403546001389", "Hash": "8cb2237d0679ca88db6464eac60da96345513964", "Etag": "0" }]
範例 - 複製檔案
- 在
Configure connector task對話方塊中,按一下Actions。 - 選取「
CopyFile」動作,然後按一下「完成」。 - 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "FileID": "1288751886061", "DestinationFolderId": "219105724517", "NewName": "NewCopiedFile" }
這個範例會將 ID 為 1288751886061 的檔案複製到 ID 為 219105724517 的資料夾。如果動作成功,連接器工作 connectorOutputPayload 回應參數的值會類似以下內容:
[{ "Success": "true", "ID": "1308006018536" }]
範例 - 複製資料夾
- 在
Configure connector task對話方塊中,按一下Actions。 - 選取「
CopyFolder」動作,然後按一下「完成」。 - 在 「Connectors」(連結器) 任務的 「Task Input」(任務輸入內容) 區段中,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "FolderID": "218475301279", "DestinationFolderId": "0", "NewName": "NewCopiedFolder" }
這個範例會將 ID 為 218475301279 的資料夾複製到 ID 為 219105724517 的資料夾。如果動作成功,連接器工作的回應參數 connectorOutputPayload 會包含類似下列的值:
[{ "Success": "true", "ID": "226312444517" }]
實體作業範例
範例 - 列出所有檔案
- 在
Configure connector task對話方塊中,按一下Entities。 - 從
Entity清單中選取「檔案」。 - 選取
LIST作業,然後按一下「完成」。
您可以對下列實體執行 LIST 作業:資料夾、已刪除項目、共用項目、協作、工作指派和工作
範例 - 取得檔案
- 在
Configure connector task對話方塊中,按一下Entities。 - 從
Entity清單中選取「檔案」。 - 選取
GET作業,然後按一下「完成」。 - 將實體 ID 設為 1262397830475,也就是要傳遞的鍵。如要設定實體 ID,請在
「Connectors」(連結器) 工作的「Task Input」(工作輸入) 部分中,按一下「EntityId」(實體 ID),然後
在「Default Value」(預設值) 欄位中輸入
1262397830475。
實體 ID 的值必須直接傳遞,例如 1262397830475。其中 1262397830475 是不重複的主鍵值。
您可以對下列實體執行 GET 作業:資料夾、SharedItems、Collaborations、TaskAssignments 和 Tasks
範例 - 刪除檔案
- 在
Configure connector task對話方塊中,按一下Entities。 - 從
Entity清單中選取「檔案」。 - 選取
DELETE作業,然後按一下「完成」。 - 將實體 ID 設為 1258725940971,也就是要傳遞的金鑰。如要設定實體 ID,請在
「Connectors」(連結器) 工作的「Task Input」(工作輸入) 部分中,按一下「EntityId」(實體 ID),然後
在「Default Value」(預設值) 欄位中輸入
1258725940971。或者,如果 Entity 有兩個複合商家或主要鍵,而非指定 entityId,您也可以將 filterClause 設為
Id='1258725940971'。
您可以對下列實體執行 DELETE 作業:資料夾、工作、協作、共用項目和工作指派
範例 - 建立資料夾
- 在
Configure connector task對話方塊中,按一下Entities。 - 從
Entity清單中選取「資料夾」。 - 選取
Create作業,然後按一下「完成」。 - 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "Name": "Google Cloud Platforms_created_folders", "ParentId": "0" }
如果整合成功,
Folder工作的connectorOutputPayload回應參數值會類似於下列內容:{ "Id": "222269371053" }
範例 - 建立協作活動
- 在
Configure connector task對話方塊中,按一下Entities。 - 從
Entity清單中選取「協作」。 - 選取
Create作業,然後按一下「完成」。 - 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "ItemId": "216592737829", "ItemType": "folder", "AccessibleById": "27370766275", "AccessibleByType": "user", "AccessibleByLogin": "baklavainthebalkans@gmail.com", "Role": "editor" }
如果整合成功,
Folder工作的connectorOutputPayload回應參數值會類似以下內容:{ "Success": false }
範例 - 建立工作
- 在
Configure connector task對話方塊中,按一下Entities。 - 從
Entity清單中選取「工作」。 - 選取
Create作業,然後按一下「完成」。 - 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "ItemId": "1253997361112", "ItemType": "file", "Action": "review", "Message": "Creating a task from Google Cloud Platform", "DueAt": "2023-12-12 09:01:15.0", "CompletionRule": "all_assignees" }
如果整合成功,
Folder工作的connectorOutputPayload回應參數值會類似於下列內容:{ "Id": "1253997361112" }
範例 - 建立工作指派
- 在
Configure connector task對話方塊中,按一下Entities。 - 從
Entity清單中選取 TaskAssignments。 - 選取
Create作業,然後按一下「完成」。 - 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "TaskId": "21507516872", "AssignedToId": "27370766275" }
如果整合成功,
Folder工作的connectorOutputPayload回應參數值會類似於下列內容:{ "Id": "50804351753" }
範例 - 更新檔案
- 在
Configure connector task對話方塊中,按一下Entities。 - 從
Entity清單中選取「檔案」。 - 選取
Update作業,然後按一下「完成」。 - 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "Name": "Get Started with Box Files.pdf" }
- 將實體 ID 設為 1253997361112。如要設定實體 ID,請按一下「entityId」,然後在「Default Value」(預設值) 欄位中輸入
1253997361112。或者,您也可以將 filterClause 設為
1253997361112,而非指定 entityId。執行這個範例後,Connector 工作的
connectorOutputPayload輸出變數會傳回類似下列內容的回應:{ "Id": "1253997361112" }
您可以對下列實體執行 UPDATE 作業:資料夾、工作、協作、共用項目和工作指派
範例 - 更新資料夾
- 在
Configure connector task對話方塊中,按一下Entities。 - 從
Entity清單中選取「資料夾」。 - 選取
Update作業,然後按一下「完成」。 - 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "Name": "Demo Update" }
- 將實體 ID 設為 216457668125。如要設定實體 ID,請按一下「entityId」,然後在「Default Value」(預設值) 欄位中輸入
216457668125。或者,您也可以將 filterClause 設為
216457668125,而非指定 entityId。執行這個範例後,Connector 工作的
connectorOutputPayload輸出變數會傳回類似下列內容的回應:{ "Id": "216457668125" }
範例 - 更新協作活動
- 在
Configure connector task對話方塊中,按一下Entities。 - 從
Entity清單中選取「協作」。 - 選取
Update作業,然後按一下「完成」。 - 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "Role": "Viewer" }
- 將實體 ID 設為 46685648757。如要設定實體 ID,請按一下「entityId」,然後在「Default Value」(預設值) 欄位中輸入
46685648757。或者,您也可以將 filterClause 設為
46685648757,而非指定 entityId。執行這個範例後,Connector 工作的
connectorOutputPayload輸出變數會傳回類似下列內容的回應:{ }
範例 - 更新工作
- 在
Configure connector task對話方塊中,按一下Entities。 - 從
Entity清單中選取「工作」。 - 選取
Update作業,然後按一下「完成」。 - 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "Message": "This is a new task is updated and assigned to you by me" }
- 將實體 ID 設為 21507516872。如要設定實體 ID,請按一下「entityId」,然後在「Default Value」(預設值) 欄位中輸入
21507516872。或者,您也可以將 filterClause 設為
21507516872,而非指定 entityId。執行這個範例後,Connector 工作的
connectorOutputPayload輸出變數會傳回類似下列內容的回應:{ "Id": "21507516872" }
範例 - 更新工作指派
- 在
Configure connector task對話方塊中,按一下Entities。 - 從
Entity清單中選取 TaskAssignments。 - 選取
Update作業,然後按一下「完成」。 - 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "Message": "Looks good to me", "ResolutionState": "completed" }
- 將實體 ID 設為 49542929469。如要設定實體 ID,請按一下「entityId」,然後在「Default Value」(預設值) 欄位中輸入
49542929469。或者,您也可以將 filterClause 設為
49542929469,而非指定 entityId。執行這個範例後,Connector 工作的
connectorOutputPayload輸出變數會傳回類似下列內容的回應:{ "Id": "49542929469" }
範例 - 更新 Transferfolders
- 在
Configure connector task對話方塊中,按一下Entities。 - 從
Entity清單中選取「資料夾」。 - 選取
Update作業,然後按一下「完成」。 - 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "Name": "Demo Update" "ParentId": "216596059374" }
- 將實體 ID 設為 216457668125。如要設定實體 ID,請按一下「entityId」,然後在「Default Value」(預設值) 欄位中輸入
216457668125。執行這個範例後,Connector 工作的
connectorOutputPayload輸出變數會傳回類似下列內容的回應:{ "Id": "216457668125" }
使用 Terraform 建立連線
您可以使用 Terraform 資源建立新連線。
如要瞭解如何套用或移除 Terraform 設定,請參閱「基本 Terraform 指令」。
如要查看用於建立連線的 Terraform 範本範例,請參閱範本範例。
使用 Terraform 建立這項連線時,您必須在 Terraform 設定檔中設定下列變數:
| 參數名稱 | 資料類型 | 必填 | 說明 |
|---|---|---|---|
| impersonate_user_mode | ENUM | 是 | 指定使用者身分模擬類型。應為「使用者模式」或「管理員模式」。支援的值為:User、Admin |
| proxy_enabled | BOOLEAN | 否 | 選取這個核取方塊,即可為連線設定 Proxy 伺服器。 |
| proxy_auth_scheme | ENUM | 否 | 用來向 ProxyServer 代理伺服器驗證的驗證類型。支援的值包括:BASIC、DIGEST、NONE |
| proxy_user | STRING | 否 | 用於向 ProxyServer 代理程式驗證的使用者名稱。 |
| proxy_password | SECRET | 否 | 用於向 ProxyServer Proxy 驗證身分的密碼。 |
| proxy_ssltype | ENUM | 否 | 連線至 ProxyServer Proxy 時要使用的 SSL 類型,支援的值包括:AUTO、ALWAYS、NEVER、TUNNEL |
在整合服務中使用 Box 連線
建立連線後,Apigee Integration 和 Application Integration 都會提供該連線。您可以在整合中透過「連接器」工作使用連線。
- 如要瞭解如何在 Apigee Integration 中建立及使用連接器工作,請參閱「連接器工作」。
- 如要瞭解如何在 Application Integration 中建立及使用連接器工作,請參閱「連接器工作」。