Box

連線設定範例

本節列出建立連線時設定的各個欄位範例值。

OAuth JWT 權杖方法連線類型

您可以從 Box 帳戶存取用戶端 ID、用戶端密鑰、Box 應用程式存取層級和企業 ID/使用者 ID。

您可以從下載的 Private keypair.json 檔案存取私密金鑰和私密金鑰密碼。詳情請參閱「公開和私密金鑰組資訊」。此外，在傳遞私密金鑰密碼之前，請將 json 檔案中的 \n 換行。

OAuth 授權碼連線類型

如要瞭解 Box OAuth 設定，請參閱「建立 OAuth 應用程式」。

Box Json，適用於 JWT 驗證方法連線類型

您可以使用 Box 帳戶設定 Box Json，進行 JWT 驗證。如要瞭解如何為 JWT 設定 Box Json，請參閱 建立 JWT 權杖的步驟

從您下載的 Private keypair.json 檔案存取 Box Json for JWT 驗證值。詳情請參閱「公開和私密金鑰組資訊」。您必須在「Box Json for JWT Auth」欄位中，傳遞 .json 檔案的完整內容。

OAuth 用戶端憑證連線類型

您可以從 Box 帳戶存取用戶端 ID、用戶端密鑰、Box 應用程式存取層級和企業 ID/使用者 ID。

實體、作業和動作

所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化程序存取應用程式的物件。抽象化會以實體、作業和動作的形式呈現。

• 實體： 實體可以視為已連結應用程式或服務中的物件，或是屬性集合。實體的定義因連接器而異。舉例來說，在資料庫連接器中，資料表是實體；在檔案伺服器連接器中，資料夾是實體；在訊息系統連接器中，佇列是實體。

  不過，連接器可能不支援或沒有任何實體，在這種情況下，Entities 清單會是空白。

• 作業： 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作：
  • 列出
  • 取得
  • 建立
  • 更新
  • 刪除

  從可用清單中選取實體，系統會產生該實體可用的作業清單。如需作業的詳細說明，請參閱 Connectors 工作的實體作業。 不過，如果連接器不支援任何實體作業，系統就不會在 Operations 清單中列出這些不支援的作業。

• 動作： 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體，且因連接器而異。一般來說，動作會有一些輸入參數和輸出參數。不過，連接器可能不支援任何動作，此時 Actions 清單會是空白。

動作

本節列出 Box 連線支援的所有動作。

DownloadFile 動作

這項動作可讓您從 Box 執行個體下載檔案。

DownloadFile 動作的輸入參數

DownloadFile 動作的輸出參數

這項動作會傳回狀態 200 (OK)，以及指出結果的回應內文。

如要瞭解如何設定 DownloadFile 動作，請參閱動作範例。

UploadFile 動作

這個動作可讓你將檔案上傳至 Box 執行個體。

UploadFile 動作的輸入參數

UploadFile 動作的輸出參數

這項動作會傳回狀態 200 (OK)，以及指出結果的回應內文。

如要瞭解如何設定 UploadFile 動作，請參閱動作範例。

CopyFile 動作

這項動作可讓您從 Box 執行個體複製檔案。

CopyFile 動作的輸入參數

CopyFile 動作的輸出參數

這項動作會傳回狀態 200 (OK)，以及指出結果的回應內文。

如要瞭解如何設定 CopyFile 動作，請參閱動作範例。

CopyFolder 動作

這項操作可讓你從 Box 執行個體複製整個資料夾。

CopyFolder 動作的輸入參數

CopyFolder 動作的輸出參數

這項動作會傳回狀態 200 (OK)，以及指出結果的回應內文。

如要瞭解如何設定 CopyFolder 動作，請參閱動作範例。

動作範例

本節說明如何在這個連接器中執行部分動作。

範例 - 下載檔案

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 DownloadFile 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "FileID": "1283194869422", 
   "HasBytes": true
   }

這個範例會將檔案下載為 Base64 編碼的字串。如果動作成功，連接器工作 connectorOutputPayload 回應參數的值會類似以下內容：

[
{ "Success": "True"},
{"ContentBytes": "JVBERi0xLjQKJcfl9OXwCjIgMCBvYmoKJSBbMjRdIAo8PAovRmlsdGVy"}
]

範例 - 上傳檔案

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 UploadFile 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "ParentId": "0",
   "Content": "12345"
   }

這個範例會將字串內容上傳為檔案。如果動作成功，連接器工作 connectorOutputPayload 回應參數的值會類似以下內容：

[{
"Success": "true",
"ID": "1283902965389",
"VersionID": "1403546001389",
"Hash": "8cb2237d0679ca88db6464eac60da96345513964",
"Etag": "0"
}]

範例 - 複製檔案

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 CopyFile 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "FileID": "1288751886061",
   "DestinationFolderId": "219105724517", 
   "NewName": "NewCopiedFile"
   }

這個範例會將 ID 為 1288751886061 的檔案複製到 ID 為 219105724517 的資料夾。如果動作成功，連接器工作 connectorOutputPayload 回應參數的值會類似以下內容：

[{
"Success": "true",
"ID": "1308006018536"
}]

範例 - 複製資料夾

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 CopyFolder 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "FolderID": "218475301279",
   "DestinationFolderId": "0", 
   "NewName": "NewCopiedFolder"
   }

這個範例會將 ID 為 218475301279 的資料夾複製到 ID 為 219105724517 的資料夾。如果動作成功，連接器工作的回應參數 connectorOutputPayload 會包含類似下列的值：

[{
"Success": "true",
"ID": "226312444517"
}]

實體作業範例

範例 - 列出所有檔案

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「檔案」。
3. 選取「LIST」作業，然後按一下「完成」。

您可以對下列實體執行 LIST 作業：資料夾、已刪除項目、共用項目、協作、工作指派和工作

範例 - 取得檔案

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「檔案」。
3. 選取「GET」作業，然後按一下「完成」。
4. 將實體 ID 設為 1262397830475，也就是要傳遞的鍵。如要設定實體 ID，請在「Connectors」(連結器) 任務的「Task Input」(工作輸入) 部分中，按一下「EntityId」(實體 ID)，然後在「Default Value」(預設值) 欄位中輸入 1262397830475。

實體 ID 的值必須直接傳遞，例如 1262397830475。其中 1262397830475 是不重複的主鍵值。

您可以對下列實體執行 GET 作業：資料夾、SharedItems、協作、TaskAssignments 和工作

範例 - 刪除檔案

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「檔案」。
3. 選取「DELETE」作業，然後按一下「完成」。
4. 將實體 ID 設為 1258725940971，也就是要傳遞的鍵。如要設定實體 ID，請在「Connectors」(連結器) 任務的「Task Input」(工作輸入) 部分中，按一下「EntityId」(實體 ID)，然後在「Default Value」(預設值) 欄位中輸入 1258725940971。

   或者，如果實體有兩個複合商家或主要鍵，而非指定 entityId，您也可以將 filterClause 設為 Id='1258725940971'。

您可以對下列實體執行 DELETE 作業：資料夾、工作、協作、共用項目和工作指派

範例 - 建立資料夾

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「資料夾」。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "Name": "Google Cloud Platforms_created_folders",
   "ParentId": "0"
   }

   如果整合成功，Folder 工作的 connectorOutputPayload 回應參數值會類似以下內容：

    
   {
   "Id": "222269371053"
   } 

範例 - 建立協作活動

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「協作」。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "ItemId": "216592737829",
   "ItemType": "folder",
   "AccessibleById": "27370766275",
   "AccessibleByType": "user",
   "AccessibleByLogin": "baklavainthebalkans@gmail.com",
   "Role": "editor"
   }

   如果整合成功，Folder 工作的 connectorOutputPayload 回應參數值會類似以下內容：

   {
   "Success": false
   } 

範例 - 建立工作

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「工作」。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「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"
   }

範例 - 建立工作指派

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 TaskAssignments。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "TaskId": "21507516872",
   "AssignedToId": "27370766275"
   }

   如果整合成功，Folder 工作的 connectorOutputPayload 回應參數值會類似以下內容：

    
   {
   "Id": "50804351753"
   }

範例 - 更新檔案

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「檔案」。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "Name": "Get Started with Box Files.pdf"
   }

5. 將實體 ID 設為 1253997361112。如要設定實體 ID，請按一下 entityId，然後在「Default Value」(預設值) 欄位中輸入 1253997361112。

   或者，您也可以將 filterClause 設為 1253997361112，而非指定 entityId。

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
   "Id": "1253997361112"
   }

您可以對下列實體執行 UPDATE 作業：資料夾、工作、協作、共用項目和工作指派

範例 - 更新資料夾

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「資料夾」。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "Name": "Demo Update"
   }

5. 將實體 ID 設為 216457668125。如要設定實體 ID，請按一下 entityId，然後在「Default Value」(預設值) 欄位中輸入 216457668125。

   或者，您也可以將 filterClause 設為 216457668125，而非指定 entityId。

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
   "Id": "216457668125"
   } 

範例 - 更新協作活動

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「協作」。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "Role": "Viewer"
   }

5. 將實體 ID 設為 46685648757。如要設定實體 ID，請按一下 entityId，然後在「Default Value」(預設值) 欄位中輸入 46685648757。

   或者，您也可以將 filterClause 設為 46685648757，而非指定 entityId。

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
   
   }

範例 - 更新工作

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「工作」。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "Message": "This is a new task is updated and assigned to you by me"
   }

5. 將實體 ID 設為 21507516872。如要設定實體 ID，請按一下 entityId，然後在「Default Value」(預設值) 欄位中輸入 21507516872。

   或者，您也可以將 filterClause 設為 21507516872，而非指定 entityId。

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
   "Id": "21507516872"
   }

範例 - 更新工作指派

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 TaskAssignments。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "Message": "Looks good to me",
   "ResolutionState": "completed"
   }

5. 將實體 ID 設為 49542929469。如要設定實體 ID，請按一下 entityId，然後在「Default Value」(預設值) 欄位中輸入 49542929469。

   或者，您也可以將 filterClause 設為 49542929469，而非指定 entityId。

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
   "Id": "49542929469"
   } 

範例 - 更新 Transferfolders

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「資料夾」。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "Name": "Demo Update"
   "ParentId": "216596059374"
   }

5. 將實體 ID 設為 216457668125。如要設定實體 ID，請按一下 entityId，然後在「Default Value」(預設值) 欄位中輸入 216457668125。

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
   "Id": "216457668125"
   }