Lex Power Sign （預覽版）
Lex Persona 是一家歐洲合格的信託服務提供商，提供一系列電子簽名解決方案。 使用 Lex Enterprise，您可以存取所有 eIDAS 簽章層級，以及大量簽署者驗證方法。 您的簽名書嵌入到數字工作流程中。 自動化 Lex Enterprise 和所有工具之間的連接，以消除重複性任務、提高效率並加速您的業務。
此連接器適用於以下產品和區域：
| 服務 | 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） |
| 連絡人 | |
|---|---|
| 名稱 | Lex Persona 支援 |
| URL | https://support.lex-persona.com |
| support@lex-persona.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 萊克斯角色 |
| 網站 | https://www.lex-persona.com |
| 隱私策略 | https://www.lex-persona.com/politique-de-confidentialite/ |
| 類別 | 人工智慧;網站 |
Lex Persona 是一家歐洲合格的信託服務提供商，提供一系列電子簽名解決方案。 使用此連接器，您可以輕鬆地將電子簽章功能新增至 Microsoft 型應用程式 （PowerApp、.NET 型 Web 應用程式、Dynamics ...） 和環境 （Outlook、Sharepoint、Teams ...該連接器由我們的 Lex Enterprise Workflow 管理器提供支持。 您可以建立由不同類型步驟組成的電子簽章工作流程，這些步驟可以依序和/或平行執行。 該連接器支持所有 eIDAS 簽名級別，並提供廣泛的簽名者身份驗證方法（OTP、SSO、France Connect、Identité Numérique La Poste、硬件令牌......
先決條件
您需要具備以下條件才能繼續：
- Lex Enterprise 訂閱。 使用試用方案進行測試
環境需求為：
- 具有自訂連接器功能的 Microsoft Power Apps 或 Power Automate 方案
- Power platform CLI 工具
如何取得認證
請聯絡我們的銷售代表 commercial@lex-persona.com ，以取得 Lex Enteprise 訂閱或我們試用系統的帳戶。
使用您的帳戶連線到 Lex Enterprise 入口網站，並產生 API 金鑰。
開始使用連接器
首先，建立連接器的連線。 將驗證方法設定為 API 金鑰，提供您的 API 金鑰 （「持有者act_XXXXXXX」），並指定 API 金鑰必須放在 API 呼叫的 Autrorization 標頭中。
建立簡單簽名工作流程的步驟如下：
- 在跳跳器之後，使用「 擷取我」 動作擷取已連線的 Lex Enterprise 使用者 ID （建立工作流程需要此 ID）
- 搜尋同意頁面，並搭配 搜尋同意 頁面 action_。 您可以使用 text 參數依名稱搜尋同意頁面 （同意頁面會定義簽章層級，並在 Lex Enterprise 環境中預先設定）
- 使用「 建立工作流程 」動作建立簽名工作流程。 在此步驟中，您必須提供簽署者的資訊。
- 搜尋簽章設定檔 搜尋簽 章設定檔 動作。 您可以使用 text 參數依名稱搜尋簽章設定檔 （簽章設定檔會控制同意頁面行為的某些層面。強制簽署者在簽署前捲動到文件底部，例如）
- 從您的環境擷取文件 （Sharepoint、Outlook、OneDrive...
- 使用「 建立零件 」動作將文件新增至工作流程，並將 createDocument 參數設定為 true
- 使用 「更新工作流程 」動作啟動工作流程，並將 「工作流程狀態 」設定為「 已啟動」
請注意： 根據預設，連接器會與我們的試用伺服器配對。 如果您想要將連接器與您自己的租用戶配對，則必須在連接器的安全性定義或 apiDefinitions.json 檔案中變更主機URL：
- "host": "yourtenant.lexpersona.com",
瞭解問題和限制
「 建立文件 」動作會接受其有效負載中的文件組件清單。 但是，如果您提供多個部分，則只會考慮第一個部分（這是由於我們 API 中的錯誤。它將在下一個版本的連接器中修復）。
因此，如果您要將多個文件新增至工作流程，則必須執行 對「建立零件」 的呼叫，並將每個文件的 createDocument 參數設定為 true 。
常見錯誤和補救措施
如果 API 呼叫失敗，API 呼叫回應會包含完整的錯誤訊息，該訊息會顯示在連接器的執行歷程中。 此訊息也包含記錄 ID，因此如果您需要有關錯誤的詳細資訊，可以連線到 Lex Enteprise 入口網站並查閱伺服器日誌檔。 或者，您可以設置郵差請求來搜索我們的服務器日誌（請查閱文檔： https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html#search-logs）。
我們的 API 傳回的更常見的 HTTP 錯誤代碼如下：
- 錯誤 400 - 錯誤的要求。 您的請求 paylod 有問題。 請參閱日誌以尋找錯誤原因的相關資訊
- 錯誤 401 - 未經授權。 您沒有執行此操作的存取權限。 檢查您的 Lex Persona 使用者存取權限
- 錯誤 403 - 禁止。 您的 API 金鑰已停用或停用
- 錯誤 404 - 找不到。 您的請求 URL 中發生錯誤
您也可以查看我們的文件，以進一步瞭解每個 API 呼叫可能的錯誤代碼 （https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html）
FAQ
連接器支援哪些文件格式
您可以傳送以供簽署的文件可以有 pdf、docx、pptx 和 xlsx 格式。 如果需要，連接器會將文檔轉換為 pdf，簽名將具有 PAdES 格式。
也可以簽署 XML 文件。 在此情況下，不會套用轉換，且簽章將具有 XAdES 格式。
也可以上傳 zip 文件。 連接器會解壓縮封存，並將每個文件新增至工作流程。
您也可以將附件新增至簽章工作流程。 附件未簽名，可以有任何格式。
文件可以有多個簽署者嗎
是的。 文件的簽署者人數不受限制。
是否可以一次簽署多份文件
是的。 您可以將多個文件新增至工作流程，所有文件都會同時簽署。 但請注意，在這種情況下，這組文件將與法律聯繫在一起，並且系統將產生一個唯一的證據文件。
您也可以建立多個工作光暈，以連接相同的簽署者。 在簽名時，文件清單將呈現給簽署者，簽署者將有機會選擇她想要簽署的文件。 在這種情況下，這些文件將在法律上是獨立的，並且將為每份文件製作一份證據文件。
是否可以離線簽署文件
否。 需要 intenet 連線才能存取同意頁面。
是否可以將自動簽名重新發送給簽名者
是的。 您可以設定提醒期間和要傳送的提醒數量上限。
是否可以修改已啟動的簽名工作流程
是的。 在簽章之前，您可以修改工作流程中的任何內容。 第一次簽名後，無法修改文件，但您仍然可以修改工作流程步驟。
一次性密碼的有效期是多久
一次性密碼的有效期間為兩分鐘（同意頁面上會顯示計數）。
是否可以驗證電子簽名的有效性
您可以使用 Adobe Acrobat 的 「簽名」窗格 來檢查 pdf 文件中所含簽名的有效性。 或者，您可以使用授信簽章驗證 Web 服務 （例如 ）https://ec.europa.eu/digital-building-blocks/DSS/webapp-demo/validation
Lex Persona 文件儲存條件為何
默認情況下，我們將文檔和證據文件保存在我們的服務器中。 Tou 可以隨時搜索和下載文檔。 但是，如果需要，我們可以優先從我們的服務器中刪除您的文檔。
Lex Persona 是否保留時間戳記令牌
否。 我們不保留時間戳記令牌。 如有需要，您可以從已簽署的文件中引出這些記號。
已簽署的文件有撤回期限嗎
是的。 提款原則取決於適用於該文件的法律條件。
是否可以取消簽章工作流程
是的。 授權使用者可以隨時取消已啟動的簽章工作流程。 不會產生任何驅逐文件，如果文件已經由一名或多名簽署人簽署，則該文件將無效。
正在建立連線
連接器支援下列驗證類型：
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用：所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| API 金鑰 | securestring | 此 API 的 API 金鑰 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 下載工作流程文件 |
下載工作流程文件 |
| 下載證據檔案 |
下載工作流程辨識項檔案 |
| 刪除工作流程 |
刪除工作流程 |
| 刪除文件 |
刪除文件 |
| 刪除連絡人 |
從目前使用者的通訊清單中移除連絡人 |
| 建立中繼資料版面配置 |
建立中繼資料版面配置 |
| 建立工作流程 |
建立工作流程 |
| 建立文件 |
從先前建立的零件建立文件 |
| 建立簽名設定檔 |
建立簽名設定檔 |
| 建立連絡人 |
將連絡人新增至目前使用者的連絡人清單 |
| 建立零件 |
建立文件零件 |
| 找回我 |
擷取已連線的使用者 ID |
| 搜尋中繼資料版面配置 |
搜尋工作流程版面配置 |
| 搜尋同意聲明頁面 |
搜尋同意聲明頁面 |
| 搜尋工作流程 |
搜尋工作流程 |
| 搜尋文件 |
搜尋文件 |
| 搜尋簽名設定檔 |
搜尋簽名設定檔 |
| 搜尋聯絡人 |
搜尋聯絡人 |
| 擷取中繼資料對應 |
擷取指定租用戶的中繼資料對應 |
| 擷取中繼資料版面配置 |
擷取工作流程版面配置 |
| 擷取同意頁面 |
從同意頁面識別碼擷取同意頁面資訊 |
| 擷取工作流程 |
從工作流程識別碼擷取工作流程 |
| 擷取文件 |
擷取文件 |
| 擷取相關內容頁面網址 |
建立和擷取收件者的同意頁面URL |
| 擷取簽章設定檔 |
擷取簽章設定檔 |
| 擷取聯絡人 |
從聯絡人 ID 擷取聯絡資訊 |
| 更新中繼資料版面配置 |
更新中繼資料版面配置 |
| 更新工作流程 |
更新工作流程 |
| 更新文件 |
更新文件 |
| 更新簽章設定檔 |
更新簽名設定檔 |
| 更新連絡人 |
修改現有的連絡資訊 |
下載工作流程文件
下載證據檔案
下載工作流程辨識項檔案
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作流程識別碼
|
workflowId | True | string |
工作流程的識別碼 |
|
接受
|
Accept | True | string |
接受 |
傳回
- response
- binary
刪除工作流程
刪除文件
刪除連絡人
從目前使用者的通訊清單中移除連絡人
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
聯絡人 ID
|
contactId | True | string |
連絡人的標識碼 |
|
內容類型
|
Content-Type | True | string |
內容-類型 |
傳回
- 身體
- contact
建立中繼資料版面配置
建立中繼資料版面配置
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
租用戶識別碼
|
tenantId | True | string |
版面配置的標識碼 |
|
內容類型
|
Content-Type | True | string |
內容-類型 |
|
名稱
|
name | True | string |
版面配置名稱 |
|
已停用
|
isDisabled | boolean |
如果設定為 true，則會停用版面配置 |
|
|
槽
|
slot | string |
中繼資料項目 （data1 至 data8） |
|
|
預設
|
default | string |
此版面配置中的中繼資料預設值 |
|
|
optional
|
optional | boolean |
如果為true，則提供值不是強制性的 |
|
|
唯讀
|
readonly | boolean |
值是否可以被覆蓋 |
|
|
記住最後值
|
rememberLastValue | boolean |
如果設定為true，則值會在工作流程中持續存在 |
傳回
中繼資料版面配置
- 身體
- layout
建立工作流程
建立工作流程
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
使用者 ID
|
userId | True | string |
工作流程擁有者的使用者識別碼 |
|
內容類型
|
Content-Type | string |
內容類型 |
|
|
名稱
|
name | True | string |
工作流程名稱 |
|
Description
|
description | string |
工作流程說明 |
|
|
識別碼
|
id | string |
步驟識別碼 |
|
|
步驟類型
|
stepType | string |
簽名或批准 |
|
|
consentPageId
|
consentPageId | True | string |
與此收件者相關聯的同意頁面 （簽名層級） 的 ID |
|
電子郵件
|
True | string |
收件者的電子郵件 |
|
|
userId
|
userId | string |
引用 LE 用戶，而不是即時創建收件人 |
|
|
電話號碼
|
phoneNumber | string |
Reicpient 的手機號碼 |
|
|
名字
|
firstName | string |
收件人的名字 |
|
|
lastName
|
lastName | string |
收件人的姓氏 |
|
|
country
|
country | string |
收款人的國家/地區代碼 |
|
|
preferredLocale
|
preferredLocale | string |
收件者的地區設定代碼 |
|
|
organizationId
|
organizationId | string |
收件者 LE 組織的標識碼 |
|
|
required收件者
|
requiredRecipients | number |
必須簽署才能採取下一步的簽署者人數下限 |
|
|
有效期間
|
validityPeriod | number |
步驟有效期 |
|
|
邀請期間
|
inviteperiod | number |
簽名提醒頻率 |
|
|
最大邀請
|
maxInvites | number |
簽名提醒數量上限 |
|
|
發送下載鏈接
|
sendDownloadLink | boolean |
控制將已簽署的文件遞送給簽署者 |
|
|
允許註解
|
allowComments | boolean |
允許/禁止對此步驟的註解 |
|
|
隱藏附件
|
hideAttachments | boolean |
控制簽署者附件的顯示 |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
控制其他簽署者對簽署者的顯示 |
|
|
已通知的事件
|
notifiedEvents | array of string |
已通知的工作流程事件 |
|
|
userId
|
userId | string |
監看者的使用者 ID |
|
|
通知事件
|
notifiedEvents | array of string |
將通知此監看員的工作流程事件 |
|
|
電子郵件
|
string |
觀察者的電子郵件 |
||
|
範本識別碼
|
templateId | string |
工作流程衍生之範本的ID |
|
|
版面配置識別碼
|
layoutId | string |
工作檔使用的中繼資料版面配置 |
|
|
資料1
|
data1 | string |
第一個元數據 |
|
|
資料2
|
data2 | string |
第二個中繼資料 |
|
|
資料3
|
data3 | string |
第三元資料 |
|
|
資料4
|
data4 | string |
第四個元資料 |
|
|
資料5
|
data5 | string |
第五個元數據 |
|
|
資料6
|
data6 | string |
第六個中繼資料 |
|
|
數據7
|
data7 | string |
第七個元資料 |
|
|
資料8
|
data8 | string |
Heighth 中繼資料 |
傳回
- 身體
- workflow
建立文件
從先前建立的零件建立文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作流程識別碼
|
workflowId | True | string |
相關工作流程的識別碼 |
|
內容類型
|
Content-Type | True | string |
內容-類型 |
|
內容類型
|
contentType | string |
內容類型 |
|
|
filename
|
filename | string |
filename |
|
|
雜湊
|
hash | string |
雜湊 |
|
|
size
|
size | integer |
size |
|
|
signatureProfileId
|
signatureProfileId | string |
此文件的簽名設定檔 |
傳回
- 身體
- document
建立簽名設定檔
建立簽名設定檔
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
租用戶識別碼
|
tenantId | True | string |
租戶的標識碼 |
|
內容類型
|
Content-Type | True | string |
內容-類型 |
|
預設值
|
isDefault | True | string |
將此簽章設定檔設為預設設定檔 |
|
已停用
|
isDisabled | string |
停用此簽章設定檔 |
|
|
名稱
|
name | True | string |
簽章設定檔名稱 |
|
文件類型
|
documentType | True | string |
pdf、xml、word、excel、powerpoint、其他 |
|
簽名類型
|
signatureType | True | string |
pades，xades，xadesDetached，xadesDetachedManifest，cades，helios |
|
強制捲動至文件底部
|
forceScrollDocument | True | boolean |
強制簽署者捲動至文件底部 |
|
可見簽名模式
|
pdfVisibleSignatureMode | string |
可見簽名模式（允許、禁用、noImage） |
|
|
簽名文字
|
pdfSignatureImageText | string |
簽名墊中顯示的文字 |
|
|
簽名文字顏色
|
pdfSignatureImageTextColor | string |
singatures pad 中顯示的文字顏色 |
|
|
簽名文字大小
|
pdfSignatureImageTextSize | number |
singatures pad 中顯示的文字大小 |
傳回
建立連絡人
將連絡人新增至目前使用者的連絡人清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
使用者 ID
|
userId | True | string |
聯絡人所屬的使用者 |
|
內容類型
|
Content-Type | True | string |
內容-類型 |
|
連絡電子郵件
|
True | string |
連絡電子郵件 |
|
|
聯繫電話號碼
|
phoneNumber | string |
電話號碼 |
|
|
聯絡人名字
|
firstName | True | string |
名字 |
|
聯絡人姓氏
|
lastName | True | string |
lastName |
|
聯絡國家
|
country | string |
country |
傳回
- 身體
- contact
建立零件
建立文件零件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作流程識別碼
|
workflowId | True | string |
相關工作流程的識別碼 |
|
內容類型
|
Content-Type | True | string |
內容-類型 |
|
Cotent 處置
|
Content-Disposition | True | string |
內容分佈 |
|
建立文件
|
createDocuments | string |
從此部分建立文件 |
|
|
忽略附件
|
ignoreAttachments | string |
附件將被忽略 |
|
|
簽章設定檔ID
|
signatureProfileId | string |
如果省略，則部分被視為附件 |
|
|
解壓縮
|
unzip | string |
解壓縮檔案 |
|
|
Pdf 轉 PdfA
|
pdf2pdfa | string |
將 pdf 轉換為 pdf/A |
|
|
文件
|
document | True | binary |
上傳的檔案資料 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of document |
已建立的文件 |
|
ignored附件
|
ignoredAttachments | integer |
ignored附件 |
|
部件
|
parts | array of part |
部件 |
找回我
搜尋中繼資料版面配置
搜尋工作流程版面配置
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
搜尋文字
|
text | string |
搜尋文字 |
|
|
搜尋已停用
|
items.isDisabled | string |
搜尋已停用的版面配置 |
|
|
搜尋名稱
|
items.name | string |
按版面名稱搜尋 |
|
|
搜尋中繼資料
|
items.dataConfigurations.slot | string |
依中繼資料的存在進行搜尋 |
|
|
搜尋建立日期
|
items.created | string |
按創建日期搜索 |
|
|
搜尋更新日期
|
items.updated | string |
按最後更新日期搜尋 |
|
|
排序方式
|
sortBy | string |
用來排序搜尋結果的欄位 |
|
|
排序順序
|
sortOrder | string |
排序方向 |
|
|
每頁項目數
|
itemsPerPage | string |
回應中每頁的項目數 |
|
|
頁面索引
|
pageIndex | string |
傳回頁面的索引 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
items
|
items | layouts |
搜尋同意聲明頁面
搜尋同意聲明頁面
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
搜尋文字
|
text | string |
搜尋文字 |
|
|
搜尋預設值
|
items.isDefault | string |
搜尋預設同意聲明頁面 |
|
|
搜尋已停用
|
items.isDisabled | string |
搜尋已停用的同意聲明頁面 |
|
|
搜尋名稱
|
items.name | string |
依同意頁面名稱搜尋 |
|
|
搜尋步驟類型
|
items.stepType | string |
按步驟類型搜尋 |
|
|
搜尋用戶端識別碼
|
items.clientId | string |
依用戶端識別碼搜尋 |
|
|
搜尋建立日期
|
items.created | string |
按創建日期搜索 |
|
|
搜尋更新日期
|
items.updated | string |
按最後更新日期搜尋 |
|
|
排序方式
|
sortBy | string |
要排序搜尋結果的欄位 |
|
|
排序順序
|
sortOrder | string |
排序方向 |
|
|
每頁項目數
|
itemsPerPage | string |
回應中每頁的項目數 |
|
|
頁面索引
|
pageIndex | string |
傳回頁面的索引 |
傳回
- 身體
- consentPages
搜尋工作流程
搜尋工作流程
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
接受
|
Accept | string |
接受 |
|
|
搜尋文字
|
text | string |
搜尋文字 |
|
|
搜尋中繼資料版面配置
|
items.layoutId | string |
依中繼資料版面配置搜尋 |
|
|
搜尋範本
|
items.templateId | string |
依工作流程範本搜尋 |
|
|
搜尋群組
|
items.groupId | string |
依使用者群組搜尋 |
|
|
搜尋使用者
|
items.userId | string |
按所有者搜索 |
|
|
搜尋電子郵件
|
items.email | string |
按所有者的電子郵件搜索 |
|
|
搜尋名字
|
items.firstname | string |
按所有者的名字搜索 |
|
|
搜尋姓氏
|
items.lastname | string |
按所有者姓氏搜索 |
|
|
搜尋狀態
|
items.workflowStatus | string |
依工作流程狀態搜尋 |
|
|
搜尋中繼資料 1
|
items.data1 | string |
依中繼資料值搜尋 1 |
|
|
搜尋中繼資料 2
|
items.data2 | string |
依中繼資料值搜尋 2 |
|
|
搜尋中繼資料 3
|
items.data3 | string |
依中繼資料值搜尋 3 |
|
|
搜尋中繼資料 4
|
items.data4 | string |
依中繼資料值搜尋 4 |
|
|
搜尋中繼資料 5
|
items.data5 | string |
依中繼資料值搜尋 5 |
|
|
搜尋中繼資料 6
|
items.data6 | string |
依中繼資料值搜尋 6 |
|
|
搜尋中繼資料 7
|
items.data7 | string |
依中繼資料值搜尋 7 |
|
|
搜尋中繼資料 8
|
items.data8 | string |
依中繼資料值搜尋 8 |
|
|
搜尋建立日期
|
items.created | string |
按創建日期搜索 |
|
|
搜尋更新日期
|
items.updated | string |
按最後更新日期搜尋 |
|
|
搜尋開始日期
|
items.started | string |
按開始日期搜尋 |
|
|
排序方式
|
sortBy | string |
用來排序搜尋結果的欄位 |
|
|
排序順序
|
sortOrder | string |
排序方向 |
|
|
每頁項目數
|
itemsPerPage | string |
回應中每頁的項目數 |
|
|
頁面索引
|
pageIndex | string |
傳回頁面的索引 |
傳回
- 身體
- workflows
搜尋文件
搜尋文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
搜尋文字
|
text | string |
搜尋文字 |
|
|
搜尋中繼資料版面配置
|
items.layoutId | string |
依中繼資料版面配置搜尋 |
|
|
搜尋群組
|
items.groupId | string |
依使用者群組搜尋 |
|
|
搜尋使用者
|
items.userId | string |
按所有者搜索 |
|
|
搜尋工作流程識別碼
|
items.workflowId | string |
依工作流程識別碼搜尋 |
|
|
搜尋工作流程名稱
|
items.workflowName | string |
依工作流程名稱搜尋 |
|
|
搜尋中繼資料 1
|
items.data1 | string |
依中繼資料值搜尋 1 |
|
|
搜尋中繼資料 2
|
items.data2 | string |
依中繼資料值搜尋 2 |
|
|
搜尋中繼資料 3
|
items.data3 | string |
依中繼資料值搜尋 3 |
|
|
搜尋中繼資料 4
|
items.data4 | string |
依中繼資料值搜尋 4 |
|
|
搜尋中繼資料 5
|
items.data5 | string |
依中繼資料值搜尋 5 |
|
|
搜尋中繼資料 6
|
items.data6 | string |
依中繼資料值搜尋 6 |
|
|
搜尋中繼資料 7
|
items.data7 | string |
依中繼資料值搜尋 7 |
|
|
搜尋中繼資料 8
|
items.data8 | string |
依中繼資料值搜尋 8 |
|
|
搜尋簽名設定檔
|
items.signatureProfileId | string |
依簽名設定檔搜尋 |
|
|
搜尋建立日期
|
items.created | string |
按創建日期搜索 |
|
|
搜尋更新日期
|
items.updated | string |
按最後更新日期搜尋 |
|
|
排序方式
|
sortBy | string |
用來排序搜尋結果的欄位 |
|
|
排序順序
|
sortOrder | string |
排序方向 |
|
|
每頁項目數
|
itemsPerPage | string |
回應中每頁的項目數 |
|
|
頁面索引
|
pageIndex | string |
傳回頁面的索引 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
items
|
items | documents |
搜尋簽名設定檔
搜尋簽名設定檔
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
搜尋文字
|
text | string |
搜尋文字 |
|
|
搜尋預設值
|
items.isDefault | string |
搜尋預設簽章設定檔 |
|
|
搜尋已停用
|
items.isDisabled | string |
搜尋已停用的簽章設定檔 |
|
|
搜尋名稱
|
items.name | string |
依簽章設定檔名稱搜尋 |
|
|
搜尋文件類型
|
items.documentType | string |
依文件類型搜尋 |
|
|
搜尋簽章類型
|
items.signatureType | string |
依簽章類型搜尋 |
|
|
搜尋建立日期
|
items.created | string |
按創建日期搜索 |
|
|
搜尋更新日期
|
items.updated | string |
按最後更新日期搜尋 |
|
|
排序方式
|
sortBy | string |
用來排序搜尋結果的欄位 |
|
|
排序順序
|
sortOrder | string |
排序方向 |
|
|
每頁項目數
|
itemsPerPage | string |
回應中每頁的項目數 |
|
|
頁面索引
|
pageIndex | string |
傳回頁面的索引 |
傳回
搜尋聯絡人
搜尋聯絡人
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
搜尋文字
|
text | string |
按文字搜尋 |
|
|
搜尋電子郵件
|
items.email | string |
透過電子郵件搜尋 |
|
|
搜尋電話號碼
|
items.phoneNumber | string |
按電話號碼搜尋 |
|
|
搜尋名字
|
items.fisrtName | string |
按名字搜尋 |
|
|
搜尋姓氏
|
items.lastName | string |
按姓氏搜尋 |
|
|
搜尋國家/地區
|
items.country | string |
按國家搜尋 |
|
|
每頁項目數
|
itemsPerPage | number |
回應中每頁的項目數 |
|
|
頁面索引
|
pageIndex | number |
傳回頁面的索引 |
傳回
- 身體
- contacts
擷取中繼資料對應
擷取中繼資料版面配置
擷取同意頁面
從同意頁面識別碼擷取同意頁面資訊
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
同意頁面識別碼
|
cpId | True | string |
同意頁面的標識碼 |
|
內容類型
|
Content-Type | True | string |
內容-類型 |
傳回
- 身體
- consentPage
擷取工作流程
擷取文件
擷取相關內容頁面網址
建立和擷取收件者的同意頁面URL
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作流程識別碼
|
workflowId | True | string |
工作流程的識別碼 |
|
收件者電子郵件
|
recipientEmail | string |
相關收件人的電子郵件 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
相關收件者的同意頁面URL
|
inviteUrl | string |
相關收件者的同意頁面URL |
擷取簽章設定檔
擷取聯絡人
從聯絡人 ID 擷取聯絡資訊
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
聯絡人 ID
|
contactId | True | string |
連絡人的標識碼 |
|
內容類型
|
Content-Type | True | string |
內容-類型 |
傳回
- 身體
- contact
更新中繼資料版面配置
更新中繼資料版面配置
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
租用戶識別碼
|
layoutId | True | string |
版面配置的標識碼 |
|
內容類型
|
Content-Type | True | string |
內容-類型 |
|
名稱
|
name | True | string |
版面配置名稱 |
|
已停用
|
isDisabled | boolean |
如果設定為 true，則會停用版面配置 |
|
|
槽
|
slot | string |
中繼資料項目 （data1 至 data8） |
|
|
預設
|
default | string |
此版面配置中的中繼資料預設值 |
|
|
optional
|
optional | boolean |
如果為true，則提供值不是強制性的 |
|
|
唯讀
|
readonly | boolean |
值是否可以被覆蓋 |
|
|
記住最後值
|
rememberLastValue | boolean |
如果設定為true，則值會在工作流程中持續存在 |
傳回
中繼資料版面配置
- 身體
- layout
更新工作流程
更新工作流程
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作流程識別碼
|
workflowId | True | string |
要更新的工作流程標識碼 |
|
內容類型
|
Content-Type | string |
內容類型 |
|
|
使用者 ID
|
userId | string |
工作流程擁有者的識別碼 |
|
|
名稱
|
name | string |
工作流程名稱 |
|
|
Description
|
description | string |
工作流程說明 |
|
|
識別碼
|
id | string |
步驟識別碼 |
|
|
步驟類型
|
stepType | string |
簽名或批准 |
|
|
consentPageId
|
consentPageId | True | string |
與此收件者相關聯的同意頁面 （簽名層級） 的 ID |
|
電子郵件
|
True | string |
收件者的電子郵件 |
|
|
userId
|
userId | string |
引用 LE 用戶，而不是即時創建收件人 |
|
|
電話號碼
|
phoneNumber | string |
Reicpient 的手機號碼 |
|
|
名字
|
firstName | string |
收件人的名字 |
|
|
lastName
|
lastName | string |
收件人的姓氏 |
|
|
country
|
country | string |
收款人的國家/地區代碼 |
|
|
preferredLocale
|
preferredLocale | string |
收件者的地區設定代碼 |
|
|
organizationId
|
organizationId | string |
收件者 LE 組織的標識碼 |
|
|
required收件者
|
requiredRecipients | number |
必須簽署才能採取下一步的簽署者人數下限 |
|
|
有效期間
|
validityPeriod | number |
步驟有效期 |
|
|
邀請期間
|
inviteperiod | number |
簽名提醒頻率 |
|
|
最大邀請
|
maxInvites | number |
簽名提醒數量上限 |
|
|
發送下載鏈接
|
sendDownloadLink | boolean |
控制將已簽署的文件遞送給簽署者 |
|
|
允許註解
|
allowComments | boolean |
允許/禁止對此步驟的註解 |
|
|
隱藏附件
|
hideAttachments | boolean |
控制簽署者附件的顯示 |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
控制其他簽署者對簽署者的顯示 |
|
|
已通知的事件
|
notifiedEvents | array of string |
已通知的工作流程事件 |
|
|
userId
|
userId | string |
監看者使用者識別碼 |
|
|
通知事件
|
notifiedEvents | array of string |
將通知此監看員的工作流程事件 |
|
|
電子郵件
|
string |
電子郵件 |
||
|
工作流程狀態
|
workflowStatus | string |
工作流程的目前狀態 |
|
|
資料1
|
data1 | string |
第一個中繼資料 |
|
|
資料2
|
data2 | string |
第二個元數據 |
|
|
資料3
|
data3 | string |
第三元資料 |
|
|
資料4
|
data4 | string |
第四個元數據 |
|
|
資料5
|
data5 | string |
第五個元數據 |
|
|
資料6
|
data6 | string |
第六個元數據 |
|
|
數據7
|
data7 | string |
第七個元數據 |
|
|
資料8
|
data8 | string |
heighth 中繼資料 |
傳回
- 身體
- workflow
更新文件
更新文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件標識碼
|
documentId | True | string |
文件的 ID |
|
內容類型
|
Content-Type | True | string |
內容-類型 |
|
signatureProfileId
|
signatureProfileId | string |
要套用至本文件的簽名設定檔 |
|
|
影像高度
|
imageHeight | float |
影像高度 |
|
|
圖像頁面
|
imagePage | float |
圖像頁面 |
|
|
影像寬度
|
imageWidth | float |
影像寬度 |
|
|
imageX
|
imageX | float |
imageX |
|
|
影像Y
|
imageY | float |
影像Y |
傳回
- 身體
- document
更新簽章設定檔
更新簽名設定檔
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
簽章設定檔ID
|
spId | True | string |
簽章設定檔的 ID |
|
內容類型
|
Content-Type | True | string |
內容-類型 |
|
預設值
|
isDefault | string |
將此簽章設定檔設為預設設定檔 |
|
|
已停用
|
isDisabled | string |
停用此簽章設定檔 |
|
|
名稱
|
name | string |
簽章設定檔名稱 |
|
|
簽名類型
|
signatureType | string |
pades，xades，xadesDetached，xadesDetachedManifest，cades，helios |
|
|
強制捲動至文件底部
|
forceScrollDocument | boolean |
強制簽署者捲動至文件底部 |
|
|
可見簽名模式
|
pdfVisibleSignatureMode | string |
可見簽名模式（允許、禁用、noImage） |
|
|
簽名文字
|
pdfSignatureImageText | string |
簽名墊中顯示的文字 |
|
|
簽名文字顏色
|
pdfSignatureImageTextColor | string |
singatures pad 中顯示的文字顏色 |
|
|
簽名文字大小
|
pdfSignatureImageTextSize | number |
singatures pad 中顯示的文字大小 |
傳回
更新連絡人
修改現有的連絡資訊
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
聯絡人 ID
|
contactId | True | string |
連絡人的標識碼 |
|
內容類型
|
Content-Type | True | string |
內容-類型 |
|
聯絡人的電子郵件
|
string |
聯絡人的電子郵件 |
||
|
聯絡人的電話號碼
|
phoneNumber | string |
聯絡人的電話號碼 |
|
|
聯絡人的名字
|
firstName | string |
聯絡人的名字 |
|
|
聯絡人的姓氏
|
lastName | string |
聯絡人的姓氏 |
|
|
聯絡國家/地區
|
country | string |
聯絡國家/地區 |
傳回
- 身體
- contact
定義
同意頁面
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
允許組織
|
allowOrganization | boolean |
允許使用組織 |
|
authenticateUser
|
authenticateUser | boolean |
強制執行簽署者驗證 |
|
clientId
|
clientId | string |
用戶端識別碼 |
|
創建
|
created | number |
建立日期 |
|
em網址
|
emUrl | string |
證據管理員網址 |
|
隱藏下載（HideDownloads）
|
hideDownloads | boolean |
文件下載連結不會在同意頁面上顯示 |
|
隱藏手機二維碼
|
hideMobileQrCode | boolean |
隱藏相關頁面上的二維碼 |
|
識別碼
|
id | string |
同意頁面標識符 |
|
isCountryRequired（是國家/地區必要）
|
isCountryRequired | boolean |
在簽署者資訊中強制要求國家/地區 |
|
isDisabled （已禁用）
|
isDisabled | boolean |
同意聲明頁面已停用 |
|
logoResourceId
|
logoResourceId | string |
同意頁面標誌資源的標識碼 |
|
名稱
|
name | string |
同意頁面名稱 |
|
原色
|
primaryColor | string |
同意頁面原色 |
|
次要顏色
|
secondaryColor | string |
同意聲明頁面次要顏色 |
|
shared密碼
|
sharedPassphrase | string |
共用密碼 |
|
簽署模式
|
signing mode | string |
簽署模式 （本機或伺服器） |
|
步驟類型
|
stepType | string |
步驟類型 （簽名或核准） |
|
tenantId
|
tenantId | string |
租用戶識別碼 |
|
tsa網址
|
tsaUrl | string |
時間戳記授權單位 Url |
|
更新
|
updated | number |
上次修改日期 |
|
驗證電子郵件
|
verifyEmail | boolean |
如果設定為星期二，簽署者將透過電子郵件收到一次性密碼 |
|
驗證電話號碼
|
verifyPhoneNumber | boolean |
如果設定為 true，簽署者將透過簡訊接收 OTP |
同意頁面
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
items
|
items | array of consentPage |
items |
|
項目每頁
|
itemsPerPage | integer |
項目每頁 |
|
頁面索引
|
pageIndex | integer |
頁面索引 |
|
totalItems
|
totalItems | integer |
totalItems |
連絡人
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
country
|
country | string |
聯絡國家 |
|
創建
|
created | integer |
聯絡人建立日期 |
|
電子郵件
|
string |
連絡電子郵件 |
|
|
名字
|
firstName | string |
聯絡人姓名 |
|
識別碼
|
id | string |
聯絡人 ID |
|
lastName
|
lastName | string |
聯繫人姓氏 |
|
名稱
|
name | string |
聯絡人姓名（名字+姓氏）） |
|
電話號碼
|
phoneNumber | string |
聯繫人電話號碼 |
|
tenantId
|
tenantId | string |
租用戶識別碼 |
|
更新
|
updated | integer |
聯絡上次修改日期 |
|
userId
|
userId | string |
連絡人擁有者的識別碼 |
contacts
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
items
|
items | array of contact |
items |
|
項目每頁
|
itemsPerPage | integer |
項目每頁 |
|
頁面索引
|
pageIndex | integer |
頁面索引 |
|
totalItems
|
totalItems | integer |
totalItems |
資料對映
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
描述
|
data1.description | string |
中繼資料說明 |
|
名稱
|
data1.name | string |
中繼資料名稱 |
|
模式
|
data1.pattern | string |
中繼資料模式 |
|
options
|
data1.options | array of object |
options |
|
value
|
data1.options.value | string |
詮釋資料值 |
|
型別
|
data1.type | string |
型別 |
|
描述
|
data2.description | string |
中繼資料說明 |
|
名稱
|
data2.name | string |
中繼資料名稱 |
|
模式
|
data2.pattern | string |
中繼資料模式 |
|
options
|
data2.options | array of object |
options |
|
value
|
data2.options.value | string |
詮釋資料值 |
|
型別
|
data2.type | string |
型別 |
|
描述
|
data3.description | string |
中繼資料說明 |
|
名稱
|
data3.name | string |
中繼資料名稱 |
|
模式
|
data3.pattern | string |
中繼資料模式 |
|
options
|
data3.options | array of object |
options |
|
value
|
data3.options.value | string |
詮釋資料值 |
|
型別
|
data3.type | string |
型別 |
|
描述
|
data4.description | string |
中繼資料說明 |
|
名稱
|
data4.name | string |
中繼資料名稱 |
|
模式
|
data4.pattern | string |
中繼資料模式 |
|
options
|
data4.options | array of object |
options |
|
value
|
data4.options.value | string |
詮釋資料值 |
|
型別
|
data4.type | string |
型別 |
|
描述
|
data5.description | string |
中繼資料說明 |
|
名稱
|
data5.name | string |
中繼資料名稱 |
|
模式
|
data5.pattern | string |
中繼資料模式 |
|
options
|
data5.options | array of object |
options |
|
value
|
data5.options.value | string |
詮釋資料值 |
|
型別
|
data5.type | string |
型別 |
|
描述
|
data6.description | string |
中繼資料說明 |
|
名稱
|
data6.name | string |
中繼資料名稱 |
|
模式
|
data6.pattern | string |
中繼資料模式 |
|
options
|
data6.options | array of object |
options |
|
value
|
data6.options.value | string |
詮釋資料值 |
|
型別
|
data6.type | string |
型別 |
|
描述
|
data7.description | string |
中繼資料說明 |
|
名稱
|
data7.name | string |
中繼資料名稱 |
|
模式
|
data7.pattern | string |
中繼資料模式 |
|
options
|
data7.options | array of object |
options |
|
value
|
data7.options.value | string |
中繼資料值 |
|
型別
|
data7.type | string |
型別 |
|
描述
|
data8.description | string |
中繼資料說明 |
|
名稱
|
data8.name | string |
中繼資料名稱 |
|
模式
|
data8.pattern | string |
中繼資料模式 |
|
options
|
data8.options | array of object |
options |
|
value
|
data8.options.value | string |
詮釋資料值 |
|
型別
|
data8.type | string |
型別 |
文件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建
|
created | integer |
建立日期 |
|
groupId
|
groupId | string |
文件擁有者群組的標識符 |
|
識別碼
|
id | string |
文件的 ID |
|
部件
|
parts | array of part |
部件 |
|
pdf簽名欄位
|
pdfSignatureFields | array of pdfSigField |
pdf簽名欄位 |
|
signatureProfileId
|
signatureProfileId | string |
文件簽名設定檔的 ID |
|
tenantId
|
tenantId | string |
租用戶標識碼 |
|
更新
|
updated | integer |
上次修改日期 |
|
userId
|
userId | string |
文件擁有者使用者 ID |
|
檢視授權群組
|
viewAuthorizedGroups | array of string |
允許檢視文件的群組清單 |
|
檢視授權使用者
|
viewAuthorizedUsers | array of string |
允許zd檢視文件的使用者清單 |
|
workflowId
|
workflowId | string |
文件所屬工作流程的標識碼 |
|
工作流名稱
|
workflowName | string |
文件所屬工作流程的名稱 |
檔
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
items
|
items | array of document |
items |
|
項目每頁
|
itemsPerPage | integer |
項目每頁 |
|
頁面索引
|
pageIndex | integer |
頁面索引 |
|
totalItems
|
totalItems | integer |
totalItems |
版面配置
中繼資料版面配置
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建
|
created | number |
建立日期 |
|
識別碼
|
id | string |
版面配置識別碼 |
|
isDisabled （已禁用）
|
isDisabled | boolean |
如果設定為 true，則版面配置已取消 |
|
名稱
|
name | string |
版面配置的名稱 |
|
tenantId
|
tenantId | string |
租戶的標識碼 |
|
更新
|
updated | number |
上次修改日期 |
|
資料組態
|
dataConfigurations | array of object | |
|
槽
|
dataConfigurations.slot | string |
中繼資料項目 （data1 至 data8） |
|
預設
|
dataConfigurations.default | string |
此版面配置中的中繼資料預設值 |
|
optional
|
dataConfigurations.optional | boolean |
如果為true，則不是強制性地提供此中繼資料的值 |
|
唯讀
|
dataConfigurations.readonly | boolean |
值是否可以被覆蓋 |
|
記住最後值
|
dataConfigurations.rememberLastValue | boolean |
如果設定為true，則值會在工作流程中持續存在 |
佈局
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
items
|
items | array of object | |
|
創建
|
items.created | number |
建立日期 |
|
資料組態
|
items.dataConfigurations | array of layout | |
|
項目每頁
|
itemsPerPage | number |
每頁項目數 |
|
頁面索引
|
pageIndex | number |
傳回頁面的索引 |
|
totalItems
|
totalItems | number |
請求所涉及的項目總數 |
組件
文件部分
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
內容類型
|
contentType | string |
內容類型 |
|
filename
|
filename | string |
filename |
|
雜湊
|
hash | string |
雜湊 |
|
size
|
size | integer |
size |
pdfSigField
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
影像高度
|
imageHeight | float |
影像高度 |
|
圖像頁面
|
imagePage | float |
圖像頁面 |
|
影像寬度
|
imageWidth | float |
影像寬度 |
|
imageX
|
imageX | float |
imageX |
|
影像Y
|
imageY | float |
影像Y |
簽名設定檔
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建
|
created | number |
建立日期 |
|
文件類型
|
documentType | string |
文件類型 |
|
強制捲動文件
|
forceScrollDocument | boolean |
強制簽署者捲動至文件底部 |
|
識別碼
|
id | string |
簽章設定檔ID |
|
isDefault
|
isDefault | boolean |
將此簽章設定檔設為預設設定檔 |
|
isDisabled （已禁用）
|
isDisabled | boolean |
停用此簽章設定檔 |
|
名稱
|
name | string |
簽章設定檔名稱 |
|
pdf簽名圖像文本
|
pdfSignatureImageText | string |
簽名墊中顯示的文字 |
|
pdf簽名圖像文本顏色
|
pdfSignatureImageTextColor | string |
singatures pad 中顯示的文字顏色 |
|
pdf簽名圖像文本大小
|
pdfSignatureImageTextSize | number |
singatures pad 中顯示的文字大小 |
|
pdfVisibleSignature模式
|
pdfVisibleSignatureMode | string |
可見簽名模式（允許、禁用、noImage） |
|
簽名類型
|
signatureType | string |
pades， xades， xadesDetached， xadesDetachedManifest， cades， helios |
|
tenantId
|
tenantId | string |
租用戶識別碼 |
|
更新
|
updated | number |
上次修改日期 |
signature設定檔
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
items
|
items | array of signatureProfile | |
|
項目每頁
|
itemsPerPage | number |
每頁項目數 |
|
頁面索引
|
pageIndex | number |
傳回頁面的索引 |
|
totalItems
|
totalItems | number |
請求所涉及的項目總數 |
使用者
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
批准允許
|
approveAllowed | boolean |
如果設為 true，使用者可以核准文件 |
|
country
|
country | string |
用戶的國家/地區 |
|
創建
|
created | integer |
建立日期 |
|
電子郵件
|
string |
第 個使用者的電子郵件 |
|
|
名字
|
firstName | string |
使用者的名字 |
|
groupId
|
groupId | string |
使用者群組的標識碼 |
|
識別碼
|
id | string |
使用者的識別碼 |
|
isDisabled （已禁用）
|
isDisabled | boolean |
如果為true，則使用者已停用 |
|
最後登入
|
lastLogin | integer |
使用者的上次登入日期 |
|
lastName
|
lastName | string |
使用者的姓氏 |
|
名稱
|
name | string |
使用者的姓名（名字+姓氏） |
|
組織職稱
|
organizationTitles | array of |
使用者在其組織中的功能 |
|
電話號碼
|
phoneNumber | string |
使用者的電話號碼 |
|
sign允許
|
signAllowed | boolean |
如果設為 true，則使用者可以簽署文件 |
|
主題
|
subject | string |
使用者的內部子代碼 |
|
tenantId
|
tenantId | string |
租戶的標識碼 |
|
更新
|
updated | integer |
上次修改日期 |
|
檢視授權群組
|
viewAuthorizedGroups | array of string |
使用者可以作為觀察者的群組清單 |
工作流程
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建
|
created | integer |
創建 |
|
currentRecipient電子郵件
|
currentRecipientEmails | array of |
currentRecipient電子郵件 |
|
currentRecipientUsers
|
currentRecipientUsers | array of |
currentRecipientUsers |
|
資料1
|
data1 | string |
中繼資料 1 |
|
資料2
|
data2 | string |
中繼資料 2 |
|
資料3
|
data3 | string |
中繼資料 3 |
|
資料4
|
data4 | string |
中繼資料 4 |
|
資料5
|
data5 | string |
中繼資料 5 |
|
資料6
|
data6 | string |
中繼資料 6 |
|
數據7
|
data7 | string |
中繼資料 7 |
|
資料8
|
data8 | string |
中繼資料 8 |
|
描述
|
description | string |
工作流程說明 |
|
電子郵件
|
string |
工作流程擁有者的電子郵件 |
|
|
名字
|
firstName | string |
工作流程擁有者的名字 |
|
groupId
|
groupId | string |
工作流程擁有者群組的識別碼 |
|
識別碼
|
id | string |
工作流程的識別碼 |
|
lastName
|
lastName | string |
工作流程擁有者的姓氏 |
|
layoutId
|
layoutId | string |
工作流程中繼資料版面配置的ID |
|
記錄
|
logs | array of |
記錄 wokflow 的項目 |
|
名稱
|
name | string |
工作流程擁有者的姓名 （名字 + 姓氏） |
|
通知事件
|
notifiedEvents | array of string |
工作流程通知的事件 Lis |
|
進展
|
progress | integer |
工作流程進度 （以百分比為單位） |
|
steps
|
steps | array of object |
steps |
|
允許註解
|
steps.allowComments | boolean |
允許/禁止在步驟上允許的互動式評論 |
|
隱藏附件
|
steps.hideAttachments | boolean |
控制簽署人附件的顯示 |
|
hideWorkflowRecipients
|
steps.hideWorkflowRecipients | boolean |
控制其他簽署者對簽署者的顯示 |
|
識別碼
|
steps.id | string |
步驟 ID |
|
invite期間
|
steps.invitePeriod | integer |
invite期間 |
|
已完成
|
steps.isFinished | boolean |
已完成 |
|
isStarted
|
steps.isStarted | boolean |
isStarted |
|
記錄
|
steps.logs | array of |
記錄 |
|
最大邀請
|
steps.maxInvites | integer |
最大邀請 |
|
收件人
|
steps.recipients | array of object |
收件人 |
|
consentPageId
|
steps.recipients.consentPageId | string |
consentPageId |
|
country
|
steps.recipients.country | string |
country |
|
電子郵件
|
steps.recipients.email | string |
電子郵件 |
|
名字
|
steps.recipients.firstName | string |
名字 |
|
lastName
|
steps.recipients.lastName | string |
lastName |
|
電話號碼
|
steps.recipients.phoneNumber | string |
電話號碼 |
|
userId
|
steps.recipients.userId | string |
userId |
|
required收件者
|
steps.requiredRecipients | integer |
required收件者 |
|
發送下載鏈接
|
steps.sendDownloadLink | boolean |
發送下載鏈接 |
|
步驟類型
|
steps.stepType | string |
步驟類型 |
|
有效期間
|
steps.validityPeriod | integer |
有效期間 |
|
tenantId
|
tenantId | string |
tenantId |
|
更新
|
updated | integer |
更新 |
|
userId
|
userId | string |
userId |
|
檢視授權群組
|
viewAuthorizedGroups | array of string |
使用者可以充當觀察者的群組清單 |
|
檢視授權使用者
|
viewAuthorizedUsers | array of string |
檢視授權使用者 |
|
watchers
|
watchers | array of object |
watchers |
|
電子郵件
|
watchers.email | string |
電子郵件 |
|
通知事件
|
watchers.notifiedEvents | array of string |
通知事件 |
|
userId
|
watchers.userId | string |
userId |
|
workflowStatus
|
workflowStatus | string |
workflowStatus |
workflows
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
items
|
items | array of workflow |
items |
|
項目每頁
|
itemsPerPage | integer |
項目每頁 |
|
頁面索引
|
pageIndex | integer |
頁面索引 |
|
totalItems
|
totalItems | integer |
totalItems |
二進位
這是基本數據類型 『binary』。