Oodrive Sign （預覽版）

通過您的工作流程連接和使用 Oodrive sign 的服務。

此連接器適用於以下產品和區域：

服務	Class	Regions
副駕駛工作室	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
邏輯應用程式	標準	所有 Logic Apps 區域，但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部（DoD）
Power Apps	進階	除下列區域外的所有 Power Apps 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
Power Automate（自動化服務）	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）

連絡人
名稱	Oodrive 標誌
URL	https://www.oodrive.com/products/oodrive-sign/
Email	support-sign@oodrive.com

連接器中繼資料
Publisher	Oodrive 標誌
網站	https://www.oodrive.com/products/oodrive-sign/
隱私策略	https://www.oodrive.com/privacy-policy/
類別	IT運營;生產力

Oodrive Sign 的連接器允許您自動執行任務並輕鬆管理有關電子簽名生態系統的流程。例如，可以設計自動化工作流程，例如，透過範本建立新合約、自動新增收件者並傳送合約以供簽署。您還可以管理所有捆綁包、收件人、關鍵參數等。它為客戶提供了減少在所有簽名過程後進行手動操作的時間的可能性。 Web 應用程式中可用的所有功能都可以使用連接器在 Power Automate 中重現。

先決條件

您需要一個具有 Oodrive Sign 服務付費計劃的帳戶。

如何取得認證

您還需要獲取您的 API 令牌，可以向支持服務詢問，也可以在您的歡迎電子郵件中檢索它，該電子郵件在您申請 Sign 服務時已發送到您的郵箱。

Note: If you are a employee, you can get the token by contacting your IT service.

開始使用連接器

若要開始使用連接器，您必須先使用 Power Platform 帳戶開啟 Power Automate 。

Note: you'll need to be premium on Power Automate in order to use the connector.

請依照下列步驟建立新的工作流程，並使用我們的聯結器：

在您的 Power Automate 環境中，按一下 [建立] 索引標籤。
視需要選擇「自動化雲端流程」或「即時雲端流程」。
為您的新工作流程命名，並選擇適合您需求的觸發器。您可以使用 Oodrive Sign 之一。
通過從中添加操作來開始使用連接器，只需在目錄中搜索“Oodrive Sign”即可。
當您第一次從連接器新增動作或觸發程式時，Power Automate 會要求您連線到您的環境：您將使用我們提供的 API 權杖。
然後，點擊連接：一切都已完成，您可以使用連接器中任意數量的操作。

已知問題與限制

對於 Oodrive Sign 的問題，請聯絡支援服務。

常見錯誤和補救措施

HTTP 錯誤 404

通常，當您收到 Oodrive Sign 的錯誤 404 時，它會告訴您您嘗試查找的資源在您的環境中不存在。通常，這可能是為特定合約或特定收件者提供的 ID 錯誤，該錯誤不存在。若要解決此問題，請嘗試使用您嘗試取得的資源的已知 ID 的動作。

HTTP 錯誤 501

HTTP 錯誤 501 表示 Oodrive Sign 的服務無法很好地識別您的需求，或者您向服務傳遞了錯誤類型的資料。請嘗試閱讀 Sign 的檔案，以調查您傳遞給動作或觸發程式的資料。

FAQ

1. 如何將文件上傳到特定合約？

使用「上傳文件並將其附加到合約」操作，您可以輕鬆上傳遠端儲存的 pdf 檔案。

第一步需要獲取要上傳的文件的內容。您可以使用許多連接器來獲取它。例如，您可以使用 SharePoint 連接器的「取得檔案內容」動作來擷取檔案內容。

取得您要上傳為特定合約文件的檔案內容。在此範例中，我們使用 SharePoint Online 連接器的動作「取得檔案內容」。
然後，新增「撰寫」動作。使用動作「取得檔案內容」的輸出內文作為撰寫的輸入。
從 Oodrive Sign 連接器新增名為「上傳文件並將其新增至合約」的動作。
- 在輸入的「合約 ID」中，指定您要附加文件的合約 ID。
- 在輸入的「檔案」中，插入上一個「撰寫」動作的輸出
- 在輸入的「檔案（檔案名稱）」中，插入將要上傳的文件的名稱。
您已完成上傳文件！

2. 我可以看到環境中的所有合約嗎？

如果您的權杖是「管理員」權杖，則是的。否則，您只會檢視您正常存取的合約。

3. 我對連接器有一個建議。我可以在哪裡提交？

您可以聯絡支援服務，提交有關連接器的任何建議。我們將非常感謝您的貢獻！

正在建立連線

連接器支援下列驗證類型：


預設值	建立連線的參數。	所有區域	不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱	類型	Description	為必填項目
API 金鑰	securestring	此 API 的 API 金鑰	對

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	100	60 秒

動作

上傳文件並將其附加到合約中	將文件上傳至環境，並將其附加至特定合約。
上傳附件並將其新增至合約	將新的附件上傳至環境，並將其附加至特定合約。
下載合約文件	擷取包含合約中所有文件的 PDF 檔案。
下載合約的已簽署文件	從合約的簽署文件中擷取 pdf 檔案。
下載合約的校訂檔	下載合約的校訂檔案。
停止合約的交易	停止合約的交易，以便您可以修改合約文件和/或簽署人。
停止配套交易	停止套件組合交易。
傳送套件組合以供簽署	發送捆綁包以供簽名。
列出合約文件	擷取繫結至合約的所有文件。
列出合約的收件者	擷取特定合約的所有收件者。
列出套件組合的合約	從特定捆綁包中擷取所有合約。
列出所有周邊	擷取與連線環境相關聯的所有周邊。
列出所有收件者	擷取與目前授權相關聯的所有收件者。
刪除合約的收件者	從合約中刪除收件者，由合約識別碼的收件者。相關資訊請參閱文件。
取得合約狀態	檢查特定合約的狀態。
取得合約的簽署	列出特定合約中的所有簽名資訊。
取得所有合約的清單	從相關聯的授權擷取所有合約。
取得特定合約	擷取特定合約的中繼資料。
取得特定收件者	在目前環境的已儲存收件者清單中擷取特定收件者。
將合約新增至套件組合	將現有合約新增至現有的 Bundle。
將收件者新增至合約	將現有收件者附加至合約。
將通知電子郵件重新傳送給所有收件者	傳送通知電子郵件給特定合約的所有收件者。
建立合約	在環境中建立新合約。
建立合約並傳送以供簽署	一站式操作。建立合約、新增收件者、文件，並將其傳送給收件者以供簽署。
建立套件組合	建立至少具有一個現有合約的新捆綁包。
提取捆綁包	將所有合約撤回成捆。
撤回合約	將合約的狀態設定為 ABANDONED，即使合約已傳送以供簽署也一樣。
發送要簽署的合約	發送一份特定的合同和所有文件，由收件人簽署。
重新傳送通知電子郵件給收件者	傳送通知電子郵件給合約的特定收件者。
驗證合約	驗證（會簽）合約。
驗證套件組合中的合約	會簽（驗證）捆綁中的所有合約。

上傳文件並將其附加到合約中

作業識別碼：: UploadDocumentAndAttachToContract

將文件上傳至環境，並將其附加至特定合約。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	string	要附加新文件的合約 ID。
檔案	file		file	要上傳的檔案二進位檔。

傳回

response: array of DocumentAdded

上傳附件並將其新增至合約

作業識別碼：: UploadAttachmentAndAddToContract

將新的附件上傳至環境，並將其附加至特定合約。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	string	要新增附件的合約識別碼。
合約定義識別碼	contract_definition_id		integer	在您的環境中定義的合約定義識別碼。預設值為 pdfadhoc。
選項定義名稱	option_definition_name		string	定義名稱。
檔案儲存體	file		array	要新增為附件的檔案

傳回

身體: AppendixAdded

下載合約文件

作業識別碼：: DownloadContractDocuments

擷取包含合約中所有文件的 PDF 檔案。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	string	用於擷取 pdf 檔案的合約 ID。
輸出檔案名稱	filename		string	將要下載的檔案名稱。

傳回

PDF 文件二進位檔: file

下載合約的已簽署文件

作業識別碼：: DownloadContractSignedDocument

從合約的簽署文件中擷取 pdf 檔案。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	integer	包含文件的合約 ID。
檔案名稱	filename		string	您要為下載的文件指定的名稱。

傳回

pdf 檔案的二進位內容。

文件二進位檔: file

下載合約的校訂檔

作業識別碼：: DownloadProofFileContract

下載合約的校訂檔案。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	string	用於下載校訂檔案的合約ID。
輸出檔案名稱	filename		string	將要下載的檔案名稱。

傳回

response: file

停止合約的交易

作業識別碼：: StopContract

停止合約的交易，以便您可以修改合約文件和/或簽署人。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	string	要停止的合約 ID。
勢	force		boolean	即使簽署者已經簽署，也強制關閉交易。

傳回

名稱	路徑	類型	Description
成功	succeed	boolean	指定合約是否已取消。

停止配套交易

作業識別碼：: StopBundleTransaction

停止套件組合交易。

參數

名稱	機碼	必要	類型	Description
捆綁包 ID	id	True	string	要停止交易的套件組合 ID。
強制關閉	force		boolean	強制交易關閉，即使簽署者已經簽署。

傳回

名稱	路徑	類型	Description
成功	succeed	boolean	說捆綁包已成功停止。

傳送套件組合以供簽署

作業識別碼：: SendBundleForSignature

發送捆綁包以供簽名。

參數

名稱	機碼	必要	類型	Description
捆綁包 ID	id	True	string	要傳送以供簽署的軟體組 ID。

傳回

名稱	路徑	類型	Description
成功	succeed	boolean	說明交易是否已發送。

列出合約文件

作業識別碼：: ListContractDocuments

擷取繫結至合約的所有文件。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	string	用於擷取文件的合約 ID。

傳回

response: array of DocumentAdded

列出合約的收件者

作業識別碼：: ListContractRecipients

擷取特定合約的所有收件者。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	string	合約的識別碼，以擷取所有收件者。

傳回

response: array of ContractRecipient

列出套件組合的合約

作業識別碼：: ListBundleContracts

從特定捆綁包中擷取所有合約。

參數

名稱	機碼	必要	類型	Description
捆綁包 ID	id	True	string	要從中擷取合約的套件組合 ID。

傳回

response: array of ContractInBundle

列出所有周邊

作業識別碼：: ListAllPerimeters

擷取與連線環境相關聯的所有周邊。

傳回

response: array of Perimeter

列出所有收件者

作業識別碼：: ListAllRecipients

擷取與目前授權相關聯的所有收件者。

參數

名稱	機碼	類型	Description
大小	size	integer	傳回陣列的大小上限。
Offset	offset	integer	列出的第一個收件者的序號。
周界	perimeter	string	僅在給定的周邊進行搜索。
獲取自定義道具	get_custom_props	boolean	列出收件者自訂屬性（增加回應時間）。
取得周邊	get_perimeters	boolean	在回應中列出收件者的周邊（增加回應時間）。
篩選姓氏（包含）	name	string	篩選姓氏。
篩選電子郵件（包含）	email	string	篩選電子郵件。

傳回

收件者: array of Recipient

刪除合約的收件者

作業識別碼：: DeleteRecipientForContract

從合約中刪除收件者，由合約識別碼的收件者。相關資訊請參閱文件。

參數

名稱	機碼	必要	類型	Description
合約 ID 的收件者	cfc_id	True	string	要刪除的合約物件收件者識別碼。

傳回

名稱	路徑	類型	Description
成功	succeed	boolean	指定是否已成功移除。

取得合約狀態

作業識別碼：: GetContractStatus

檢查特定合約的狀態。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	integer	要擷取狀態的合約識別碼。

傳回

身體: Transaction

取得合約的簽署

作業識別碼：: ListSignatureStatus

列出特定合約中的所有簽名資訊。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	string	列出所有簽名的合約 ID。

傳回

response: array of RecipientForContractWithRefusal

取得所有合約的清單

作業識別碼：: ListAllContracts

從相關聯的授權擷取所有合約。

參數

名稱	機碼	類型	Description
傳回陣列的大小	size	integer	傳回合約陣列的最大大小。
跳過前 n 份合約	offset	integer	將略過的合約序號。
顯示合約屬性	get_properties	boolean	如果為true，合約屬性將會列在回應中。
顯示合約周邊	get_perimeters	boolean	如果為true，合約周邊將會列在回應中。
創建於之前	before	integer	將列出在給定日期之前創建的合同。
創建時間	after	integer	將列出在給定日期之後創建的合同。
僅有周邊	perimeter	string	僅列出指定周邊的合約。
僅有狀態	status	array	僅擷取具有指定狀態的合約。

傳回

物品: ArrayOfContract

取得特定合約

作業識別碼：: GetSpecificContract

擷取特定合約的中繼資料。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	string	要擷取的合約識別碼。

傳回

身體: Contract

取得特定收件者

作業識別碼：: GetRecipient

在目前環境的已儲存收件者清單中擷取特定收件者。

參數

名稱	機碼	必要	類型	Description
收件者 ID	id	True	string	要擷取的收件者識別碼。

傳回

身體: Recipient

將合約新增至套件組合

作業識別碼：: AddContractToBundle

將現有合約新增至現有的 Bundle。

參數

名稱	機碼	必要	類型	Description
捆綁包 ID	id	True	string	要新增合約的套件組合識別碼。
合約 ID	contract_id		integer	要新增至軟體組的合約識別碼。

傳回

身體: BundleResponse

將收件者新增至合約

作業識別碼：: AddRecipientToContract

將現有收件者附加至合約。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	string	要附加收件者的合約ID。
收件者 ID	recipient_id		integer	要附加至合約的收件者識別碼。
簽名模式	signature_mode		integer	簽名模式。如需詳細資訊，請參閱文件。
訊息標題	message_title		string	要透過電子郵件傳送的訊息標題（如果有的話）。
訊息內容	message_body		string	要透過電子郵件傳送的訊息內文（如果有的話）。
等級	rank		integer	收件者在簽名過程中的位置。 Rank 和 Smartrole 是互斥的。只選擇其中一個或根本不選擇。
智慧角色名稱	smartrole		string	賦予收件人的智能角色。如需詳細資訊，請參閱文件。
運輸模式	transport_mode		integer	簽章的傳輸方式。如需詳細資訊，請參閱文件。

傳回

response: array of ContractRecipient

將通知電子郵件重新傳送給所有收件者

作業識別碼：: ResendNotificationAllRecipients

傳送通知電子郵件給特定合約的所有收件者。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	string	要重新傳送通知的合約 ID。

傳回

名稱	路徑	類型	Description
成功	succeed	boolean	指定通知是否成功重新傳送。

建立合約

作業識別碼：: CreateNewContract

在環境中建立新合約。

參數

名稱	機碼	類型	Description
合約名稱	name	string	新建立合約的名稱（必要）。
合約定義識別碼	contract_definition_id	integer	合約定義的 ID。請參閱您授權的 API 變數。預設為 PDF AdHoc 範本。
廠商電子郵件	vendor_email	string	授權擁有者的電子郵件。
創建日期	date	integer	合約日期。預設為 Date.Now（）。必須以毫秒為單位。
訊息標題	message_title	string	傳送電子郵件的物件。為預設標題保留空白。
訊息內文	message_body	string	已傳送電子郵件的正文。保留空白以顯示預設訊息。
繼續前進	keep_on_move	boolean	在行動裝置上啟動或不啟動離線簽名
自動關閉	auto_close	integer	指定是否在沒有人工介入的情況下執行會簽。
循序	sequential	boolean	指定是否循序。
客戶號碼	customer_number	string	僅適用於舊版行動應用程式相容性。
周長列表	perimeters	array of string
元素定義 ID	element_definition_id	integer	元素的定義 ID。
價值觀	value	string	元素選項的值。
屬性 ID	id	integer	自訂屬性的識別碼。
屬性索引鍵	key	string	自訂屬性的索引鍵。
屬性預留位置	placeholder	string	邀請填寫屬性時向收件者顯示的標籤。
屬性值	value	string	自訂屬性的值。
物業合約 ID	contract_id	integer	與此自訂屬性相關聯的合約識別碼。
需要財產	to_fill_by_user	boolean	指定使用者是否需要填寫屬性。
物業類型	field_type	string	指定自訂屬性的類型。文件中的詳細資訊。
住宿選擇	input_filter	string	該物業的可能選擇列表。
財產按合約使用	used_by_contract	boolean	如果資訊必須出現在合約文件上，則設為 true。
需要財產	required	boolean	指定是否需要屬性。

傳回

身體: Contract

建立合約並傳送以供簽署

作業識別碼：: AllInOneCreateContract

一站式操作。建立合約、新增收件者、文件，並將其傳送給收件者以供簽署。

參數

名稱	機碼	必要	類型	Description
合約 ID	contract_id		integer	合約的識別碼。
建立日期	date		integer	建立合約的日期。
供應商電子郵件地址	vendor_email		string	Oodrive 許可證所有者的電子郵件地址。
合約定義識別碼	contract_definition_id		integer	用於此合約的合約定義 ID。
訊息主旨	message_title		string	傳送以供簽署時的電子郵件主旨。
訊息內文	message_body		string	傳送以供簽署時的電子郵件內文。
合約名稱	name	True	string	合約的主要文件名稱。
離線簽名已激活	keep_on_move		boolean	判斷行動裝置上的離線簽章是否已啟用。
合約截止日期	closed_date		integer	合約結束日期（如有）。
合約取消原因	canceled_reason		string	取消原因（如果有）。
啟用自動關閉	auto_close		integer	指定合約是否會自動會簽或需要人工介入。
已刪除	deleted		integer	指定合約是否已刪除。
周邊鍵	Perimeters		string	周邊的關鍵。
選項 ID	id		integer	合約選項的 ID。
合約 ID	contract_id		integer	繫結至此選項的合約識別碼。
元素定義 ID	element_definition_id		integer	選項元素定義的 ID。
同步計時器	sync_timer		integer	用於同步問題的計時器。
選項值	value		string	選項的值。
最後修改地點	last_modification_place		string	指出上次修改發生的位置。
選項控制	control		string	控制欄位。
屬性 ID	id		integer	自訂屬性的識別碼。
屬性索引鍵	key		string	自訂屬性的索引鍵。
屬性預留位置	placeholder		string	邀請填寫屬性時向收件者顯示的標籤。
屬性值	value		string	自訂屬性的值。
物業合約 ID	contract_id		integer	與此自訂屬性相關聯的合約識別碼。
需要財產	to_fill_by_user		boolean	指定使用者是否需要填寫屬性。
物業類型	field_type		string	指定自訂屬性的類型。文件中的詳細資訊。
住宿選擇	input_filter		string	該物業的可能選擇列表。
財產按合約使用	used_by_contract		boolean	如果資訊必須出現在合約文件上，則設為 true。
需要財產	required		boolean	指定是否需要屬性。
簽名模式	signature_mode		integer
名字	firstname		string
姓氏	lastname		string
電子郵件	email		string
cell_phone	cell_phone		string
PDF零件	pdfparts		string
附錄零件	appendixparts		string

傳回

名稱	路徑	類型	Description
收件人	recipients	array of Recipient
recipientForcontract	recipientForcontract	array of ContractRecipient
合約	contract	Contract
PDF	pdfparts	array of object	繫結至合約的 PDF 陣列。
PDF ID	pdfparts.id	integer	PDF 的 ID。
PDF 排名	pdfparts.rank	integer	PDF 的等級。
有 SmartFields	pdfparts.has_smart_field	boolean	指定合約中是否有智慧欄位。
PDF大小	pdfparts.size	integer	文件的大小。
檔案名稱	pdfparts.filename	string	pdf 的名稱。
附錄零件	appendixparts	array of object
識別碼	appendixparts.id	integer

建立套件組合

作業識別碼：: CreateNewBundle

建立至少具有一個現有合約的新捆綁包。

參數

名稱	機碼	必要	類型	Description
合約 ID	contract_id		integer	套件組合第一個合約的識別碼。
相同的簽署者	same_signatories		boolean	如果套件組合中的合約沒有相同的簽署者集，則設為 false。

傳回

身體: BundleResponse

提取捆綁包

作業識別碼：: WithdrawBundle

將所有合約撤回成捆。

參數

名稱	機碼	必要	類型	Description
捆綁包 ID	id	True	string	用於撤回所有合約的捆綁包的 ID。

傳回

名稱	路徑	類型	Description
成功	succeed	boolean	說捆綁包是否被撤回。

撤回合約

作業識別碼：: WithdrawContract

將合約的狀態設定為 ABANDONED，即使合約已傳送以供簽署也一樣。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	string	要撤回的合約 ID。
原因	reason		string	退出的原因。

傳回

名稱	路徑	類型	Description
成功	succeed	boolean	指定合約是否已取消。

發送要簽署的合約

作業識別碼：: SendContractToBeSigned

發送一份特定的合同和所有文件，由收件人簽署。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	string	要傳送以供簽署的合約 ID。

傳回

身體: Transaction

重新傳送通知電子郵件給收件者

作業識別碼：: ResendNotificationRecipient

傳送通知電子郵件給合約的特定收件者。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	string	要重新傳送通知的合約 ID。
合約 ID 的收件者	cfc_id	True	string	合約物件傳送通知的收件者 ID。

傳回

名稱	路徑	類型	Description
成功	succeed	boolean	指定通知是否成功重新傳送。

驗證合約

作業識別碼：: ValidateAContract

驗證（會簽）合約。

參數

名稱	機碼	必要	類型	Description
合約 ID	id	True	string	要驗證的合約識別碼。
勢	force		boolean	指定是否必須強制合約驗證，即使某些簽署者尚未簽署。

傳回

名稱	路徑	類型	Description
驗證日期	date	string	驗證日期。
交易 ID	id	string	憑證授權單位的交易識別碼。

驗證套件組合中的合約

作業識別碼：: ValidateContractsInBundle

會簽（驗證）捆綁中的所有合約。

參數

名稱	機碼	必要	類型	Description
捆綁包 ID	id	True	string	用於驗證所有合約的套件組合 ID。
強制驗證	force		boolean	如果某些簽署者尚未簽署（或拒絕簽署），則強制驗證合約。

傳回

名稱	路徑	類型	Description
		array of object
date	date	string	關閉狀態的日期。
合約 ID	id	string	合約的 ID 已停止。

觸發程序

當合約狀態變更時

每當合約狀態變更時，就會觸發此作業。

當合約狀態變更時

作業識別碼：: WhenContractStatusChanged

每當合約狀態變更時，就會觸發此作業。

參數

名稱	機碼	類型	Description
說明	description	string	說明
events	events	array of string	events
contract定義	contractDefinition	array of integer	contract定義
周界	perimeter	array of integer	周界
關注用戶電子郵件	concernedUserEmail	string	關注用戶電子郵件

傳回

名稱	路徑	類型	Description
型別	type	string	型別
合約標識符	contractId	integer	合約標識符
時間戳記	timestamp	integer	時間戳記
合約狀態	contractStatus	string	合約狀態

定義

合約陣列

名稱	路徑	類型	Description
物品		Contract

合約

名稱	路徑	類型	Description
合約 ID	contract_id	integer	合約的識別碼。
建立日期	date	integer	建立合約的日期。
文件權杖	document_token	string	合約主文件的代幣。
供應商電子郵件地址	vendor_email	string	Oodrive 許可證所有者的電子郵件地址。
已關閉	closed	boolean	指定合約是否已關閉。
合約狀態	status	string	合約的目前狀態。
合約定義識別碼	contract_definition_id	integer	用於此合約的合約定義 ID。
訊息主旨	message_title	string	傳送以供簽署時的電子郵件主旨。
訊息內文	message_body	string	傳送以供簽署時的電子郵件內文。
合約名稱	name	string	合約的主要文件名稱。
離線簽名已激活	keep_on_move	boolean	判斷行動裝置上的離線簽章是否已啟用。
合約截止日期	closed_date	integer	合約結束日期（如有）。
合約取消原因	canceled_reason	string	取消原因（如果有）。
合約版本號碼	version_number	integer	合約的版本號碼。
合約規模	size	integer	合約的完整尺寸。
啟用自動關閉	auto_close	integer	指定合約是否會自動會簽或需要人工介入。
已刪除	deleted	integer	指定合約是否已刪除。
周邊	perimeters	array of ContractPerimeterKey	合約所有周邊的清單（如果查詢）。
選項	options	array of ContractOption	合約的所有特定選項的清單（如果查詢）。
自訂屬性	contract_properties	array of ContractProperty	所有選擇性合約屬性的清單（如果查詢）。

合約選項

名稱	路徑	類型	Description
選項 ID	id	integer	合約選項的 ID。
合約 ID	contract_id	integer	繫結至此選項的合約識別碼。
元素定義 ID	element_definition_id	integer	選項元素定義的 ID。
同步計時器	sync_timer	integer	用於同步問題的計時器。
選項值	value	string	選項的值。
最後修改地點	last_modification_place	string	指出上次修改發生的位置。
選項控制	control	string	控制欄位。

合約屬性

名稱	路徑	類型	Description
屬性 ID	id	integer	自訂屬性的識別碼。
屬性索引鍵	key	string	自訂屬性的索引鍵。
屬性預留位置	placeholder	string	邀請填寫屬性時向收件者顯示的標籤。
屬性值	value	string	自訂屬性的值。
物業合約 ID	contract_id	integer	與此自訂屬性相關聯的合約識別碼。
需要財產	to_fill_by_user	boolean	指定使用者是否需要填寫屬性。
物業類型	field_type	string	指定自訂屬性的類型。文件中的詳細資訊。
住宿選擇	input_filter	string	該物業的可能選擇列表。
財產按合約使用	used_by_contract	boolean	如果資訊必須出現在合約文件上，則設為 true。
需要財產	required	boolean	指定是否需要屬性。

ContractPerimeter索引鍵

周邊的關鍵。

周邊鍵: string

合約收件者

名稱	路徑	類型	Description
合約 ID 的收件者	recipient_for_contract_id	integer	夫妻合約和接收者的唯一識別碼。
收件者 ID	recipient_id	integer	收件者的識別碼。
合約 ID	contract_id	integer	合約的 ID。
簽章狀態	signature_status	string	標誌標記的狀態。
簽名日期	signature_date	integer	符號標記日期的時間戳記。
簽名模式	signature_mode	integer	標誌模式。
訊息標題	message_title	string	訊息的標題。
訊息內容	message_body	string	訊息內文。
等級	rank	integer	在標誌過程中排名。
聰明的角色	smartrole	string	與收件者相關聯的智慧角色。
運輸模式	transport_mode	integer	運輸模式。
簽章識別碼	signature_id	string	收件者簽名的ID。

文件已新增

名稱	路徑	類型	Description
文件 ID	id	integer	文件的 ID。
等級	rank	integer	放在文件清單中。
有 SmartField	has_smart_field	boolean	指定文件是否有智慧欄位。
文件大小	size	integer	文件的大小（以位元組為單位）。
文件名稱	filename	string	文件的名稱。

交易

名稱	路徑	類型	Description
合約交易 ID	transaction_id	string	指定繫結至合約的交易 ID。
已關閉	is_closed	boolean	指定合約是否已關閉。
合約名稱	contract_name	string	合約名稱。
合約狀態	status	string	指定合約的狀態。

周界

名稱	路徑	類型	Description
周邊標識碼	id	integer	周邊的 ID。
周邊鍵	key	string	周邊的索引鍵（由合約使用）。
說明	description	string	周長描述。

RecipientForContractWithRefusal （收件者合約與拒絕）

名稱	路徑	類型	Description
合約 ID 的收件者	recipient_for_contract_id	integer	繫結合約和收件者的物件 ID。
收件者 ID	recipient_id	integer	簽名收件者的 ID。
簽名狀態	signature_status	string	簽章的狀態。
簽名日期	signature_date	integer	簽名最後變更的日期。
簽名模式	signature_mode	integer	簽章的模式。
訊息標題	message_title	string	繫結至合約簽名的訊息標題。
訊息內容	message_body	string	繫結至合約簽章的訊息內文。
等級	rank	integer	簽章收件者在合約流程中的等級。
智慧角色名稱	smartrole	string	簽章收件者在合約中的角色。
運輸模式	transport_mode	integer	繫結至簽章之合約的傳輸方式。
簽章識別碼	signature_id	string	簽章的 ID。
有拒絕	has_refusal	boolean	指定收件者是否拒絕合約。
最後拒絕日期	last_refusal_date	integer	指定拒絕日期。
最後拒絕訊息	last_refusal_message	string	指定拒絕訊息。

合約捆綁包

名稱	路徑	類型	Description
合約 ID	id	integer	合約的 ID。
合約名稱	name	string	合約名稱。
合約定義類型	contract_definition_type	string	合約定義的類型。
合約定義識別碼	contract_definition_id	integer	合約定義的識別碼。
公司名稱	company_name	string	與合約綁定的公司名稱。

Recipient

名稱	路徑	類型	Description
收件者 ID	id	integer	收件者的識別碼。
禮貌	civility	string	收件人的禮貌
名字	firstname	string	收件人的名字。
姓氏	lastname	string	收件者的姓氏。
主要地址	address_1	string	收件人的主要郵寄地址。
郵遞區號	postal_code	string	收件人的郵遞區號。
城市	city	string	接收者的城市。
手機號碼	cell_phone	string	收件人的手機號碼。
郵件地址	email	string	收件人的郵件地址。
國家	country	string	收件者的國家/地區。
次要地址	address_2	string	收件人的次要郵寄地址。
公司名稱	company_name	string	收件者的公司名稱。
電話號碼	phone	string	收件人的電話號碼。
職稱	job_title	string	收件者的職稱。
出生日期	birthdate	integer	收件者的出生日期（時間戳記）。
出生地	birthplace	string	收件人的出生地。
custom_properties	custom_properties	array of RecipientProperty
周長	perimeters	array of string

收件者屬性

名稱	路徑	類型	Description
屬性 ID	id	integer	屬性的 ID。
屬性索引鍵	key	string	屬性的金鑰。
屬性值	value	string	屬性的值。
承包商 ID	contractor_id	integer	承包商的 ID。
同步計時器	sync_timer	integer	上次同步的計時器。
最後修改地點	last_modification_place	string	最後修改的位置。

附錄新增

名稱	路徑	類型	Description
附錄 ID	id	integer	附錄的 ID。
附錄名稱	filename	string	附錄名稱。
附錄選項標識碼	option_id	integer	附錄的選項 ID
附錄內容類型	content_type	string	Content-Type （例如影像/jpeg）。

Bundle回應

名稱	路徑	類型	Description
捆綁包 ID	id	integer	套件組合的 ID。
作者編號	actor_id	integer	套件組合建立者的 ID。
第一個合約 ID	contract_id	integer	已建立 Bundle 的第一個合約 ID。
捆綁狀態	status	integer	套件組合的狀態。
捆綁大師	master	integer	捆綁包的主人。

檔案

這是基本資料類型「檔案」。

共用方式為