DocuSign

連線設定範例

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

OAUTH 2.0 - 授權碼連線類型

OAuth 2.0 - JWT 不記名憑證連線類型

實體、作業和動作

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

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

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

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

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

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

動作

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

CreateAndSendEnvelope 動作

建立及傳送信封，或建立信封草稿。

CreateAndSendEnvelope 動作的輸入參數

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

動作範例

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

範例 - CreateAndSendEnvelope

這項動作會建立並傳送信封，或建立信封草稿。

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

   {
   "EmailSubject": "Please Sign this Document",
   "FileName": "test.txt\ntest.pdf",
   "SignersEmail": "cloudysanfrancisco@gmail.com",
   "SignersRecipientId": "53386460",
   "CcRecipientId": "67173451",
   "CcEmail": "baklavainthebalkans@gmail.com",
   "DocumentId": "1",
   "Status": "sent",
   "CustomFieldAggregate": "CustomFieldName",
   "ContentBytes": "abcd***",
   "HasBytes": true,
   "SignersName": "\"test\"",
   "CcName": "\"test\"",
   "Content": "test content in file"
   }
   

如果動作成功，連接器工作 connectorOutputPayload 回應參數的值會類似於下列內容：

 [{
"Success":"true",
"envelopeid":"542a77ff-b533-4b39-9d82-e397ef5a70c9",
"uri":"/envelopes/542a77ff-b533-4b39-9d82-e397ef5a70c9",
"statusdatetime":"2025-04-09T12:33:47.1130000Z",
"status":"sent",
"customfieldaggregate": "CustomFieldName"
}]

實體作業範例

本節說明如何使用這個連接器執行部分實體作業。

實體 ID 的值應直接傳遞，例如 16ab549b-95d7-47cb-b557-c2476ef62d9d。ID 16ab549b-95d7-47cb-b557-c2476ef62d9d 是必須傳遞的唯一主鍵值。

範例 - 實體「帳戶」的 LIST 作業

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「帳戶」。
3. 選取「LIST」作業，然後按一下「完成」。
4. 在「連線器」工作的「工作輸入」部分，您可以根據需求設定 filterClause。

範例 - 實體「文件」的 LIST 作業

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「文件」。
3. 選取「LIST」作業，然後按一下「完成」。
4. 在「連線器」工作的「工作輸入」部分，您可以根據需求設定 filterClause。

範例 - 實體「信封」的 LIST 作業

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「信封」。
3. 選取「LIST」作業，然後按一下「完成」。
4. 在「連線器」工作的「工作輸入」部分，您可以根據需求設定 filterClause。

範例 - 實體「Folders」的 LIST 作業

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「資料夾」。
3. 選取「LIST」作業，然後按一下「完成」。
4. 在「連線器」工作的「工作輸入」部分，您可以根據需求設定 filterClause。

範例 - 實體「群組」的 LIST 作業

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「群組」。
3. 選取「LIST」作業，然後按一下「完成」。
4. 在「連線器」工作的「工作輸入」部分，您可以根據需求設定 filterClause。

範例 - 實體「Users」的 LIST 作業

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「使用者」。
3. 選取「LIST」作業，然後按一下「完成」。
4. 在「連線器」工作的「工作輸入」部分，您可以根據需求設定 filterClause。

您也可以對下列實體執行 LIST 作業：

• UserInfo
• UserSignatures
• 工作區
• 收件者
• AccountBrands
• AccountCustomFields
• EnvelopeTemplates
• EnvelopeAttachments
• EnvelopeConsumerDisclosures
• CloudStorageProviders
• CustomTabs
• 門鎖
• GroupBrands
• GroupUsers
• PowerForms
• RecipientTabs
• SigningGroups
• SigningGroupUsers
• 範本

範例 - 取得「帳戶」實體的單一記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「帳戶」。
3. 選取「GET」作業，然後按一下「完成」。
4. 如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 2.4578824E7，並選擇 EntityId 做為本機變數。

範例 - 取得「文件」實體的單一記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「文件」。
3. 選取「LIST」作業，然後按一下「完成」。
4. 如要設定篩選子句，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 Type='envelopes' AND Id='8e18be14-3254-4cbe-947d-f0d1cd62f5f8'，並選擇篩選子句做為本機變數。

範例 - 取得「信封」實體的單一記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「信封」。
3. 選取「GET」作業，然後按一下「完成」。
4. 如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 8e18be14-3254-4cbe-947d-f0d1cd62f5f87，並選擇 EntityId 做為本機變數。

範例 - 取得「Folders」實體的單一記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「資料夾」。
3. 選取「GET」作業，然後按一下「完成」。
4. 如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 05f76d13-a513-492b-8c58-176702768db0，並選擇 EntityId 做為本機變數。

範例 - 取得「群組」實體的單一記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「群組」。
3. 選取「GET」作業，然後按一下「完成」。
4. 如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 1.4167231E7，並選擇 EntityId 做為本機變數。

範例 - 取得「使用者」實體的單一記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「使用者」。
3. 選取「GET」作業，然後按一下「完成」。
4. 如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 16ab549b-95d7-47cb-b557-c2476ef62d9d，並選擇 EntityId 做為本機變數。

您也可以對下列實體執行 GET 作業：

• UserInfo
• UserSignatures
• 工作區
• 收件者
• AccountBrands
• AccountCustomFields
• EnvelopeTemplates
• EnvelopeAttachments
• EnvelopeConsumerDisclosures
• CloudStorageProviders
• CustomTabs
• 門鎖
• GroupBrands
• GroupUsers
• RecipientTabs
• SigningGroups
• SigningGroupUsers
• 範本