共用方式為


資訊分享

InfoShare 專為尋求優化管理數字文檔、信息、活頁夾和流程方式的企業而設計。

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

服務 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)
連絡人​​
名稱 Kendox 支援
URL https://kendox.com/en/service/support-services
Email support@kendox.com
連接器中繼資料
Publisher 肯多克斯股份公司
網站 https://www.kendox.com/en
隱私策略 https://www.kendox.com/en/about-us/data-protection
類別 通敵;內容和文件

Kendox InfoShare 連接器

Kendox InfoShare 提供功能強大且非常廣泛的 REST API。 使用此 API,您可以在 InfoShare 中建立和管理文件和流程。 與 Kendox InfoShare Power Automate 連接器一起,您可以簡化廣泛應用程式環境中的內容流程,從而避免資訊孤島。

Pre-requisites

您將需要以下內容才能繼續:

  • 使用此連接器的授權可透過 sales365@kendox.com取得。
  • Kendox InfoShare 具有可線上存取的 WCF 服務端點。
  • Kendox InfoShare 登入憑證。

支援的作業

連接器支援下列作業:

General

  • Logon:登入 InfoShare Server
  • Logon with hashed password:登入 InfoShare Server
  • Logoff:從 InfoShare Server 登入
  • Get documents and processes selection:透過自訂按鈕動作在行動網路用戶端上取得選取的檔案和程序

文件

  • Create document (deprecated):在 InfoShare 中建立文件,已棄用版本
  • Create document (V2):在 InfoShare 中建立文件,建議版本
  • Update document (deprecated):更新 InfoShare 中的文件,已棄用版本
  • Update document (V2):更新 InfoShare 中的文件,建議版本
  • Get document properties:從 InfoShare 取得文件的屬性
  • Get file content:從 InfoShare 取得檔案的內容
  • Get file content converted:將檔案的內容轉換為其他檔案格式 (e.g. tiff 轉換為 pdf)。 取得檔案內容,包括註解和疊加
  • Get document:從 InfoShare 傳回文件資訊 (結構)
  • Merge PDF documents:將兩個或多個 PDF 文件合併到目標文件

流程

  • Create process:建立並啟動流程
  • Update process (deprecated):更新 InfoShare 中的程序,已棄用版本
  • Update process (V2):更新 InfoShare 中的程序,建議版本
  • Close an open process:關閉 InfoShare 中的程序
  • Close task and continue process:關閉 InfoShare 中的流程任務
  • Close current task and assign user to next task:關閉流程任務並將使用者指派給 InfoShare 中的下一個任務
  • Get process:從 InfoShare 傳回流程資訊 (結構) 清單
  • Get process properties:從 InfoShare 取得程序的屬性
  • Document Search (deprecated):在 InfoShare 中搜尋文件,已棄用版本
  • Document Search (V2):在 InfoShare 中搜尋文件,建議版本
  • List processes (deprecated):取得 InfoShare 中的程序清單,取代為程序搜尋動作
  • Process search:在 InfoShare 中搜尋流程

使用者資料表

  • Create a user table:建立使用者表格
  • Get rows from a user table:從使用者資料表取得一些資料列
  • Insert rows into a user table:將列插入使用者表格
  • Update a row in a user table:將資料列更新為使用者表格
  • Delete user table rows:從使用者表格中刪除部分列

正在建立連線

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

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

預設

適用:所有地區

建立連線的參數。

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

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

節流限制

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

動作

Logoff

Logoff

Logon

Logon

使用雜湊密碼登入

使用雜湊密碼登入

列出處理程序 (已棄用) [已棄用]

列出程序 (已淘汰)

刪除使用者資料表資料列

刪除使用者資料表資料列

取得文件

取得文件

取得文件和流程選擇

通過自定義按鈕操作在移動 Web 客戶端上獲取選擇的文件和流程

取得文件屬性

取得文件屬性

取得檔案內容

取得檔案內容

取得流程

獲取進程

取得程序屬性

取得程序屬性

合併 PDF 文件

將兩個或多個 PDF 文件合併到一個文件中

將資料列插入使用者資料表

將表格列匯入使用者表格

建立使用者資料表

建立使用者資料表

建立文件 (V2)

建立文件 (V2)

建立文件 (已棄用) [已棄用]

建立文件 (已淘汰)

建立程序

建立程序

從使用者資料表取得資料列

從使用者資料表取得資料列

文件搜尋 (V2)

文件搜尋 (V2)

文件搜尋 (已棄用) [已棄用]

文件搜尋 (已淘汰)

更新使用者資料表中的資料列

更新使用者資料表中的資料列

更新文件 (V2)

更新文件 (V2)

更新文件 (已棄用) [已棄用]

更新文件 (已淘汰)

更新程序 (V2)

更新程序 (V2)

更新程序 (已淘汰) [已淘汰]

更新程序 (已淘汰)

流程搜尋

流程搜尋

轉換檔案內容

將文件內容轉換為不同的格式。 將註釋或疊加新增至檔案內容

關閉工作並繼續處理程序

關閉工作並繼續處理程序

關閉目前工作並將使用者指派給下一個工作

關閉目前工作並將使用者指派給下一個工作

關閉開啟的程序

關閉開啟的程序

Logoff

Logoff

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

傳回

名稱 路徑 類型 Description
登出結果
LogoffResult string

登出結果

Logon

Logon

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

使用者名
Username True string

登入的使用者名稱

密碼
Password True string

密碼

租戶名稱
Tenantname string

要登入的租用戶名稱

傳回

名稱 路徑 類型 Description
ConnectionId
connectionId string

如果成功登入,則包含連線 ID

連線逾時秒
connectionTimeoutSeconds integer

連線逾時

IsApplicationLicense(是應用程式授權)
isApplicationLicence string

是應用程式授權類型

是並行授權
isConcurrentLicence string

是並行授權類型

IsNamed授權
isNamedLicence string

名為授權類型

IsVerificationCode需要
isVerificationCodeNeeded string

需要驗證碼嗎

可能TwoWayAuthenticationType
possibleTwoWayAuthenticationType string

可能的雙向驗證類型 (無、郵件、簡訊)

雙向驗證目標郵件
twoWayAuthenticationTargetMail string

twoWayAuthentication 將郵件傳送到的遮罩郵件位址

使用雜湊密碼登入

使用雜湊密碼登入

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

使用者名
userName True string

登入的使用者名稱

雜湊密碼
passwordHashed True string

登入的使用者密碼 (Base64 編碼的 SHA 512 雜湊)

租戶名稱
tenantName string

要登入的租用戶名稱

傳回

名稱 路徑 類型 Description
ConnectionId
LogonResult.ConnectionId string

用於識別連線的連線識別碼

連線逾時秒
LogonResult.ConnectionTimeoutSeconds integer

連線逾時以秒為單位

IsApplicationLicense(是應用程式授權)
LogonResult.IsApplicationLicence boolean

是應用程式授權類型

是並行授權
LogonResult.IsConcurrentLicence boolean

是並行授權類型

IsNamed授權
LogonResult.IsNamedLicence boolean

是具名授權類型

IsVerificationCode需要
LogonResult.IsVerificationCodeNeeded boolean

需要驗證碼嗎

JWT托肯
LogonResult.JWTToken string

此連線的 JWT 記號

可能TwoWayAuthenticationType
LogonResult.PossibleTwoWayAuthenticationType string

可能的雙向驗證類型 (無、郵件、簡訊)

雙向驗證目標郵件
LogonResult.TwoWayAuthenticationTargetMail string

twoWayAuthentication 將郵件傳送到的遮罩郵件位址

列出處理程序 (已棄用) [已棄用]

列出程序 (已淘汰)

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

接收器
Receiver string

進程接收者的登入名稱(例如: john@sample.com|megan@sample.com)。 為空,登入使用者將被視為接收者

地位
Status string

進程狀態。 預設值 = 開啟

忽略接收器
IgnoreReceiver boolean

如果是,則會列出接收者獨立的所有處理程序。 預設值 = false

MaxSerch結果
MaxSerchResults string

進程搜尋結果數目上限。 預設值 = 100

傳回

名稱 路徑 類型 Description
processes
processes array of object

processes

accessRightsEnumList
processes.accessRightsEnumList array of string

accessRightsEnumList

CheckOutStateEnum
processes.checkOutStateEnum string

進程的簽出狀態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null)

CheckOutUserId
processes.checkOutUserId string

出庫文件之使用者的 ID

註解
processes.comments array of object

註解

Date
processes.comments.date string

評論日期

Id
processes.comments.id string

註解編號

文字
processes.comments.text string

使用者定義的註解

UserId
processes.comments.userId string

已設定註解的使用者識別碼

已完成日期
processes.completedDate string

程序的完成日期。 日期格式:yyyy-MM-ddTHH:mm:ss

completedTasks
processes.completedTasks array of object

completedTasks

行動
processes.completedTasks.action string

使用者的動作文字。 顯示給最終使用者

assignedUserId
processes.completedTasks.assignedUserIds array of

assignedUserId

註解
processes.completedTasks.comments array of object

註解

Date
processes.completedTasks.comments.date string

評論日期

Id
processes.completedTasks.comments.id string

註解編號

文字
processes.completedTasks.comments.text string

使用者定義的註解

UserId
processes.completedTasks.comments.userId string

已設定註解的使用者識別碼

已完成日期
processes.completedTasks.completedDate string

完成日期。 日期格式:yyyy-MM-ddTHH:mm:ss

completedUserIds
processes.completedTasks.completedUserIds array of string

completedUserIds

CreatedDate
processes.completedTasks.createdDate string

創建日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
processes.completedTasks.creatorId string

創建者的用戶 ID

Description
processes.completedTasks.description string

工作描述

截止日期
processes.completedTasks.dueDate string

任務的到期日。 日期格式:yyyy-MM-ddTHH:mm:ss

意圖使用者標識碼
processes.completedTasks.intendedUserIds array of

意圖使用者標識碼

提醒日期
processes.completedTasks.reminderDate string

提醒日期。 日期格式:yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
processes.completedTasks.requiresAllRecipients boolean

定義是否所有收件者都必須關閉此工作

顯示關閉工作對話框
processes.completedTasks.showCloseTaskDialog boolean

在工作結束時顯示關閉工作對話方塊

地位
processes.completedTasks.statusEnum string

任務狀態 (開啟、處理中、完成、準備完成、錯誤)

TaskTemplateId
processes.completedTasks.taskTemplateId string

工作範本識別碼

CreatedDate
processes.createdDate string

進程的建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

目前任務
processes.currentTask string

目前作用中工作

自訂屬性
processes.customProperties string

所有自訂屬性的清單

文件標識符
processes.documentIds string

所有附加文件ID的清單

截止日期
processes.dueDate string

處理程序的到期日日期格式:yyyy-MM-ddTHH:mm:ss

FolderElementId
processes.folderElementId string

進程的 ID 作為資料夾元素

哈斯鏈接
processes.hasLinks boolean

標示進程是否有連結

Id
processes.id string

進程的標識碼

values
processes.name.values array of object

values

文化特性 (Culture)
processes.name.values.culture string

文化特性 (Culture)

收發簡訊
processes.name.values.text string

收發簡訊

優先順序列舉
processes.priorityEnum string

進程優先順序 (高、正常、低)

插件流
processes.pluginStream string

外掛程式的資料容器

ProcessTemplateId
processes.processTemplateId string

程序範本識別碼

properties
processes.properties array of object

properties

propertyName
processes.properties.propertyName string

propertyName

屬性類型Id
processes.properties.propertyTypeId string

屬性類型Id

values
processes.properties.values array of string

values

保護網域標識符
processes.protectionDomainId string

進程的保護網域ID

StatusEnum
processes.statusEnum string

進程狀態 (開啟、InProcess、Complete、PreparedToComplete、Error)

有更多
hasMore boolean

表明是否存在更多結果。 如果有更多結果可用,旗標會設定為 true

簡歷點
resumePoint string

先前搜尋作業的繼續點。 為第一個搜尋作業設定 null

刪除使用者資料表資料列

刪除使用者資料表資料列

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

使用者資料表
UserTable True string

使用者資料表的名稱

Where子句
WhereClause string

SQL where 子句元素的清單。 格式:[<PropertyName>|<比較枚舉>|<屬性值>|<RelationEnum>]。 ComparisonEnums: “Equals,NotEquals,GreaterEquals,Less,LessEquals,Like,NotLike” RelationEnums:“AND,OR” (例如: [Firstname|等於|喬恩|AND],[姓氏|等於|母鹿|OR])

傳回

名稱 路徑 類型 Description
userTableDeleteRecords結果
userTableDeleteRecordsResult integer

userTableDeleteRecords結果

取得文件

取得文件

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
connectionId True string

用於識別連線的連線識別碼

DocumentId
documentId True string

文件識別碼

傳回

名稱 路徑 類型 Description
阿邦內特
GetDocumentResult.Abonnements array of object

阿邦內特

OnContent變更
GetDocumentResult.Abonnements.OnContentChange boolean

Abonnement 在檔案變更時處於作用中狀態

刪除時
GetDocumentResult.Abonnements.OnDelete boolean

刪除時 Abonnement 處於作用中狀態

OnMetadataChange
GetDocumentResult.Abonnements.OnMetadataChange boolean

Abonnement 在索引變更時處於活躍狀態

UserId
GetDocumentResult.Abonnements.UserId string

此帳戶的使用者 ID

存取權列舉清單
GetDocumentResult.AccessRightsEnumList array of string

accessRightsEnumList

PostIt註釋
GetDocumentResult.AnnotationManager.PostItAnnotations array of object

PostIt註釋

CreatedDate
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatedDate string

從便利貼註解建立日期

CreatorId
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatorId string

來自發布註釋的創建者的用戶 ID

是斜體
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsItalic boolean

字體是來自便利貼註釋的斜體嗎

是三振
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsStrikeOut boolean

字體是否從便利貼註釋中刪除

是底線
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsUnderline boolean

字體是否來自便利貼註釋的底線

名稱
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Name string

來自張貼註釋的字體名稱。 預設值 = Arial

Pitch
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Pitch integer

便利貼註釋的字體間距

大小
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Size integer

來自 post it 註釋的字體大小。 範例:大小:12 是 12000。 您需要因數 1000

Weight
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Weight integer

便利貼註釋的字體粗細

Id
GetDocumentResult.AnnotationManager.PostItAnnotations.Id string

便利貼註釋的標識碼

修改日期
GetDocumentResult.AnnotationManager.PostItAnnotations.ModifiedDate string

便利貼註釋的修改日期。 日期格式:yyyy-MM-ddTHH:mm:ss

頁碼
GetDocumentResult.AnnotationManager.PostItAnnotations.PageNumber integer

張貼註釋的頁數

SecurityLevel列舉
GetDocumentResult.AnnotationManager.PostItAnnotations.SecurityLevelEnum string

發布註釋的安全級別(PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 預設值 = PubliclyAvailable

可選擇
GetDocumentResult.AnnotationManager.PostItAnnotations.Selectable boolean

定義使用者是否可選取張貼註解

文字
GetDocumentResult.AnnotationManager.PostItAnnotations.Text string

用於發布註釋的用戶定義文本

X
GetDocumentResult.AnnotationManager.PostItAnnotations.X integer

X 座標 (以每英吋像素為單位) 表示 7200 DPI 的便利貼註解

GetDocumentResult.AnnotationManager.PostItAnnotations.Y integer

Y 座標 (以每英吋像素為單位) 的 7200 DPI 便利貼註釋

矩形註解
GetDocumentResult.AnnotationManager.RectangleAnnotations array of object

矩形註解

顏色
GetDocumentResult.AnnotationManager.RectangleAnnotations.Color integer

矩形註釋中的矩形 (32 位 ARGB 值) 的顏色。 範例:黑色:-16777216 白色:-1 紅色:-65536 綠色:-16744448 藍色:-16776961

顏色十六進制代碼
GetDocumentResult.AnnotationManager.RectangleAnnotations.ColorHexCode string

矩形註釋中的矩形(RGB 十六進位代碼)的顏色。 範例:黑色:#000000 白色:#FFFFFF 紅色:#FF0000 綠色:#008000 藍色:#0000FF

CreatedDate
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatedDate string

矩形註解的建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatorId string

CreatorId

高度
GetDocumentResult.AnnotationManager.RectangleAnnotations.Height integer

7200 DPI 的矩形高度 (以每英吋像素為單位)

Id
GetDocumentResult.AnnotationManager.RectangleAnnotations.Id string

矩形註解的標識碼

修改日期
GetDocumentResult.AnnotationManager.RectangleAnnotations.ModifiedDate string

矩形註解的修改日期。 日期格式:yyyy-MM-ddTHH:mm:ss

頁碼
GetDocumentResult.AnnotationManager.RectangleAnnotations.PageNumber integer

矩形註釋的頁數

SecurityLevel列舉
GetDocumentResult.AnnotationManager.RectangleAnnotations.SecurityLevelEnum string

矩形註釋的安全性層級 (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 預設值 = PubliclyAvailable

可選擇
GetDocumentResult.AnnotationManager.RectangleAnnotations.Selectable boolean

定義使用者是否可以選取矩形註解

Transparent
GetDocumentResult.AnnotationManager.RectangleAnnotations.Transparent boolean

矩形應該是透明的(突出顯示)

寬度
GetDocumentResult.AnnotationManager.RectangleAnnotations.Width integer

7200 DPI 的矩形寬度 (每英吋像素)

X
GetDocumentResult.AnnotationManager.RectangleAnnotations.X integer

來自矩形註解的 7200 DPI 的 X 座標 (以每英吋像素為單位)

GetDocumentResult.AnnotationManager.RectangleAnnotations.Y integer

來自矩形註解的 7200 DPI 的 Y 座標 (以每英吋像素為單位)

文字註釋
GetDocumentResult.AnnotationManager.TextAnnotations array of object

文字註釋

BackgroundColor
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColor integer

來自文字註解的背景顏色(32 位元 ARGB 值)。 範例:黑色:-16777216 白色:-1 紅色:-65536 綠色:-16744448 藍色:-16776961

背景顏色十六進制代碼
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColorHexCode string

文本註釋中的背景顏色(RGB 十六進制代碼)。 範例:黑色:#000000 白色:#FFFFFF 紅色:#FF0000 綠色:#008000 藍色:#0000FF

CreatedDate
GetDocumentResult.AnnotationManager.TextAnnotations.CreatedDate string

從文字註解建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
GetDocumentResult.AnnotationManager.TextAnnotations.CreatorId string

來自文字註釋的建立者使用者 ID

是斜體
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsItalic boolean

字體是否來自文字註釋的斜體

是三振
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsStrikeOut boolean

字體是否從文字註釋中刪除線

是底線
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsUnderline boolean

字型底線是否來自文字註解

名稱
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Name string

文字註解中的字型名稱。 預設值 = Arial

Pitch
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Pitch integer

文字註解的字體間距

大小
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Size integer

文本註釋的字體大小.. 範例:大小:12 是 12000。 您需要因數 1000

Weight
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Weight integer

文字註解的字體粗細

前景顏色
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColor integer

文字註解的前景色彩 (32 位元 ARGB 值)。 範例:黑色:-16777216 白色:-1 紅色:-65536 綠色:-16744448 藍色:-16776961

前景顏色十六進制代碼
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColorHexCode string

文本註釋中的前景顏色(RGB 十六進位代碼)。 範例:黑色:#000000 白色:#FFFFFF 紅色:#FF0000 綠色:#008000 藍色:#0000FF

高度
GetDocumentResult.AnnotationManager.TextAnnotations.Height integer

文字註解中 7200 DPI 的文字高度 (以每英吋像素為單位)

Id
GetDocumentResult.AnnotationManager.TextAnnotations.Id string

文字註解的標識碼

修改日期
GetDocumentResult.AnnotationManager.TextAnnotations.ModifiedDate string

文字註解的修改日期。 日期格式:yyyy-MM-ddTHH:mm:ss

頁碼
GetDocumentResult.AnnotationManager.TextAnnotations.PageNumber integer

文字註解的頁數

Rotation
GetDocumentResult.AnnotationManager.TextAnnotations.Rotation integer

從文字註解旋轉(以度數為單位)

SecurityLevel列舉
GetDocumentResult.AnnotationManager.TextAnnotations.SecurityLevelEnum string

文字註解的安全性層級 (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 預設值 = PubliclyAvailable

可選擇
GetDocumentResult.AnnotationManager.TextAnnotations.Selectable boolean

定義使用者是否可選取文字註解

文字
GetDocumentResult.AnnotationManager.TextAnnotations.Text string

使用者定義的文字註解文字

Transparent
GetDocumentResult.AnnotationManager.TextAnnotations.Transparent boolean

文字註解應該是透明的

寬度
GetDocumentResult.AnnotationManager.TextAnnotations.Width integer

文字註解中 7200 DPI 的文字寬度 (以每英吋像素為單位)

X
GetDocumentResult.AnnotationManager.TextAnnotations.X integer

來自文字註解的 7200 DPI 的 X 座標 (以每英吋像素為單位)

GetDocumentResult.AnnotationManager.TextAnnotations.Y integer

Y 座標 (以每英吋像素為單位) 表示,適用於文字批註的 7200 DPI

Blogs
GetDocumentResult.Blogs array of object

Blogs

CreatedDate
GetDocumentResult.Blogs.CreatedDate string

部落格的建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
GetDocumentResult.Blogs.CreatorId string

建立使用者部落格的使用者 ID

Id
GetDocumentResult.Blogs.Id string

部落格的 ID

文字
GetDocumentResult.Blogs.Text string

部落格項目的文字

CheckOutStateEnum
GetDocumentResult.CheckOutStateEnum string

文件的簽出狀態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null)

CheckOutUserId
GetDocumentResult.CheckOutUserId string

出庫文件之使用者的 ID

文件資料
GetDocumentResult.DocumentData array of object

文件資料

Id
GetDocumentResult.DocumentData.Id string

文件轉譯的標識碼

名稱
GetDocumentResult.DocumentData.Name string

轉譯的文件名稱

轉譯
GetDocumentResult.DocumentData.Renditions array of object

轉譯

內容保護
GetDocumentResult.DocumentData.Renditions.ContentProtections array of

內容保護

Extension
GetDocumentResult.DocumentData.Renditions.Extension string

Extension

檔案儲存體
GetDocumentResult.DocumentData.Renditions.Files array of object

檔案儲存體

Blob路徑
GetDocumentResult.DocumentData.Renditions.Files.BlobPath string

Blob路徑

BlobStoreId
GetDocumentResult.DocumentData.Renditions.Files.BlobStoreId string

BlobStoreId

雜湊值
GetDocumentResult.DocumentData.Renditions.HashValue array of integer

雜湊值

Id
GetDocumentResult.DocumentData.Renditions.Id string

Id

頁數
GetDocumentResult.DocumentData.Renditions.PageCount integer

頁數

大小
GetDocumentResult.DocumentData.Renditions.Size integer

大小

有疊加層
GetDocumentResult.HasOverlay boolean

定義文件是否應以重疊顯示

Id
GetDocumentResult.Id string

文件的 ID

ImportTemplateId
GetDocumentResult.ImportTemplateId string

此文件匯入範本的ID

InfoStoreId
GetDocumentResult.InfoStoreId string

資訊存放區的標識碼

CheckOutLifeCycleStateId
GetDocumentResult.LifeCycleManager.CheckOutLifeCycleStateId string

出庫生命週期狀態

生命週期結束日期
GetDocumentResult.LifeCycleManager.LifeCycleEndDate string

生命週期的計算結束日期。 日期格式:yyyy-MM-ddTHH:mm:ss

生命週期開始日期
GetDocumentResult.LifeCycleManager.LifeCycleStartDate string

生命週期的開始日期。 日期格式:yyyy-MM-ddTHH:mm:ss

LifeCycleStateId
GetDocumentResult.LifeCycleManager.LifeCycleStateId string

LifeCycle 狀態的 ID

下一個自動生命週期狀態標識符
GetDocumentResult.LifeCycleManager.NextAutomaticLifeCycleStateId string

下一個自動生命週期狀態

NextLifeCycle狀態
GetDocumentResult.LifeCycleManager.NextLifeCycleStates array of string

NextLifeCycle狀態

生命週期保護
GetDocumentResult.LifeCycleManager.LifeCycleProtections array of object

生命週期保護

DeleteAfterExpiration
GetDocumentResult.LifeCycleManager.LifeCycleProtections.DeleteAfterExpiration boolean

允許在保護到期後刪除文件

Id
GetDocumentResult.LifeCycleManager.LifeCycleProtections.Id string

生命週期狀態保護的標識碼

Protect註解變更
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectAnnotationChange boolean

防止註釋變更

保護結帳
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectCheckOut boolean

防止結帳

保護內容變更
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectContentChange boolean

防止內容變更

保護刪除
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectDelete boolean

防止刪除

保護屬性變更
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectPropertyChange boolean

防止財產變更

ProtectProtection網域變更
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectProtectionDomainChange boolean

防範安全性變更

ProtectionDurationTicks
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectionDurationTicks integer

保護期限

LifeCycleId
GetDocumentResult.LifeCycleManager.LifeCycleId string

LifeCycle 的 ID

主檔案長度
GetDocumentResult.MainFileLength integer

主要檔案大小

名稱
GetDocumentResult.Name string

文件名稱

頁數
GetDocumentResult.PageCount integer

主檔案的頁數

屬性
GetDocumentResult.Properties array of object

屬性

全球價值觀
GetDocumentResult.Properties.GlobalValues array of object

全球價值觀

價值觀
GetDocumentResult.Properties.GlobalValues.Values array of object

價值觀

文化特性
GetDocumentResult.Properties.GlobalValues.Values.Culture string

文化特性

文字
GetDocumentResult.Properties.GlobalValues.Values.Text string

文字

屬性類型標識符
GetDocumentResult.Properties.PropertyTypeId string

索引欄位的類型 ID

價值觀
GetDocumentResult.Properties.Values array of string

價值觀

保護網域標識符
GetDocumentResult.ProtectionDomainId string

保護網域的識別碼

提醒
GetDocumentResult.Reminders array of object

提醒

Description
GetDocumentResult.Reminders.Description string

提醒說明

間隔
GetDocumentResult.Reminders.Interval integer

提醒之間的間隔(以天為單位)

ProcessTemplateId
GetDocumentResult.Reminders.ProcessTemplateId string

此提醒的程序範本識別碼

提醒日期
GetDocumentResult.Reminders.ReminderDate string

提醒日期。 日期格式:yyyy-MM-ddTHH:mm:ss

提醒標識碼
GetDocumentResult.Reminders.ReminderId string

提醒的 ID

SubjectId
GetDocumentResult.Reminders.SubjectIds array of

subjectIds

使用UserFromProcessTemplate
GetDocumentResult.Reminders.UseUserFromProcessTemplate boolean

定義是否要使用流程範本中的使用者定義

工作階段計數
GetDocumentResult.SessionCount integer

工作階段計數

SigningProfileId
GetDocumentResult.SigningProfileId string

簽署設定檔的識別碼

版本標識碼
GetDocumentResult.VersionId string

文件的版本識別碼

取得文件和流程選擇

通過自定義按鈕操作在移動 Web 客戶端上獲取選擇的文件和流程

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

選擇標識碼
SelectionId True string

透過自訂按鈕動作在行動 Web 用戶端中選取文件和程序的選取 ID

傳回

名稱 路徑 類型 Description
識別碼
id string

選取 ID

識別碼
parentObjectId.id string

Mobile Web Client 中父物件的清單 ID

objectId
parentObjectId.objectId string

父物件的物件識別碼 (文件、進程,...)

objectTypeEnum
parentObjectId.objectTypeEnum string

父物件的 ObjectTypeEnum - 例如 Document、Process、...

物件標識符
objectIds array of object

行動 Web 用戶端中選取的文件和程序

識別碼
objectIds.id string

行動 Web 用戶端的清單 ID

objectId
objectIds.objectId string

Mobile Web Client 中所選文件或程序的物件 ID

objectTypeEnum
objectIds.objectTypeEnum string

ObjectTypeMobile Web Client 中所選文件或程序的列舉

allObjectId
allObjectIds array of object

Mobile Web Client 中選取和未選取的文件和程序

識別碼
allObjectIds.id string

行動 Web 用戶端的清單 ID

objectId
allObjectIds.objectId string

Mobile Web Client 中選取和未選取的文件或程序的物件 ID

objectTypeEnum
allObjectIds.objectTypeEnum string

ObjectTypeMobile Web Client 中所選和未選取的文件或程序的列舉

取得文件屬性

取得文件屬性

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

DocumentId
DocumentId True string

文件的 ID

文化特性
Culture string

提供屬性名稱的文化特性 (de、en、fr 等)。預設值 = de

傳回

名稱 路徑 類型 Description
array of object
全球值
globalValues array of object

全球值

values
globalValues.values array of object

values

文化特性 (Culture)
globalValues.values.culture string

文化特性

收發簡訊
globalValues.values.text string

文字

屬性名稱
propertyName string

物業名稱

屬性類型標識符
propertyTypeId string

索引欄位的類型 ID

values
values array of string

values

取得檔案內容

取得檔案內容

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

DocumentId
DocumentId True string

文件的 ID

版本標識碼
VersionId string

版本標識碼 (Guid)

DocumentDataId
DocumentDataId string

文件資料的標識碼 (Guid)

轉譯標識符
RenditionId string

文件轉譯的標識碼 (Guid)

忽略雜湊驗證
IgnoreHashValidation boolean

忽略雜湊驗證的系統組態。 預設值 = 是

傳回

檔案內容

檔案內容
string

取得流程

獲取進程

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
connectionId True string

用於識別連線的連線識別碼

ProcessId
processId True string

進程標識碼 (Guid)

傳回

名稱 路徑 類型 Description
存取權列舉清單
GetProcessResult.AccessRightsEnumList array of string

accessRightsEnumList

CheckOutStateEnum
GetProcessResult.CheckOutStateEnum string

文件的簽出狀態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null)

CheckOutUserId
GetProcessResult.CheckOutUserId string

簽出處理程序之使用者的識別碼

評論
GetProcessResult.Comments array of object

評論

Date
GetProcessResult.Comments.Date string

評論日期

Id
GetProcessResult.Comments.Id string

註解編號

文字
GetProcessResult.Comments.Text string

使用者定義的註解

UserId
GetProcessResult.Comments.UserId string

已設定註解的使用者識別碼

已完成日期
GetProcessResult.CompletedDate string

程序的完成日期。 日期格式:yyyy-MM-ddTHH:mm:ss

已完成任務
GetProcessResult.CompletedTasks array of object

已完成任務

行動
GetProcessResult.CompletedTasks.Action string

使用者的動作文字。 顯示給最終使用者

指派的使用者標識碼
GetProcessResult.CompletedTasks.AssignedUserIds array of

assignedUserId

評論
GetProcessResult.CompletedTasks.Comments array of object

評論

Date
GetProcessResult.CompletedTasks.Comments.Date string

評論日期

Id
GetProcessResult.CompletedTasks.Comments.Id string

註解編號

文字
GetProcessResult.CompletedTasks.Comments.Text string

使用者定義的註解

UserId
GetProcessResult.CompletedTasks.Comments.UserId string

已設定註解的使用者識別碼

已完成日期
GetProcessResult.CompletedTasks.CompletedDate string

完成日期。 日期格式:yyyy-MM-ddTHH:mm:ss

已完成使用者標識碼
GetProcessResult.CompletedTasks.CompletedUserIds array of string

completedUserIds

CreatedDate
GetProcessResult.CompletedTasks.CreatedDate string

創建日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
GetProcessResult.CompletedTasks.CreatorId string

創建者的用戶 ID

Description
GetProcessResult.CompletedTasks.Description string

工作描述

截止日期
GetProcessResult.CompletedTasks.DueDate string

任務的到期日。 日期格式:yyyy-MM-ddTHH:mm:ss

IntendedUserIds
GetProcessResult.CompletedTasks.IntendedUserIds array of

意圖使用者標識碼

提醒日期
GetProcessResult.CompletedTasks.ReminderDate string

提醒日期。 日期格式:yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
GetProcessResult.CompletedTasks.RequiresAllRecipients boolean

定義是否所有收件者都必須關閉此工作

顯示關閉工作對話框
GetProcessResult.CompletedTasks.ShowCloseTaskDialog boolean

在工作結束時顯示關閉工作對話方塊

地位
GetProcessResult.CompletedTasks.StatusEnum string

任務狀態 (開啟、處理中、完成、準備完成、錯誤)

TaskTemplateId
GetProcessResult.CompletedTasks.TaskTemplateId string

工作範本識別碼

CreatedDate
GetProcessResult.CreatedDate string

進程的建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

行動
GetProcessResult.CurrentTask.Action string

使用者的動作文字。 顯示給最終使用者

指派的使用者標識碼
GetProcessResult.CurrentTask.AssignedUserIds array of string

指派的使用者標識碼

評論
GetProcessResult.CurrentTask.Comments array of string

評論

已完成日期
GetProcessResult.CurrentTask.CompletedDate string

完成日期。 日期格式:yyyy-MM-ddTHH:mm:ss

已完成使用者標識碼
GetProcessResult.CurrentTask.CompletedUserIds array of string

已完成使用者標識碼

CreatedDate
GetProcessResult.CurrentTask.CreatedDate string

創建日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
GetProcessResult.CurrentTask.CreatorId string

創建者的用戶 ID

Description
GetProcessResult.CurrentTask.Description string

工作描述

截止日期
GetProcessResult.CurrentTask.DueDate string

任務的到期日。 日期格式:yyyy-MM-ddTHH:mm:ss

Id
GetProcessResult.CurrentTask.Id string

任務的標識碼

IntendedUserIds
GetProcessResult.CurrentTask.IntendedUserIds array of string

IntendedUserIds

提醒日期
GetProcessResult.CurrentTask.ReminderDate string

提醒日期。 日期格式:yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
GetProcessResult.CurrentTask.RequiresAllRecipients boolean

定義是否所有收件者都必須關閉此工作

顯示關閉工作對話框
GetProcessResult.CurrentTask.ShowCloseTaskDialog boolean

在工作結束時顯示關閉工作對話方塊

StatusEnum
GetProcessResult.CurrentTask.StatusEnum string

任務狀態 (開啟、處理中、完成、準備完成、錯誤)

TaskTemplateId
GetProcessResult.CurrentTask.TaskTemplateId string

工作範本識別碼

自訂屬性
GetProcessResult.CustomProperties array of object

自訂屬性

CustomPropertyTypeEnum
GetProcessResult.CustomProperties.CustomPropertyTypeEnum string

自訂屬性資料類型清單 (字串、日期、數字)

名稱
GetProcessResult.CustomProperties.Name string

自訂內容類型的名稱

價值觀
GetProcessResult.CustomProperties.Value string

自訂屬性類型的值

文件標識符
GetProcessResult.DocumentIds array of string

文件標識符

截止日期
GetProcessResult.DueDate string

該過程的截止日期。 日期格式:yyyy-MM-ddTHH:mm:ss

Id
GetProcessResult.Id string

進程的標識碼

價值觀
GetProcessResult.Name.Values array of object

價值觀

文化特性
GetProcessResult.Name.Values.Culture string

給出文本的文化(de、en、fr、...

文字
GetProcessResult.Name.Values.Text string

文字

插件流
GetProcessResult.PluginStream array of

插件流

優先順序列舉
GetProcessResult.PriorityEnum string

進程優先順序 (高、正常、低)

ProcessTemplateId
GetProcessResult.ProcessTemplateId string

程序範本識別碼

屬性
GetProcessResult.Properties array of object

屬性

全球價值觀
GetProcessResult.Properties.GlobalValues array of object

全球價值觀

價值觀
GetProcessResult.Properties.GlobalValues.Values array of object

價值觀

文化特性
GetProcessResult.Properties.GlobalValues.Values.Culture string

文化特性

文字
GetProcessResult.Properties.GlobalValues.Values.Text string

文字

屬性類型標識符
GetProcessResult.Properties.PropertyTypeId string

屬性類型 ID

價值觀
GetProcessResult.Properties.Values array of string

價值觀

保護網域標識符
GetProcessResult.ProtectionDomainId string

進程的保護網域ID

工作階段計數
GetProcessResult.SessionCount integer

工作階段計數

StatusEnum
GetProcessResult.StatusEnum string

進程狀態 (開啟、InProcess、Complete、PreparedToComplete、Error)

取得程序屬性

取得程序屬性

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

ProcessId
ProcessId True string

進程標識碼 (Guid)

文化特性
Culture string

提供屬性名稱的文化特性 (de、en、fr 等)。預設值 = de

傳回

名稱 路徑 類型 Description
array of object
屬性名稱
propertyName string

進程屬性名稱

屬性類型標識符
propertyTypeId string

屬性類型 ID

values
values array of string

values

合併 PDF 文件

將兩個或多個 PDF 文件合併到一個文件中

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

DocumentId
DocumentId True string

第一個 PDF 文檔的 ID,將使用新的合併內容創建一個新版本

DocumentIdToAppend
DocumentIdToAppend True string

將附加 (合併) 到第一個分號的文件 ID,即 '77b3c69d-7a9a-4083-9d75-83a5e6f3deca;82514f19-057c-484f-8ee2-c21df811a928'

強制復原結帳
ForceUndoCheckout boolean

視需要復原第一個PDF檔案的簽出。 預設值 = false

傳回

名稱 路徑 類型 Description
名稱
name string

文件名稱

識別碼
id string

文件標識碼

版本Id
versionId string

文件版本識別碼

currentVersionId
currentVersionId string

文件目前版本標識符

保護網域 ID
protectionDomainId string

文件保護網域識別碼

infoStoreId
infoStoreId string

InfoStore Id

checkOutState列舉
checkOutStateEnum string

出庫狀態列舉

checkOutUserId
checkOutUserId string

簽出使用者 ID

properties
properties array of object

屬性

屬性類型Id
properties.propertyTypeId string

PropertyType 標識符

values
properties.values array of string

PropertyType 值

全球值
properties.globalValues array of object

全球值

values
properties.globalValues.values array of object

values

文化特性 (Culture)
properties.globalValues.values.culture string

全球價值觀文化

收發簡訊
properties.globalValues.values.text string

全域值文字

屬性類型名稱
properties.propertyTypeName string

PropertyType 名稱

propertyName
properties.propertyName string

屬性名稱

importTemplateId
importTemplateId string

匯入範本識別碼

部落格
blogs array of object

Blogs

建立日期
blogs.createdDate string

部落格建立日期

創建者識別碼
blogs.creatorId string

部落格建立者 ID

收發簡訊
blogs.text string

博客文字

識別碼
blogs.id string

部落格 ID

accessRightsEnumList
accessRightsEnumList array of string

存取權限列舉清單

溫馨提示
reminders array of

提醒

頁數
pageCount integer

頁數

mainFile長度
mainFileLength integer

主要檔案長度

阿邦內門特
abonnements array of

阿邦內特

text註釋
annotationManager.textAnnotations array of

文字註釋

矩形註解
annotationManager.rectangleAnnotations array of

矩形註釋

postIt註釋
annotationManager.postItAnnotations array of

便利貼註釋

郵票註釋
annotationManager.stampAnnotations array of

戳記註釋

文件資料
documentData array of object

文件資料

識別碼
documentData.id string

文件資料ID

名稱
documentData.name string

文件資料名稱

轉譯
documentData.renditions array of object

轉譯

識別碼
documentData.renditions.id string

轉譯標識碼

size
documentData.renditions.size string

轉譯大小

files
documentData.renditions.files array of object

轉譯檔案

blobStoreId
documentData.renditions.files.blobStoreId string

轉譯 blob 存放區識別碼

blobPath (斑點路徑)
documentData.renditions.files.blobPath string

轉譯 blob 路徑

頁數
documentData.renditions.pageCount string

轉譯頁數

副檔名
documentData.renditions.extension string

轉譯延伸模組

雜湊值
documentData.renditions.hashValue array of integer

轉譯雜湊值

內容保護
documentData.renditions.contentProtections array of

轉譯內容保護

signingProfileId
signingProfileId string

簽署設定檔識別碼

lifeCycleId
lifeCycleManager.lifeCycleId string

生命週期識別碼

lifeCycleStateId
lifeCycleManager.lifeCycleStateId string

生命週期狀態識別碼

lifeCycleStartDate (生命週期開始日期)
lifeCycleManager.lifeCycleStartDate string

生命週期開始日期

lifeCycleEndDate
lifeCycleManager.lifeCycleEndDate string

生命週期結束日期

nextLifeCycle狀態
lifeCycleManager.nextLifeCycleStates array of

下一個生命週期狀態

checkOutLifeCycleStateId
lifeCycleManager.checkOutLifeCycleStateId string

取出生命週期狀態 ID

下一個自動生命週期狀態標識符
lifeCycleManager.nextAutomaticLifeCycleStateId string

下一個自動生命週期狀態 ID

lifeCycle保護
lifeCycleManager.lifeCycleProtections array of object

生命週期保護

識別碼
lifeCycleManager.lifeCycleProtections.id string

生命週期保護識別碼

protectionDurationTicks
lifeCycleManager.lifeCycleProtections.protectionDurationTicks integer

生命週期保護持續時間刻度

保護結帳
lifeCycleManager.lifeCycleProtections.protectCheckOut boolean

生命週期保護檢查

保護內容變更
lifeCycleManager.lifeCycleProtections.protectContentChange boolean

生命週期保護內容變更

保護屬性變更
lifeCycleManager.lifeCycleProtections.protectPropertyChange boolean

生命週期保護屬性變更

protectAnnotationChange
lifeCycleManager.lifeCycleProtections.protectAnnotationChange boolean

生命週期保護註解變更

protectProtectionDomainChange
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange boolean

生命週期保護保護網域變更

保護刪除
lifeCycleManager.lifeCycleProtections.protectDelete boolean

生命週期保護 刪除

deleteAfterExpiration
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration boolean

生命週期保護到期後刪除

有疊加層
hasOverlay boolean

有疊加層

工作階段計數
sessionCount integer

工作階段計數

has簽名
hasSignature boolean

有簽名

有博客
hasBlog boolean

有博客

has註釋
hasAnnotation boolean

有註釋

hasTempAccess
hasTempAccess boolean

具有臨時存取權限

有溫馨提示
hasReminders boolean

有提醒

has連結
hasLinks boolean

有鏈接

有阿博內門特
hasAbonnement boolean

有無罪

將資料列插入使用者資料表

將表格列匯入使用者表格

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

使用者資料表
UserTable True string

使用者資料表的名稱

價值觀
Values True string

要插入的列和欄值清單(例如:[John;麀;紐約],[彼得;召集;伯爾尼])

刪除所有值
DeleteAllValues boolean

定義是否要刪除 UserTable 中的所有值 (預設值 = false)

FirstRowContainsColumnHeaders
FirstRowContainsColumnHeaders boolean

定義 values 參數的第一列是否包含欄標題 (預設值 = false)

傳回

名稱 路徑 類型 Description
使用者表格
userTable string

使用者資料表的名稱

插入的列
insertedRows integer

插入的資料列數目

建立使用者資料表

建立使用者資料表

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

使用者資料表
UserTable True string

使用者資料表的名稱(例如:位址)

資料行標頭
ColumnHeaders True string

欄標題清單 (例如:名字、姓氏、城市)

傳回

名稱 路徑 類型 Description
使用者表格
userTable string

使用者資料表的名稱

建立文件 (V2)

建立文件 (V2)

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

文件標題
DocumentTitle True string

文件標題(包括擴展名)

匯入範本
ImportTemplate string

匯入範本名稱或 ID (如果空白) 則必須提供 InfoStore 和 ProtectionDomain 值。

文件屬性
DocumentProperties string

文件屬性插入格式:Firstname=Peter|姓氏=穆勒|發票編號=4711;4712;4713

部落格
Blog string

在文件上新增部落格文字項目

文化特性
Culture string

提供屬性名稱的文化特性 (de、en、fr 等)。預設值 = de

資訊商店
InfoStore string

如果 ImportTemplate 是空的,則必須提供 InfoStore 名稱或 ID

生命週期
LifeCycle string

生命週期名稱或識別碼

保護網域
ProtectionDomain string

ProtectionDomain Name 或 Id,如果 ImportTemplate 是空的,則必須提供

上傳方法
UploadMethod string

將文件上傳至 InfoShare 時所用的方法。 預設值 = UploadFileBytesLarge

原始檔案格式
OriginalFileFormat string

用於轉換目的的原始檔案格式,例如「html」。 轉換為 pdf

區塊大小
ChunkSize integer

與 UploadStreamChunks 和 UploadFileBytesLarge 上傳方法搭配使用的檔案上傳區塊大小,預設

檔案內容
FileContent True string

檔案內容 base64 字串

傳回

名稱 路徑 類型 Description
名稱
name string

名稱

識別碼
id string

文件標識碼

版本Id
versionId string

版本標識碼

currentVersionId
currentVersionId string

目前版本標識符

保護網域 ID
protectionDomainId string

保護網域識別碼

infoStoreId
infoStoreId string

InfoStore Id

checkOutState列舉
checkOutStateEnum string

文件的簽出狀態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null)

checkOutUserId
checkOutUserId string

已簽出使用者 ID

properties
properties array of object

屬性

屬性類型Id
properties.propertyTypeId string

PropertyType 標識符

values
properties.values array of string

PropertyType 值

全球值
properties.globalValues array of object

全球價值觀

values
properties.globalValues.values array of object

values

文化特性 (Culture)
properties.globalValues.values.culture string

全球價值文化

收發簡訊
properties.globalValues.values.text string

全域值文字

屬性類型名稱
properties.propertyTypeName string

PropertyType 名稱

propertyName
properties.propertyName string

屬性名稱

importTemplateId
importTemplateId string

匯入範本識別碼

部落格
blogs array of object

部落格

建立日期
blogs.createdDate string

部落格建立日期

創建者識別碼
blogs.creatorId string

部落格建立者 ID

收發簡訊
blogs.text string

博客文字

識別碼
blogs.id string

部落格的 ID

accessRightsEnumList
accessRightsEnumList array of string

accessRightsEnumList

溫馨提示
reminders array of

提醒

頁數
pageCount integer

頁數

mainFile長度
mainFileLength integer

主要檔案長度

阿邦內門特
abonnements array of

阿邦內特

text註釋
annotationManager.textAnnotations array of

註解文字

矩形註解
annotationManager.rectangleAnnotations array of

註釋矩形

postIt註釋
annotationManager.postItAnnotations array of

註釋張貼

郵票註釋
annotationManager.stampAnnotations array of

註釋戳記

文件資料
documentData array of object

文件資料

識別碼
documentData.id string

文件資料識別碼

名稱
documentData.name string

文件資料名稱

轉譯
documentData.renditions array of object

轉譯

識別碼
documentData.renditions.id string

轉譯標識碼

size
documentData.renditions.size string

轉譯大小

files
documentData.renditions.files array of object

files

blobStoreId
documentData.renditions.files.blobStoreId string

Blob 存放區識別碼

blobPath (斑點路徑)
documentData.renditions.files.blobPath string

Blob 路徑

頁數
documentData.renditions.pageCount string

轉譯頁數

副檔名
documentData.renditions.extension string

轉譯延伸模組

雜湊值
documentData.renditions.hashValue array of integer

轉譯雜湊值

內容保護
documentData.renditions.contentProtections array of

轉譯內容保護

signingProfileId
signingProfileId string

簽署設定檔識別碼

lifeCycleId
lifeCycleManager.lifeCycleId string

生命週期識別碼

lifeCycleStateId
lifeCycleManager.lifeCycleStateId string

生命週期狀態識別碼

lifeCycleStartDate (生命週期開始日期)
lifeCycleManager.lifeCycleStartDate string

生命週期開始日期

lifeCycleEndDate
lifeCycleManager.lifeCycleEndDate string

生命週期結束日期

nextLifeCycle狀態
lifeCycleManager.nextLifeCycleStates array of

下一個生命週期狀態

checkOutLifeCycleStateId
lifeCycleManager.checkOutLifeCycleStateId string

取出生命週期狀態 ID

下一個自動生命週期狀態標識符
lifeCycleManager.nextAutomaticLifeCycleStateId string

下一個自動生命週期狀態 ID

lifeCycle保護
lifeCycleManager.lifeCycleProtections array of object

生命週期保護

識別碼
lifeCycleManager.lifeCycleProtections.id string

生命週期保護識別碼

protectionDurationTicks
lifeCycleManager.lifeCycleProtections.protectionDurationTicks integer

生命週期保護持續時間刻度

保護結帳
lifeCycleManager.lifeCycleProtections.protectCheckOut boolean

生命週期保護 checkout

保護內容變更
lifeCycleManager.lifeCycleProtections.protectContentChange boolean

生命週期保護內容變更

保護屬性變更
lifeCycleManager.lifeCycleProtections.protectPropertyChange boolean

生命週期保護財產變更

protectAnnotationChange
lifeCycleManager.lifeCycleProtections.protectAnnotationChange boolean

生命週期保護註釋變更

protectProtectionDomainChange
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange boolean

生命週期保護保護網域變更

保護刪除
lifeCycleManager.lifeCycleProtections.protectDelete boolean

生命週期保護刪除

deleteAfterExpiration
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration boolean

到期後的生命週期刪除

有疊加層
hasOverlay boolean

有疊加層

工作階段計數
sessionCount integer

工作階段計數

has簽名
hasSignature boolean

有簽名

有博客
hasBlog boolean

有博客

has註釋
hasAnnotation boolean

有註釋

hasTempAccess
hasTempAccess boolean

具有臨時存取權限

有溫馨提示
hasReminders boolean

有提醒

has連結
hasLinks boolean

有鏈接

有阿博內門特
hasAbonnement boolean

有無罪

建立文件 (已棄用) [已棄用]

建立文件 (已淘汰)

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

文件標題
DocumentTitle True string

文件標題(包括擴展名)

匯入範本
ImportTemplate True string

匯入範本

文件屬性
DocumentProperties string

文件屬性插入格式:Firstname=Peter|姓氏=穆勒|發票編號=4711;4712;4713

文化特性
Culture string

提供屬性名稱的文化特性 (de、en、fr 等)。預設值 = de

檔案內容
FileContent True string

檔案內容 base64 字串

傳回

名稱 路徑 類型 Description
阿邦內門特
abonnements array of string

阿邦內門特

accessRightsEnumList
accessRightsEnumList array of string

accessRightsEnumList

postIt註釋
annotationManager.postItAnnotations array of object

postIt註釋

CreatedDate
annotationManager.postItAnnotations.createdDate string

從便利貼註解建立日期

CreatorId
annotationManager.postItAnnotations.creatorId string

來自發布註釋的創建者的用戶 ID

是斜體
annotationManager.postItAnnotations.fontInfo.isItalic boolean

字體是來自便利貼註釋的斜體嗎

是三振
annotationManager.postItAnnotations.fontInfo.isStrikeOut boolean

字體是否從便利貼註釋中刪除

是底線
annotationManager.postItAnnotations.fontInfo.isUnderline boolean

字體是否來自便利貼註釋的底線

名稱
annotationManager.postItAnnotations.fontInfo.name string

來自張貼註釋的字體名稱。 預設值 = Arial

Pitch
annotationManager.postItAnnotations.fontInfo.pitch integer

便利貼註釋的字體間距

大小
annotationManager.postItAnnotations.fontInfo.size integer

來自 post it 註釋的字體大小。 範例:大小:12 是 12000。 您需要因數 1000

Weight
annotationManager.postItAnnotations.fontInfo.weight integer

便利貼註釋的字體粗細

Id
annotationManager.postItAnnotations.id string

便利貼註釋的標識碼

修改日期
annotationManager.postItAnnotations.modifiedDate string

便利貼註釋的修改日期。 日期格式:yyyy-MM-ddTHH:mm:ss

頁碼
annotationManager.postItAnnotations.pageNumber integer

張貼註釋的頁數

SecurityLevel列舉
annotationManager.postItAnnotations.securityLevelEnum string

發布註釋的安全級別(PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 預設值 = PubliclyAvailable

可選擇
annotationManager.postItAnnotations.selectable boolean

定義使用者是否可選取張貼註解

文字
annotationManager.postItAnnotations.text string

用於發布註釋的用戶定義文本

X
annotationManager.postItAnnotations.x integer

X 座標 (以每英吋像素為單位) 表示 7200 DPI 的便利貼註解

annotationManager.postItAnnotations.y integer

Y 座標 (以每英吋像素為單位) 的 7200 DPI 便利貼註釋

矩形註解
annotationManager.rectangleAnnotations array of object

矩形註解

顏色
annotationManager.rectangleAnnotations.color integer

矩形註釋中的矩形顏色(32 位 ARGB 值)示例:黑色:-16777216 白色:-1 紅色:-65536 綠色:-16744448 藍色:-16776961

顏色十六進制代碼
annotationManager.rectangleAnnotations.colorHexCode string

矩形註釋中的矩形(RGB 十六進位代碼)的顏色。 範例:黑色:#000000 白色:#FFFFFF 紅色:#FF0000 綠色:#008000 藍色:#0000FF

CreatedDate
annotationManager.rectangleAnnotations.createdDate string

矩形註解的建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

創建者識別碼
annotationManager.rectangleAnnotations.creatorId string

CreatorId

高度
annotationManager.rectangleAnnotations.height integer

7200 DPI 的矩形高度 (以每英吋像素為單位)

Id
annotationManager.rectangleAnnotations.Id string

矩形註解的標識碼

修改日期
annotationManager.rectangleAnnotations.modifiedDate string

矩形註解的修改日期。 日期格式:yyyy-MM-ddTHH:mm:ss

頁碼
annotationManager.rectangleAnnotations.pageNumber integer

矩形註釋的頁數

SecurityLevel列舉
annotationManager.rectangleAnnotations.securityLevelEnum string

矩形註釋的安全性層級 (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 預設值 = PubliclyAvailable

可選擇
annotationManager.rectangleAnnotations.selectable boolean

定義使用者是否可以選取矩形註解

Transparent
annotationManager.rectangleAnnotations.transparent boolean

矩形應該是透明的(突出顯示)

寬度
annotationManager.rectangleAnnotations.width integer

7200 DPI 的矩形寬度 (每英吋像素)

X
annotationManager.rectangleAnnotations.x integer

來自矩形註解的 7200 DPI 的 X 座標 (以每英吋像素為單位)

annotationManager.rectangleAnnotations.y integer

來自矩形註解的 7200 DPI 的 Y 座標 (以每英吋像素為單位)

text註釋
annotationManager.textAnnotations array of object

text註釋

BackgroundColor
annotationManager.textAnnotations.backgroundColor integer

文本註釋的背景顏色(32 位 ARGB 值)示例:黑色:-16777216 白色:-1 紅色:-65536 綠色:-16744448 藍色:-16776961

背景顏色十六進制代碼
annotationManager.textAnnotations.backgroundColorHexCode string

來自文本註釋的背景顏色(RGB 十六進制代碼)示例:黑色:#000000 白色:#FFFFFF 紅色:#FF0000 綠色:#008000 藍色:#0000FF

CreatedDate
annotationManager.textAnnotations.createdDate string

從文字註解建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
annotationManager.textAnnotations.creatorId string

來自文字註釋的建立者使用者 ID

是斜體
annotationManager.textAnnotations.fontInfo.isItalic boolean

字體是否來自文字註釋的斜體

是三振
annotationManager.textAnnotations.fontInfo.isStrikeOut boolean

字體是否從文字註釋中刪除線

是底線
annotationManager.textAnnotations.fontInfo.isUnderline boolean

字型底線是否來自文字註解

名稱
annotationManager.textAnnotations.fontInfo.name string

文字註解中的字型名稱。 預設值 = Arial

Pitch
annotationManager.textAnnotations.fontInfo.pitch integer

文字註解的字體間距

大小
annotationManager.textAnnotations.fontInfo.size integer

文字註解的字型大小。 範例:大小:12 是 12000。 您需要因數 1000

Weight
annotationManager.textAnnotations.fontInfo.weight integer

文字註解的字體粗細

前景顏色
annotationManager.textAnnotations.foregroundColor integer

文字註解的前景色彩 (32 位元 ARGB 值)。 範例:黑色:-16777216 白色:-1 紅色:-65536 綠色:-16744448 藍色:-16776961

前景顏色十六進制代碼
annotationManager.textAnnotations.foregroundColorHexCode string

文本註釋中的前景顏色(RGB 十六進位代碼)。 範例:黑色:#000000 白色:#FFFFFF 紅色:#FF0000 綠色:#008000 藍色:#0000FF

高度
annotationManager.textAnnotations.height integer

文字註解中 7200 DPI 的文字高度 (以每英吋像素為單位)

Id
annotationManager.textAnnotations.id string

文字註解的標識碼

修改日期
annotationManager.textAnnotations.modifiedDate string

文字註解的修改日期。 日期格式:yyyy-MM-ddTHH:mm:ss

頁碼
annotationManager.textAnnotations.pageNumber integer

文字註解的頁數

Rotation
annotationManager.textAnnotations.rotation integer

從文字註解旋轉(以度數為單位)

SecurityLevel列舉
annotationManager.textAnnotations.securityLevelEnum string

文字註解的安全性層級 (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 預設值 = PubliclyAvailable

可選擇
annotationManager.textAnnotations.selectable boolean

定義使用者是否可選取文字註解

文字
annotationManager.textAnnotations.text string

使用者定義的文字註解文字

Transparent
annotationManager.textAnnotations.transparent boolean

文字註解應該是透明的

寬度
annotationManager.textAnnotations.width integer

文字註解中 7200 DPI 的文字寬度 (以每英吋像素為單位)

X
annotationManager.textAnnotations.x integer

來自文字註解的 7200 DPI 的 X 座標 (以每英吋像素為單位)

annotationManager.textAnnotations.y integer

Y 座標 (以每英吋像素為單位) 表示,適用於文字批註的 7200 DPI

部落格
blogs array of object

部落格

Blogs
blogs object

所有部落格項目清單

CheckOut狀態
checkOutStateEnum string

文件的簽出狀態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null)

CheckOutUserId
checkOutUserId string

出庫文件之使用者的 ID

文件資料
documentData array of object

文件資料

Id
documentData.id string

文件轉譯的標識碼

名稱
documentData.name string

轉譯的文件名稱

轉譯
documentData.renditions array of

轉譯

有疊加層
hasOverlay boolean

定義文件是否應以重疊顯示

Id
id string

文件的 ID

ImportTemplateId
importTemplateId string

此文件匯入範本的ID

InfoStoreId
infoStoreId string

資訊存放區的標識碼

CheckOutLifeCycleStateId
lifeCycleManager.checkOutLifeCycleStateId string

出庫生命週期狀態

生命週期結束日期
lifeCycleManager.lifeCycleEndDate string

生命週期的計算結束日期。 日期格式:yyyy-MM-ddTHH:mm:ss

生命週期開始日期
lifeCycleManager.lifeCycleStartDate string

生命週期的開始日期。 日期格式:yyyy-MM-ddTHH:mm:ss

LifeCycleStateId
lifeCycleManager.lifeCycleStateId string

LifeCycle 狀態的 ID

下一個自動生命週期狀態標識符
lifeCycleManager.nextAutomaticLifeCycleStateId string

下一個自動生命週期狀態

nextLifeCycle狀態
lifeCycleManager.nextLifeCycleStates array of string

nextLifeCycle狀態

lifeCycle保護
lifeCycleManager.lifeCycleProtections array of object

lifeCycle保護

DeleteAfterExpiration
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration boolean

允許在保護到期後刪除文件

Id
lifeCycleManager.lifeCycleProtections.id string

生命週期狀態保護的標識碼

Protect註解變更
lifeCycleManager.lifeCycleProtections.protectAnnotationChange boolean

防止註釋變更

保護結帳
lifeCycleManager.lifeCycleProtections.protectCheckOut boolean

防止結帳

保護內容變更
lifeCycleManager.lifeCycleProtections.protectContentChange boolean

防止內容變更

保護刪除
lifeCycleManager.lifeCycleProtections.protectDelete boolean

防止刪除

保護屬性變更
lifeCycleManager.lifeCycleProtections.protectPropertyChange boolean

防止財產變更

ProtectProtection網域變更
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange boolean

防範安全性變更

ProtectionDurationTicks
lifeCycleManager.lifeCycleProtections.protectionDurationTicks integer

保護期限

LifeCycleId
lifeCycleManager.lifeCycleId string

LifeCycle 的 ID

主檔案長度
mainFileLength integer

主要檔案大小

名稱
name string

文件名稱

頁數
pageCount integer

主檔案的頁數

properties
properties array of object

properties

全球值
properties.globalValues array of object

全球值

values
properties.globalValues.values array of object

values

文化特性 (Culture)
properties.globalValues.values.culture string

文化特性

收發簡訊
properties.globalValues.values.text string

文字

屬性類型標識符
properties.propertyTypeId string

索引欄位的類型 ID

values
properties.values array of string

PropertyType 值

保護網域標識符
protectionDomainId string

保護網域的識別碼

溫馨提示
reminders array of object

溫馨提示

提醒
reminders object

所有提醒事項列表

工作階段計數
sessionCount integer

工作階段計數

SigningProfileId
signingProfileId string

簽署設定檔的識別碼

版本標識碼
versionId string

文件的版本識別碼

建立程序

建立程序

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

Process屬性
ProcessProperties string

流程屬性更新格式:Firstname=Peter|姓氏=穆勒|發票編號=4711;4712;4713

自訂屬性
CustomProperties string

自訂屬性。 格式:[<PropertyName>|<屬性值>|PropertyType] (例如 [Supplier|集結|字串][發票日期|2021-01-29T13:05:45 |日期][發票號碼|4711|編號])

文件標識符
DocumentIds string

要附加的所有文件 ID 清單

ProcessTemplateName (進程範本名稱)
ProcessTemplateName True string

程序範本名稱

截止日期
DueDate string

該過程的截止日期。 日期格式:yyyy-MM-ddTHH:mm:ss。 預設值 = 目前日期

Priority
Priority string

進程的優先順序(例如低、正常、高)。 預設值 = 正常

評論
Comment string

流程註解

文化特性
Culture string

給出文本的文化(de、en、fr 等)。預設值 = de

傳回

名稱 路徑 類型 Description
accessRightsEnumList
accessRightsEnumList array of string

accessRightsEnumList

CheckOut狀態
checkOutStateEnum string

文件的簽出狀態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null)

CheckOutUserId
checkOutUserId string

簽出處理程序之使用者的識別碼

註解
comments array of object

註解

Date
comments.date string

評論日期

Id
comments.id string

註解編號

文字
comments.text string

使用者定義的註解

UserId
comments.userId string

使用者 ID

已完成日期
completedDate string

完成日期。 日期格式:yyyy-MM-ddTHH:mm:ss

completedTasks
completedTasks array of string

completedTasks

CreatedDate
createdDate string

創建日期。 日期格式:yyyy-MM-ddTHH:mm:ss

行動
currentTask.action string

使用者的動作文字。 顯示給最終使用者

assignedUserId
currentTask.assignedUserIds array of string

assignedUserId

註解
currentTask.comments array of string

註解

已完成日期
currentTask.completedDate string

目前任務的完成日期。 日期格式:yyyy-MM-ddTHH:mm:ss

completedUserIds
currentTask.completedUserIds array of string

completedUserIds

CreatedDate
currentTask.createdDate string

目前任務的建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
currentTask.creatorId string

目前任務的建立者使用者 ID

Description
currentTask.description string

目前任務的描述

截止日期
currentTask.dueDate string

目前任務的到期日。 日期格式:yyyy-MM-ddTHH:mm:ss

意圖使用者標識碼
currentTask.intendedUserIds array of string

意圖使用者標識碼

提醒日期
currentTask.reminderDate string

提醒當前任務的日期。 日期格式:yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
currentTask.requiresAllRecipients boolean

定義是否所有收件者都必須關閉此工作

顯示關閉工作對話框
currentTask.showCloseTaskDialog boolean

在工作結束時顯示關閉工作對話方塊

StatusEnum
currentTask.statusEnum string

狀態目前工作 (開啟、處理中、完成、準備完成、錯誤)

TaskTemplateId
currentTask.taskTemplateId string

目前任務的範本ID

customProperties
customProperties array of object

customProperties

CustomPropertyTypeEnum
customProperties.customPropertyTypeEnum string

自訂屬性類型列舉值 (字串、日期、數字)

名稱
customProperties.name string

自訂屬性的名稱

價值觀
customProperties.value string

自訂屬性的值

文件標識符
documentIds array of string

文件標識符

截止日期
dueDate string

該過程的截止日期。 日期格式:yyyy-MM-ddTHH:mm:ss

FolderElementId
folderElementId string

文件的 ID 作為資料夾元素

哈斯鏈接
hasLinks boolean

文件的 ID 作為資料夾元素

Id
id string

進程識別碼

values
name.values array of object

values

文化特性
name.values.culture string

給出文本的文化(de、en、fr、...

文字
name.values.text string

此語言的文字

優先順序列舉
priorityEnum string

進程優先順序 (高、正常、低)。 預設值 = 正常

插件流
pluginStream string
ProcessTemplateId
processTemplateId string

程序範本識別碼

properties
properties array of object

properties

全球值
properties.globalValues array of object

全球值

values
properties.globalValues.values array of object

values

文化特性 (Culture)
properties.globalValues.values.culture string

文化特性 (Culture)

收發簡訊
properties.globalValues.values.text string

收發簡訊

屬性名稱
properties.propertyName string

程序屬性的名稱

屬性類型標識符
properties.propertyTypeId string

進程屬性的標識碼

values
properties.values array of string

values

保護網域標識符
protectionDomainId string

進程的保護網域ID

StatusEnum
statusEnum string

進程狀態 (開啟、InProcess、Complete、PreparedToComplete、Error)

從使用者資料表取得資料列

從使用者資料表取得資料列

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

使用者資料表
UserTable True string

使用者資料表的名稱

Where子句
WhereClause string

SQL where 子句元素的清單。 格式:[<ColumnName>|<比較枚舉>|<屬性值>|<RelationEnum>]。 ComparisonEnums: “Equals,NotEquals,GreaterEquals,Less,LessEquals,Like,NotLike” RelationEnums:“AND,OR” (例如: [Firstname|等於|喬恩|AND],[姓氏|等於|無名氏|和])

OrderBy子句
OrderByClause string

SQL order by 子句元素的清單 (例如:Firstname[ASC]、City[DESC])

新增資料行標頭
AddColumnHeaders boolean

將欄標題新增為第一列 (預設值 = false)

傳回

名稱 路徑 類型 Description
UserTableGetRecords結果
UserTableGetRecordsResult array of array

UserTableGetRecords結果

items
UserTableGetRecordsResult array of string

文件搜尋 (V2)

文件搜尋 (V2)

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

Conditions
Conditions string

搜尋條件格式:[<PropertyName>|<比較枚舉>|<屬性值>|<RelationEnum>]。 ComparisonEnums: “Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn,Between” RelationEnums:“And,Or”。 例如:[最後入住|收少|2021-12-31|和],[名字|等於|彼得|和],[日期|之間|2021-12-31;2022-12-31|並且]

MaxSerch結果
MaxSerchResults string

文件搜尋結果數目上限。 預設值 = 100

結果屬性
ResultProperties string

結果屬性清單,逗號分隔。 可以是屬性名稱或識別碼,例如「名稱,上次簽入,68b901cd-4d8f-11e6-aa6f-00ff04d7e62a」

文化特性
Culture string

給出文本的文化(de、en、fr 等)。預設值 = de

Stores
Stores string

要搜索的信息商店的逗號分隔列表。 可以是存放區名稱或 ID,例如「Standard,9cd306e3-7e96-486c-8280-65d9f0239776」

傳回

名稱 路徑 類型 Description
documents array of object

文件搜尋結果

名稱
documents.name string

文件名稱

識別碼
documents.id string

文件 ID

folderElementId
documents.folderElementId string

資料夾元素識別碼

checkOutState列舉
documents.checkOutStateEnum string

出庫狀態列舉

has簽名
documents.hasSignature boolean

有簽名

有博客
documents.hasBlog boolean

有博客

has註釋
documents.hasAnnotation boolean

有註釋

has連結
documents.hasLinks boolean

有鏈接

properties
documents.properties array of object

屬性

屬性類型Id
documents.properties.propertyTypeId string

PropertyType 標識符

values
documents.properties.values array of string

屬性類型值

全球值
documents.properties.globalValues array of object

全球價值觀

values
documents.properties.globalValues.values array of object

values

文化特性 (Culture)
documents.properties.globalValues.values.culture string

全球價值觀文化

收發簡訊
documents.properties.globalValues.values.text string

全域值文字

屬性類型名稱
documents.properties.propertyTypeName string

PropertyType 名稱

propertyName
documents.properties.propertyName string

屬性名稱

hasTempAccess
documents.hasTempAccess boolean

具有臨時存取權限

accessRightsEnumList
documents.accessRightsEnumList array of string

存取權限列舉清單

mainFile長度
documents.mainFileLength integer

主要檔案長度

版本Id
documents.versionId string

版本標識碼

有溫馨提示
documents.hasReminders boolean

有提醒

有阿博內門特
documents.hasAbonnement boolean

有無罪

有疊加層
documents.hasOverlay boolean

Oas 覆蓋層

有更多
hasMore boolean

還有更多

resumePoint
resumePoint string

簡歷點

文件搜尋 (已棄用) [已棄用]

文件搜尋 (已淘汰)

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

Conditions
Conditions string

搜尋條件格式:[<PropertyName>|<比較枚舉>|<屬性值>|<RelationEnum>]。 ComparisonEnums: “Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn” RelationEnums:“And,Or”。 例如:[最後入住|收少|2021-12-31|和],[名字|等於|彼得|並且]

文化特性
Culture string

文化 (de,en,fr,...)。預設值 = de

全文詞語
FulltextWords string

要用全文搜索的單詞

全文詞關係
FulltextWordRelation string

全文單字關係 (AND、OR)。 預設值 = AND

MaxSerch結果
MaxSerchResults string

文件搜尋結果數目上限。 預設值 = 100

傳回

名稱 路徑 類型 Description
documents array of object

阿邦內特
documents.abonnements string

棄權名單

accessRightsEnumList
documents.accessRightsEnumList array of string

accessRightsEnumList

註釋管理員
documents.annotationManager string

主要文件檔案的註解

Blogs
documents.blogs string

所有部落格項目清單

CheckOut狀態
documents.checkOutStateEnum string

文件的簽出狀態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null)

CheckOutUserId
documents.checkOutUserId string

出庫文件之使用者的 ID

文件資料
documents.documentData string

文件資料清單

有疊加層
documents.hasOverlay boolean

定義文件是否應以重疊顯示

Id
documents.id string

文件的 ID

ImportTemplateId
documents.importTemplateId string

此文件匯入範本的ID

InfoStoreId
documents.infoStoreId string

資訊存放區的標識碼

LifeCycleManager
documents.lifeCycleManager string

生命週期資訊

主檔案長度
documents.mainFileLength integer

主要檔案大小

名稱
documents.name string

文件名稱

頁數
documents.pageCount integer

主檔案的頁數

properties
documents.properties array of

properties

保護網域標識符
documents.protectionDomainId string

保護網域的識別碼

提醒
documents.reminders string

所有提醒事項列表

工作階段計數
documents.sessionCount integer

工作階段計數

SigningProfileId
documents.signingProfileId string

簽署設定檔的識別碼

版本標識碼
documents.versionId string

文件的版本識別碼

有更多
hasMore boolean

表明是否存在更多結果。 如果有更多結果可用,旗標會設定為 true

簡歷點
resumePoint string

先前搜尋作業的恢復點。 為第一個搜尋作業設定 null

更新使用者資料表中的資料列

更新使用者資料表中的資料列

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

使用者資料表名稱
UserTable True string

使用者資料表名稱

資料列
RowData True string

包含要更新的資料列資料的字串,以分號分隔,第一個元素必須是要更新的資料列的InternalRecord_Id,以下範例中的「100」:100;John;麀;2024-01-01;2024-12-31

傳回

名稱 路徑 類型 Description
userTableUpdateRow結果
userTableUpdateRowResult integer

userTableUpdateRow結果

更新文件 (V2)

更新文件 (V2)

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

文件標題
DocumentTitle string

文件標題

文件屬性
DocumentProperties string

文件屬性更新格式:Firstname=Peter|姓氏=穆勒|發票編號=4711;4712;4713

移除文件屬性
RemoveDocumentProperties string

要從文件中刪除的分號分隔屬性名稱或 ID 列表,例如“FistName;b9cfbdf7-f6fb-4179-91c8-d9681fb680dd;部門”

文化特性
Culture string

給出文本的文化(de、en、fr 等)。預設值 = de

DocumentId
DocumentId True string

文件的 ID

保護網域
ProtectionDomain string

ProtectionDomain 名稱或識別碼

部落格
Blog string

在文件上新增部落格文字項目

上傳方法
UploadMethod string

將文件上傳至 InfoShare 時所用的方法。 預設值 = UploadFileBytesLarge

檔案內容
FileContent string

檔案內容 base64 字串

強制復原結帳
ForceUndoCheckout boolean

復原文件的借出。 預設值 = false

區塊大小
ChunkSize integer

與 UploadStreamChunks 和 UploadFileBytesLarge 上傳方法搭配使用的檔案上傳區塊大小,預設262144

傳回

名稱 路徑 類型 Description
阿邦內門特
abonnements array of object

阿邦內特

OnContent變更
abonnements.onContentChange boolean

Abonnement 在檔案變更時處於作用中狀態

刪除時
abonnements.onDelete boolean

刪除時 Abonnement 處於作用中狀態

OnMetadataChange
abonnements.onMetadataChange boolean

Abonnement 在索引變更時處於活躍狀態

UserId
abonnements.userId string

此帳戶的使用者 ID

accessRightsEnumList
accessRightsEnumList array of string

存取權限列舉清單

postIt註釋
annotationManager.postItAnnotations array of object

postIt註釋

CreatedDate
annotationManager.postItAnnotations.createdDate string

從便利貼註解建立日期

CreatorId
annotationManager.postItAnnotations.creatorId string

來自發布註釋的創建者的用戶 ID

是斜體
annotationManager.postItAnnotations.fontInfo.isItalic boolean

字體是來自便利貼註釋的斜體嗎

是三振
annotationManager.postItAnnotations.fontInfo.isStrikeOut boolean

字體是否從便利貼註釋中刪除

是底線
annotationManager.postItAnnotations.fontInfo.isUnderline boolean

字體是否來自便利貼註釋的底線

名稱
annotationManager.postItAnnotations.fontInfo.name string

來自張貼註釋的字體名稱。 預設值 = Arial

Pitch
annotationManager.postItAnnotations.fontInfo.pitch integer

便利貼註釋的字體間距

大小
annotationManager.postItAnnotations.fontInfo.size integer

來自 post it 註釋的字體大小。 範例:大小:12 是 12000。 您需要因數 1000

Weight
annotationManager.postItAnnotations.fontInfo.weight integer

便利貼註釋的字體粗細

Id
annotationManager.postItAnnotations.id string

註釋張貼 Id

修改日期
annotationManager.postItAnnotations.modifiedDate string

便利貼註釋的修改日期。 日期格式:yyyy-MM-ddTHH:mm:ss

頁碼
annotationManager.postItAnnotations.pageNumber integer

張貼註釋的頁數

SecurityLevel列舉
annotationManager.postItAnnotations.securityLevelEnum string

發布註釋的安全級別(PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 預設值 = PubliclyAvailable

可選擇
annotationManager.postItAnnotations.selectable boolean

定義使用者是否可選取張貼註解

文字
annotationManager.postItAnnotations.text string

用於發布註釋的用戶定義文本

X
annotationManager.postItAnnotations.x integer

X 座標 (以每英吋像素為單位) 表示 7200 DPI 的便利貼註解

annotationManager.postItAnnotations.y integer

Y 座標 (以每英吋像素為單位) 的 7200 DPI 便利貼註釋

矩形註解
annotationManager.rectangleAnnotations array of object

矩形註解

顏色
annotationManager.rectangleAnnotations.color integer

矩形註釋中的矩形顏色(32 位 ARGB 值)示例:黑色:-16777216 白色:-1 紅色:-65536 綠色:-16744448 藍色:-16776961

顏色十六進制代碼
annotationManager.rectangleAnnotations.colorHexCode string

矩形註釋中的矩形(RGB 十六進位代碼)的顏色。 範例:黑色:#000000 白色:#FFFFFF 紅色:#FF0000 綠色:#008000 藍色:#0000FF

CreatedDate
annotationManager.rectangleAnnotations.createdDate string

矩形註解的建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

創建者識別碼
annotationManager.rectangleAnnotations.creatorId string

矩形註釋建立者識別碼

高度
annotationManager.rectangleAnnotations.height integer

7200 DPI 的矩形高度 (以每英吋像素為單位)

Id
annotationManager.rectangleAnnotations.Id string

矩形註解識別碼

修改日期
annotationManager.rectangleAnnotations.modifiedDate string

矩形註解的修改日期。 日期格式:yyyy-MM-ddTHH:mm:ss

頁碼
annotationManager.rectangleAnnotations.pageNumber integer

矩形註釋的頁數

SecurityLevel列舉
annotationManager.rectangleAnnotations.securityLevelEnum string

矩形註釋的安全性層級 (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 預設值 = PubliclyAvailable

可選擇
annotationManager.rectangleAnnotations.selectable boolean

定義使用者是否可以選取矩形註解

Transparent
annotationManager.rectangleAnnotations.transparent boolean

矩形應該是透明的(突出顯示)

寬度
annotationManager.rectangleAnnotations.width integer

7200 DPI 的矩形寬度 (每英吋像素)

X
annotationManager.rectangleAnnotations.x integer

來自矩形註解的 7200 DPI 的 X 座標 (以每英吋像素為單位)

annotationManager.rectangleAnnotations.y integer

來自矩形註解的 7200 DPI 的 Y 座標 (以每英吋像素為單位)

text註釋
annotationManager.textAnnotations array of object

文字註釋

BackgroundColor
annotationManager.textAnnotations.backgroundColor integer

來自文字註解的背景顏色(32 位元 ARGB 值)。 範例:黑色:-16777216 白色:-1 紅色:-65536 綠色:-16744448 藍色:-16776961

背景顏色十六進制代碼
annotationManager.textAnnotations.backgroundColorHexCode string

文本註釋中的背景顏色(RGB 十六進制代碼)。 範例:黑色:#000000 白色:#FFFFFF 紅色:#FF0000 綠色:#008000 藍色:#0000FF

CreatedDate
annotationManager.textAnnotations.createdDate string

從文字註解建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
annotationManager.textAnnotations.creatorId string

來自文字註釋的建立者使用者 ID

是斜體
annotationManager.textAnnotations.fontInfo.isItalic boolean

字體是否來自文字註釋的斜體

是三振
annotationManager.textAnnotations.fontInfo.isStrikeOut boolean

字體是否從文字註釋中刪除線

是底線
annotationManager.textAnnotations.fontInfo.isUnderline boolean

字型底線是否來自文字註解

名稱
annotationManager.textAnnotations.fontInfo.name string

文字註解中的字型名稱。 預設值 = Arial

Pitch
annotationManager.textAnnotations.fontInfo.pitch integer

文字註解的字體間距

大小
annotationManager.textAnnotations.fontInfo.size integer

文字註解的字型大小。 範例:大小:12 是 12000。 您需要因數 1000

Weight
annotationManager.textAnnotations.fontInfo.weight integer

文字註解的字體粗細

前景顏色
annotationManager.textAnnotations.foregroundColor integer

文字註解的前景色彩 (32 位元 ARGB 值)。 範例:黑色:-16777216 白色:-1 紅色:-65536 綠色:-16744448 藍色:-16776961

前景顏色十六進制代碼
annotationManager.textAnnotations.foregroundColorHexCode string

文本註釋中的前景顏色(RGB 十六進位代碼)。 範例:黑色:#000000 白色:#FFFFFF 紅色:#FF0000 綠色:#008000 藍色:#0000FF

高度
annotationManager.textAnnotations.height integer

文字註解中 7200 DPI 的文字高度 (以每英吋像素為單位)

Id
annotationManager.textAnnotations.id string

文字註解的標識碼

修改日期
annotationManager.textAnnotations.modifiedDate string

文字註解的修改日期。 日期格式:yyyy-MM-ddTHH:mm:ss

頁碼
annotationManager.textAnnotations.pageNumber integer

文字註解的頁數

Rotation
annotationManager.textAnnotations.rotation integer

從文字註解旋轉(以度數為單位)

SecurityLevel列舉
annotationManager.textAnnotations.securityLevelEnum string

文字註解的安全性層級 (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 預設值 = PubliclyAvailable

可選擇
annotationManager.textAnnotations.selectable boolean

定義使用者是否可選取文字註解

文字
annotationManager.textAnnotations.text string

使用者定義的文字註解文字

Transparent
annotationManager.textAnnotations.transparent boolean

文字註解應該是透明的

寬度
annotationManager.textAnnotations.width integer

文字註解中 7200 DPI 的文字寬度 (以每英吋像素為單位)

X
annotationManager.textAnnotations.x integer

來自文字註解的 7200 DPI 的 X 座標 (以每英吋像素為單位)

annotationManager.textAnnotations.y integer

Y 座標 (以每英吋像素為單位) 表示,適用於文字批註的 7200 DPI

部落格
blogs array of object

部落格

CreatedDate
blogs.createdDate string

部落格的建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
blogs.creatorId string

建立使用者部落格的使用者 ID

Id
blogs.id string

部落格的 ID

文字
blogs.text string

部落格項目的文字

CheckOutStateEnum
checkOutStateEnum string

文件的簽出狀態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null)

CheckOutUserId
checkOutUserId string

出庫文件之使用者的 ID

文件資料
documentData array of object

文件資料

Id
documentData.id string

文件資料識別碼

名稱
documentData.name string

文件資料名稱

轉譯
documentData.renditions array of

轉譯

有疊加層
hasOverlay boolean

定義文件是否應以重疊顯示

Id
id string

文件的 ID

ImportTemplateId
importTemplateId string

此文件匯入範本的ID

InfoStoreId
infoStoreId string

資訊存放區的標識碼

CheckOutLifeCycleStateId
lifeCycleManager.checkOutLifeCycleStateId string

出庫生命週期狀態

生命週期結束日期
lifeCycleManager.lifeCycleEndDate string

生命週期的計算結束日期。 日期格式:yyyy-MM-ddTHH:mm:ss

生命週期開始日期
lifeCycleManager.lifeCycleStartDate string

生命週期的開始日期。 日期格式:yyyy-MM-ddTHH:mm:ss

LifeCycleStateId
lifeCycleManager.lifeCycleStateId string

LifeCycle 狀態的 ID

下一個自動生命週期狀態標識符
lifeCycleManager.nextAutomaticLifeCycleStateId string

下一個自動生命週期狀態

nextLifeCycle狀態
lifeCycleManager.nextLifeCycleStates array of string

下一個生命週期狀態

lifeCycle保護
lifeCycleManager.lifeCycleProtections array of object

lifeCycle保護

DeleteAfterExpiration
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration boolean

允許在保護到期後刪除文件

Id
lifeCycleManager.lifeCycleProtections.id string

生命週期狀態保護的標識碼

Protect註解變更
lifeCycleManager.lifeCycleProtections.protectAnnotationChange boolean

防止註釋變更

保護結帳
lifeCycleManager.lifeCycleProtections.protectCheckOut boolean

防止結帳

保護內容變更
lifeCycleManager.lifeCycleProtections.protectContentChange boolean

防止內容變更

保護刪除
lifeCycleManager.lifeCycleProtections.protectDelete boolean

防止刪除

保護屬性變更
lifeCycleManager.lifeCycleProtections.protectPropertyChange boolean

防止財產變更

ProtectProtection網域變更
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange boolean

防範安全性變更

ProtectionDurationTicks
lifeCycleManager.lifeCycleProtections.protectionDurationTicks integer

保護期限

LifeCycleId
lifeCycleManager.lifeCycleId string

LifeCycle 的 ID

主檔案長度
mainFileLength integer

主要檔案大小

名稱
name string

文件名稱

頁數
pageCount integer

主檔案的頁數

properties
properties array of object

屬性

全球值
properties.globalValues array of object

全球價值觀

values
properties.globalValues.values array of object

values

文化特性 (Culture)
properties.globalValues.values.culture string

全球價值文化

收發簡訊
properties.globalValues.values.text string

全域值文字

屬性名稱
properties.propertyName string

物業名稱

屬性類型標識符
properties.propertyTypeId string

索引欄位的類型 ID

values
properties.values array of string

屬性類型值

保護網域標識符
protectionDomainId string

保護網域的識別碼

溫馨提示
reminders array of object

溫馨提示

Description
reminders.description string

提醒說明

間隔
reminders.interval integer

提醒之間的間隔(以天為單位)

ProcessTemplateId
reminders.processTemplateId string

此提醒的程序範本識別碼

提醒日期
reminders.reminderDate string

提醒日期。 日期格式:yyyy-MM-ddTHH:mm:ss

提醒標識碼
reminders.reminderId string

提醒的 ID

subjectIds
reminders.subjectIds array of

subjectIds

使用UserFromProcessTemplate
reminders.useUserFromProcessTemplate boolean

定義是否要使用流程範本中的使用者定義

SigningProfileId
signingProfileId string

簽署設定檔的識別碼

版本標識碼
versionId string

文件的版本識別碼

更新文件 (已棄用) [已棄用]

更新文件 (已淘汰)

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

DocumentId
DocumentId True string

文件的 ID

文件標題
DocumentTitle string

文件標題

文件屬性
DocumentProperties string

文件屬性更新格式:Firstname=Peter|姓氏=穆勒|發票編號=4711;4712;4713

文化特性
Culture string

給出文本的文化(de、en、fr 等)。預設值 = de

檔案內容
FileContent string

檔案內容 base64 字串

傳回

名稱 路徑 類型 Description
阿邦內門特
abonnements array of object

阿邦內門特

OnContent變更
abonnements.onContentChange boolean

Abonnement 在檔案變更時處於作用中狀態

刪除時
abonnements.onDelete boolean

刪除時 Abonnement 處於作用中狀態

OnMetadataChange
abonnements.onMetadataChange boolean

Abonnement 在索引變更時處於活躍狀態

UserId
abonnements.userId string

此帳戶的使用者 ID

accessRightsEnumList
accessRightsEnumList array of string

accessRightsEnumList

postIt註釋
annotationManager.postItAnnotations array of object

postIt註釋

CreatedDate
annotationManager.postItAnnotations.createdDate string

從便利貼註解建立日期

CreatorId
annotationManager.postItAnnotations.creatorId string

來自發布註釋的創建者的用戶 ID

是斜體
annotationManager.postItAnnotations.fontInfo.isItalic boolean

字體是來自便利貼註釋的斜體嗎

是三振
annotationManager.postItAnnotations.fontInfo.isStrikeOut boolean

字體是否從便利貼註釋中刪除

是底線
annotationManager.postItAnnotations.fontInfo.isUnderline boolean

字體是否來自便利貼註釋的底線

名稱
annotationManager.postItAnnotations.fontInfo.name string

來自張貼註釋的字體名稱。 預設值 = Arial

Pitch
annotationManager.postItAnnotations.fontInfo.pitch integer

便利貼註釋的字體間距

大小
annotationManager.postItAnnotations.fontInfo.size integer

來自 post it 註釋的字體大小。 範例:大小:12 是 12000。 您需要因數 1000

Weight
annotationManager.postItAnnotations.fontInfo.weight integer

便利貼註釋的字體粗細

Id
annotationManager.postItAnnotations.id string

便利貼註釋的標識碼

修改日期
annotationManager.postItAnnotations.modifiedDate string

便利貼註釋的修改日期。 日期格式:yyyy-MM-ddTHH:mm:ss

頁碼
annotationManager.postItAnnotations.pageNumber integer

張貼註釋的頁數

SecurityLevel列舉
annotationManager.postItAnnotations.securityLevelEnum string

發布註釋的安全級別(PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 預設值 = PubliclyAvailable

可選擇
annotationManager.postItAnnotations.selectable boolean

定義使用者是否可選取張貼註解

文字
annotationManager.postItAnnotations.text string

用於發布註釋的用戶定義文本

X
annotationManager.postItAnnotations.x integer

X 座標 (以每英吋像素為單位) 表示 7200 DPI 的便利貼註解

annotationManager.postItAnnotations.y integer

Y 座標 (以每英吋像素為單位) 的 7200 DPI 便利貼註釋

矩形註解
annotationManager.rectangleAnnotations array of object

矩形註解

顏色
annotationManager.rectangleAnnotations.color integer

矩形註釋中的矩形顏色(32 位 ARGB 值)示例:黑色:-16777216 白色:-1 紅色:-65536 綠色:-16744448 藍色:-16776961

顏色十六進制代碼
annotationManager.rectangleAnnotations.colorHexCode string

矩形註釋中的矩形(RGB 十六進位代碼)的顏色。 範例:黑色:#000000 白色:#FFFFFF 紅色:#FF0000 綠色:#008000 藍色:#0000FF

CreatedDate
annotationManager.rectangleAnnotations.createdDate string

矩形註解的建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

創建者識別碼
annotationManager.rectangleAnnotations.creatorId string

CreatorId

高度
annotationManager.rectangleAnnotations.height integer

7200 DPI 的矩形高度 (以每英吋像素為單位)

Id
annotationManager.rectangleAnnotations.Id string

矩形註解的標識碼

修改日期
annotationManager.rectangleAnnotations.modifiedDate string

矩形註解的修改日期。 日期格式:yyyy-MM-ddTHH:mm:ss

頁碼
annotationManager.rectangleAnnotations.pageNumber integer

矩形註釋的頁數

SecurityLevel列舉
annotationManager.rectangleAnnotations.securityLevelEnum string

矩形註釋的安全性層級 (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 預設值 = PubliclyAvailable

可選擇
annotationManager.rectangleAnnotations.selectable boolean

定義使用者是否可以選取矩形註解

Transparent
annotationManager.rectangleAnnotations.transparent boolean

矩形應該是透明的(突出顯示)

寬度
annotationManager.rectangleAnnotations.width integer

7200 DPI 的矩形寬度 (每英吋像素)

X
annotationManager.rectangleAnnotations.x integer

來自矩形註解的 7200 DPI 的 X 座標 (以每英吋像素為單位)

annotationManager.rectangleAnnotations.y integer

來自矩形註解的 7200 DPI 的 Y 座標 (以每英吋像素為單位)

text註釋
annotationManager.textAnnotations array of object

text註釋

BackgroundColor
annotationManager.textAnnotations.backgroundColor integer

來自文字註解的背景顏色(32 位元 ARGB 值)。 範例:黑色:-16777216 白色:-1 紅色:-65536 綠色:-16744448 藍色:-16776961

背景顏色十六進制代碼
annotationManager.textAnnotations.backgroundColorHexCode string

文本註釋中的背景顏色(RGB 十六進制代碼)。 範例:黑色:#000000 白色:#FFFFFF 紅色:#FF0000 綠色:#008000 藍色:#0000FF

CreatedDate
annotationManager.textAnnotations.createdDate string

從文字註解建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
annotationManager.textAnnotations.creatorId string

來自文字註釋的建立者使用者 ID

是斜體
annotationManager.textAnnotations.fontInfo.isItalic boolean

字體是否來自文字註釋的斜體

是三振
annotationManager.textAnnotations.fontInfo.isStrikeOut boolean

字體是否從文字註釋中刪除線

是底線
annotationManager.textAnnotations.fontInfo.isUnderline boolean

字型底線是否來自文字註解

名稱
annotationManager.textAnnotations.fontInfo.name string

文字註解中的字型名稱。 預設值 = Arial

Pitch
annotationManager.textAnnotations.fontInfo.pitch integer

文字註解的字體間距

大小
annotationManager.textAnnotations.fontInfo.size integer

文字註解的字型大小。 範例:大小:12 是 12000。 您需要因數 1000

Weight
annotationManager.textAnnotations.fontInfo.weight integer

文字註解的字體粗細

前景顏色
annotationManager.textAnnotations.foregroundColor integer

文字註解的前景色彩 (32 位元 ARGB 值)。 範例:黑色:-16777216 白色:-1 紅色:-65536 綠色:-16744448 藍色:-16776961

前景顏色十六進制代碼
annotationManager.textAnnotations.foregroundColorHexCode string

文本註釋中的前景顏色(RGB 十六進位代碼)。 範例:黑色:#000000 白色:#FFFFFF 紅色:#FF0000 綠色:#008000 藍色:#0000FF

高度
annotationManager.textAnnotations.height integer

文字註解中 7200 DPI 的文字高度 (以每英吋像素為單位)

Id
annotationManager.textAnnotations.id string

文字註解的標識碼

修改日期
annotationManager.textAnnotations.modifiedDate string

文字註解的修改日期。 日期格式:yyyy-MM-ddTHH:mm:ss

頁碼
annotationManager.textAnnotations.pageNumber integer

文字註解的頁數

Rotation
annotationManager.textAnnotations.rotation integer

從文字註解旋轉(以度數為單位)

SecurityLevel列舉
annotationManager.textAnnotations.securityLevelEnum string

文字註解的安全性層級 (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 預設值 = PubliclyAvailable

可選擇
annotationManager.textAnnotations.selectable boolean

定義使用者是否可選取文字註解

文字
annotationManager.textAnnotations.text string

使用者定義的文字註解文字

Transparent
annotationManager.textAnnotations.transparent boolean

文字註解應該是透明的

寬度
annotationManager.textAnnotations.width integer

文字註解中 7200 DPI 的文字寬度 (以每英吋像素為單位)

X
annotationManager.textAnnotations.x integer

來自文字註解的 7200 DPI 的 X 座標 (以每英吋像素為單位)

annotationManager.textAnnotations.y integer

Y 座標 (以每英吋像素為單位) 表示,適用於文字批註的 7200 DPI

部落格
blogs array of object

部落格

CreatedDate
blogs.createdDate string

部落格的建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
blogs.creatorId string

建立使用者部落格的使用者 ID

Id
blogs.id string

部落格的 ID

文字
blogs.text string

部落格項目的文字

CheckOutStateEnum
checkOutStateEnum string

文件的簽出狀態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null)

CheckOutUserId
checkOutUserId string

出庫文件之使用者的 ID

文件資料
documentData array of object

文件資料

Id
documentData.id string

文件資料的 ID

名稱
documentData.name string

文件資料名稱

轉譯
documentData.renditions array of

轉譯

有疊加層
hasOverlay boolean

定義文件是否應以重疊顯示

Id
id string

文件的 ID

ImportTemplateId
importTemplateId string

此文件匯入範本的ID

InfoStoreId
infoStoreId string

資訊存放區的標識碼

CheckOutLifeCycleStateId
lifeCycleManager.checkOutLifeCycleStateId string

出庫生命週期狀態

生命週期結束日期
lifeCycleManager.lifeCycleEndDate string

生命週期的計算結束日期。 日期格式:yyyy-MM-ddTHH:mm:ss

生命週期開始日期
lifeCycleManager.lifeCycleStartDate string

生命週期的開始日期。 日期格式:yyyy-MM-ddTHH:mm:ss

LifeCycleStateId
lifeCycleManager.lifeCycleStateId string

LifeCycle 狀態的 ID

下一個自動生命週期狀態標識符
lifeCycleManager.nextAutomaticLifeCycleStateId string

下一個自動生命週期狀態

nextLifeCycle狀態
lifeCycleManager.nextLifeCycleStates array of string

nextLifeCycle狀態

lifeCycle保護
lifeCycleManager.lifeCycleProtections array of object

lifeCycle保護

DeleteAfterExpiration
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration boolean

允許在保護到期後刪除文件

Id
lifeCycleManager.lifeCycleProtections.id string

生命週期狀態保護的標識碼

Protect註解變更
lifeCycleManager.lifeCycleProtections.protectAnnotationChange boolean

防止註釋變更

保護結帳
lifeCycleManager.lifeCycleProtections.protectCheckOut boolean

防止結帳

保護內容變更
lifeCycleManager.lifeCycleProtections.protectContentChange boolean

防止內容變更

保護刪除
lifeCycleManager.lifeCycleProtections.protectDelete boolean

防止刪除

保護屬性變更
lifeCycleManager.lifeCycleProtections.protectPropertyChange boolean

防止財產變更

ProtectProtection網域變更
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange boolean

防範安全性變更

ProtectionDurationTicks
lifeCycleManager.lifeCycleProtections.protectionDurationTicks integer

保護期限

LifeCycleId
lifeCycleManager.lifeCycleId string

LifeCycle 的 ID

主檔案長度
mainFileLength integer

主要檔案大小

名稱
name string

文件名稱

頁數
pageCount integer

主檔案的頁數

properties
properties array of object

properties

全球值
properties.globalValues array of object

全球值

values
properties.globalValues.values array of object

values

文化特性 (Culture)
properties.globalValues.values.culture string

文化特性

收發簡訊
properties.globalValues.values.text string

文字

屬性名稱
properties.propertyName string

物業名稱

屬性類型標識符
properties.propertyTypeId string

索引欄位的類型 ID

values
properties.values array of string

PropertyType 值

保護網域標識符
protectionDomainId string

保護網域的識別碼

溫馨提示
reminders array of object

溫馨提示

Description
reminders.description string

提醒說明

間隔
reminders.interval integer

提醒之間的間隔(以天為單位)

ProcessTemplateId
reminders.processTemplateId string

此提醒的程序範本識別碼

提醒日期
reminders.reminderDate string

提醒日期。 日期格式:yyyy-MM-ddTHH:mm:ss

提醒標識碼
reminders.reminderId string

提醒的 ID

subjectIds
reminders.subjectIds array of

subjectIds

使用UserFromProcessTemplate
reminders.useUserFromProcessTemplate boolean

定義是否要使用流程範本中的使用者定義

SigningProfileId
signingProfileId string

簽署設定檔的識別碼

版本標識碼
versionId string

文件的版本識別碼

更新程序 (V2)

更新程序 (V2)

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

ProcessId
ProcessId True string

進程標識碼 (Guid)

Process屬性
ProcessProperties string

流程屬性更新格式:Firstname=Peter|姓氏=穆勒|發票編號=4711;4712;4713

RemoveProcess屬性
RemoveProcessProperties string

要從進程中刪除的分號分隔屬性名稱或標識符列表,例如 “FistName;b9cfbdf7-f6fb-4179-91c8-d9681fb680dd;部門”

自訂屬性
CustomProperties string

自訂屬性。 格式:[<PropertyName>|<屬性值>|PropertyType] (例如 [Supplier|集結|字串][發票日期|2021-01-29T13:05:45 |日期][發票號碼|4711|編號])

評論
Comment string

新增程序註解文字

指派使用者登入名稱
AssignUserLoginNames string

指派的使用者登入名稱,以分號分隔,例如 user1;使用者2

AddDocumentIds
AddDocumentIds string

要新增至程式的檔 ID 的分號分隔清單,例如 '1450c90e-2783-419b-b428-6ffa3b7cabe2;0339a105-e06a-4af4-8fa2-d0b6b837fc16'

RemoveDocumentIds
RemoveDocumentIds string

要從程序中移除的文件標識碼的分號分隔清單,例如 '1450c90e-2783-419b-b428-6ffa3b7cabe2;0339a105-e06a-4af4-8fa2-d0b6b837fc16'

截止日期
DueDate string

該過程的截止日期。 日期格式:yyyy-MM-ddTHH:mm:ss。 預設值 = 目前日期

Priority
Priority string

進程的優先順序(例如低、正常、高)。 預設值 = 正常

文化特性
Culture string

給出文本的文化(de、en、fr 等)。預設值 = de

強制復原結帳
ForceUndoCheckout boolean

如有需要,強制處理程序復原出庫

保護網域
ProtectionDomain string

保護網域識別碼或名稱

傳回

名稱 路徑 類型 Description
values
name.values array of object

屬性值

文化特性 (Culture)
name.values.culture string

財產文化

收發簡訊
name.values.text string

屬性文字

values
description.values array of object

values

文化特性 (Culture)
description.values.culture string

財產文化

收發簡訊
description.values.text string

屬性文字

識別碼
id string

進程識別碼

保護網域 ID
protectionDomainId string

處理程序保護網域識別碼

processTemplateId
processTemplateId string

程序範本識別碼

properties
properties array of object

屬性

屬性類型Id
properties.propertyTypeId string

PropertyType 標識符

values
properties.values array of string

屬性值

全球值
properties.globalValues array of object

全球價值觀

values
properties.globalValues.values array of object

values

文化特性 (Culture)
properties.globalValues.values.culture string

全球價值文化

收發簡訊
properties.globalValues.values.text string

全域值文字

屬性類型名稱
properties.propertyTypeName string

PropertyType 名稱

propertyName
properties.propertyName string

屬性名稱

priorityEnum
priorityEnum string

處理優先順序列舉

插件流
pluginStream string

處理外掛程式串流

截止日期
dueDate string

處理到期日

建立日期
createdDate string

程序建立日期

completedDate (已完成日期)
completedDate string

處理完成日期

註解
comments array of object

評論

識別碼
comments.id string

處理程序註解標識符

date
comments.date string

處理程序註解日期

userId
comments.userId string

處理註解使用者識別碼

收發簡訊
comments.text string

處理註解文字

accessRightsEnumList
accessRightsEnumList array of string

存取權限列舉清單

statusEnum
statusEnum string

狀態列舉

customProperties
customProperties array of object

自訂屬性

名稱
customProperties.name string

自訂屬性名稱

value
customProperties.value string

自訂屬性值

customPropertyTypeEnum
customProperties.customPropertyTypeEnum string

自訂屬性類型列舉

識別碼
currentTask.id string

目前工作識別碼

動作
currentTask.action string

目前工作動作

創建者識別碼
currentTask.creatorId string

目前工作建立者識別碼

截止日期
currentTask.dueDate string

目前任務到期日

建立日期
currentTask.createdDate string

目前工作建立日期

completedDate (已完成日期)
currentTask.completedDate string

目前任務完成日期

taskTemplateId
currentTask.taskTemplateId string

目前工作工作範本識別碼

註解
currentTask.comments array of

目前工作註解

提醒日期
currentTask.reminderDate string

目前任務提醒日期

statusEnum
currentTask.statusEnum string

目前工作狀態列舉

說明
currentTask.description string

目前任務描述

requiresAllRecipients
currentTask.requiresAllRecipients boolean

目前工作需要所有收件者

assignedUserId
currentTask.assignedUserIds array of string

目前任務指派的使用者 ID

completedUserIds
currentTask.completedUserIds array of string

目前工作已完成的使用者 ID

showCloseTaskDialog
currentTask.showCloseTaskDialog boolean

目前工作顯示關閉工作對話框

意圖使用者標識碼
currentTask.intendedUserIds array of

現行作業預期使用者 ID

values
currentTask.nameGlobal.values array of object

values

文化特性 (Culture)
currentTask.nameGlobal.values.culture string

全球名稱文化

收發簡訊
currentTask.nameGlobal.values.text string

全域名稱文字

values
currentTask.descriptionGlobal.values array of object

values

文化特性 (Culture)
currentTask.descriptionGlobal.values.culture string

全域描述文化

收發簡訊
currentTask.descriptionGlobal.values.text string

全域描述文字

assignedUserCCIds
currentTask.assignedUserCCIds array of

指派的使用者副本識別碼

代理陳述
currentTask.deputyRepresentations array of

代表

taskActionEnum
currentTask.taskActionEnum string

工作動作列舉

completedTasks
completedTasks array of object

已完成的任務

識別碼
completedTasks.id string

已完成的工作識別碼

動作
completedTasks.action string

已完成的工作動作

創建者識別碼
completedTasks.creatorId string

已完成的工作建立者識別碼

截止日期
completedTasks.dueDate string

已完成的任務截止日期

建立日期
completedTasks.createdDate string

已完成任務建立日期

completedDate (已完成日期)
completedTasks.completedDate string

已完成任務完成日期

taskTemplateId
completedTasks.taskTemplateId string

已完成的工作工作範本識別碼

註解
completedTasks.comments array of

已完成的工作註解

提醒日期
completedTasks.reminderDate string

完成任務提醒日期

statusEnum
completedTasks.statusEnum string

已完成的工作狀態列舉

說明
completedTasks.description string

說明

requiresAllRecipients
completedTasks.requiresAllRecipients boolean

已完成的任務需要所有收件者

assignedUserId
completedTasks.assignedUserIds array of string

已完成的工作指派使用者 ID

completedUserIds
completedTasks.completedUserIds array of string

已完成的任務已完成的使用者 ID

showCloseTaskDialog
completedTasks.showCloseTaskDialog boolean

已完成的工作顯示關閉工作的對話方塊

意圖使用者標識碼
completedTasks.intendedUserIds array of

已完成的作業預期使用者 ID

values
completedTasks.nameGlobal.values array of object

values

文化特性 (Culture)
completedTasks.nameGlobal.values.culture string

全球名稱文化

收發簡訊
completedTasks.nameGlobal.values.text string

全域名稱文字

values
completedTasks.descriptionGlobal.values array of object

values

文化特性 (Culture)
completedTasks.descriptionGlobal.values.culture string

全域描述文化

收發簡訊
completedTasks.descriptionGlobal.values.text string

全域描述文字

assignedUserCCIds
completedTasks.assignedUserCCIds array of

已完成的工作指派使用者副本識別碼

代理陳述
completedTasks.deputyRepresentations array of

已完成的任務代理表示

taskActionEnum
completedTasks.taskActionEnum string

已完成的工作工作動作列舉

文件標識符
documentIds array of string

已完成的工作文件標識符

checkOutState列舉
checkOutStateEnum string

已完成的工作簽出狀態列舉

checkOutUserId
checkOutUserId string

已完成的工作簽出使用者 ID

工作階段計數
sessionCount integer

已完成的工作階段作業計數

更新程序 (已淘汰) [已淘汰]

更新程序 (已淘汰)

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

ProcessId
ProcessId True string

進程標識碼 (Guid)

指派使用者登入名稱
AssignUserLoginNames string

將使用者登入名稱指派給目前工作。 (例如:peter.muster@kendox.com;megan.muster@kendox.com

Process屬性
ProcessProperties string

流程屬性更新格式:Firstname=Peter|姓氏=穆勒|發票編號=4711;4712;4713

自訂屬性
CustomProperties string

自訂屬性。 格式:[<PropertyName>|<屬性值>|PropertyType] (例如 [Supplier|集結|字串][發票日期|2021-01-29T13:05:45 |日期][發票號碼|4711|編號])

評論
Comment string

評論

文化特性
Culture string

提供屬性名稱的文化特性 (de、en、fr 等)。預設值 = de

傳回

名稱 路徑 類型 Description
values
name.values array of object

values

文化特性 (Culture)
name.values.culture string

文化特性 (Culture)

收發簡訊
name.values.text string

收發簡訊

values
description.values array of object

values

文化特性 (Culture)
description.values.culture string

文化特性 (Culture)

收發簡訊
description.values.text string

收發簡訊

識別碼
id string

識別碼

保護網域 ID
protectionDomainId string

保護網域 ID

processTemplateId
processTemplateId string

processTemplateId

properties
properties array of object

properties

屬性類型Id
properties.propertyTypeId string

屬性類型Id

values
properties.values array of string

values

全球值
properties.globalValues array of object

全球值

values
properties.globalValues.values array of object

values

文化特性 (Culture)
properties.globalValues.values.culture string

文化特性 (Culture)

收發簡訊
properties.globalValues.values.text string

收發簡訊

屬性類型名稱
properties.propertyTypeName string

屬性類型名稱

propertyName
properties.propertyName string

propertyName

priorityEnum
priorityEnum string

priorityEnum

插件流
pluginStream string

插件流

截止日期
dueDate string

截止日期

建立日期
createdDate string

建立日期

completedDate (已完成日期)
completedDate string

completedDate (已完成日期)

註解
comments array of object

註解

識別碼
comments.id string

識別碼

date
comments.date string

date

userId
comments.userId string

userId

收發簡訊
comments.text string

收發簡訊

accessRightsEnumList
accessRightsEnumList array of string

accessRightsEnumList

statusEnum
statusEnum string

statusEnum

customProperties
customProperties array of object

customProperties

名稱
customProperties.name string

名稱

value
customProperties.value string

value

customPropertyTypeEnum
customProperties.customPropertyTypeEnum string

customPropertyTypeEnum

識別碼
currentTask.id string

識別碼

動作
currentTask.action string

動作

創建者識別碼
currentTask.creatorId string

創建者識別碼

截止日期
currentTask.dueDate string

截止日期

建立日期
currentTask.createdDate string

建立日期

completedDate (已完成日期)
currentTask.completedDate string

completedDate (已完成日期)

taskTemplateId
currentTask.taskTemplateId string

taskTemplateId

註解
currentTask.comments array of

註解

提醒日期
currentTask.reminderDate string

提醒日期

statusEnum
currentTask.statusEnum string

statusEnum

說明
currentTask.description string

說明

requiresAllRecipients
currentTask.requiresAllRecipients boolean

requiresAllRecipients

assignedUserId
currentTask.assignedUserIds array of string

assignedUserId

completedUserIds
currentTask.completedUserIds array of string

completedUserIds

showCloseTaskDialog
currentTask.showCloseTaskDialog boolean

showCloseTaskDialog

意圖使用者標識碼
currentTask.intendedUserIds array of

意圖使用者標識碼

values
currentTask.nameGlobal.values array of object

values

文化特性 (Culture)
currentTask.nameGlobal.values.culture string

文化特性 (Culture)

收發簡訊
currentTask.nameGlobal.values.text string

收發簡訊

values
currentTask.descriptionGlobal.values array of object

values

文化特性 (Culture)
currentTask.descriptionGlobal.values.culture string

文化特性 (Culture)

收發簡訊
currentTask.descriptionGlobal.values.text string

收發簡訊

assignedUserCCIds
currentTask.assignedUserCCIds array of

assignedUserCCIds

代理陳述
currentTask.deputyRepresentations array of

代理陳述

taskActionEnum
currentTask.taskActionEnum string

taskActionEnum

completedTasks
completedTasks array of object

completedTasks

識別碼
completedTasks.id string

識別碼

動作
completedTasks.action string

動作

創建者識別碼
completedTasks.creatorId string

創建者識別碼

截止日期
completedTasks.dueDate string

截止日期

建立日期
completedTasks.createdDate string

建立日期

completedDate (已完成日期)
completedTasks.completedDate string

completedDate (已完成日期)

taskTemplateId
completedTasks.taskTemplateId string

taskTemplateId

註解
completedTasks.comments array of

註解

提醒日期
completedTasks.reminderDate string

提醒日期

statusEnum
completedTasks.statusEnum string

statusEnum

說明
completedTasks.description string

說明

requiresAllRecipients
completedTasks.requiresAllRecipients boolean

requiresAllRecipients

assignedUserId
completedTasks.assignedUserIds array of string

assignedUserId

completedUserIds
completedTasks.completedUserIds array of string

completedUserIds

showCloseTaskDialog
completedTasks.showCloseTaskDialog boolean

showCloseTaskDialog

意圖使用者標識碼
completedTasks.intendedUserIds array of

意圖使用者標識碼

values
completedTasks.nameGlobal.values array of object

values

文化特性 (Culture)
completedTasks.nameGlobal.values.culture string

文化特性 (Culture)

收發簡訊
completedTasks.nameGlobal.values.text string

收發簡訊

values
completedTasks.descriptionGlobal.values array of object

values

文化特性 (Culture)
completedTasks.descriptionGlobal.values.culture string

文化特性 (Culture)

收發簡訊
completedTasks.descriptionGlobal.values.text string

收發簡訊

assignedUserCCIds
completedTasks.assignedUserCCIds array of

assignedUserCCIds

代理陳述
completedTasks.deputyRepresentations array of

代理陳述

taskActionEnum
completedTasks.taskActionEnum string

taskActionEnum

文件標識符
documentIds array of string

文件標識符

checkOutState列舉
checkOutStateEnum string

checkOutState列舉

checkOutUserId
checkOutUserId string

checkOutUserId

工作階段計數
sessionCount integer

工作階段計數

流程搜尋

流程搜尋

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

Conditions
Conditions string

搜尋條件格式:[<PropertyName>|<比較枚舉>|<屬性值>|<RelationEnum>]。 ComparisonEnums: “Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn,Between” RelationEnums:“And,Or”。 例如:[最後入住|收少|2021-12-31|和],[名字|等於|彼得|和],[日期|之間|2021-12-31;2022-12-31|並且]

結果屬性
ResultProperties string

結果屬性清單,逗號分隔。 可以是屬性名稱或識別碼,例如「名稱,上次簽入,68b901cd-4d8f-11e6-aa6f-00ff04d7e62a」

MaxSerch結果
MaxSerchResults string

文件搜尋結果數目上限。 預設值 = 100

文化特性
Culture string

給出文本的文化(de、en、fr 等)。預設值 = de

傳回

名稱 路徑 類型 Description
processes
processes array of object

流程搜尋結果

values
processes.name.values array of object

屬性值

文化特性 (Culture)
processes.name.values.culture string

財產文化

收發簡訊
processes.name.values.text string

屬性文字

識別碼
processes.id string

進程識別碼

folderElementId
processes.folderElementId string

資料夾元素識別碼

checkOutState列舉
processes.checkOutStateEnum string

出庫狀態列舉

properties
processes.properties array of object

屬性

屬性類型Id
processes.properties.propertyTypeId string

PropertyType 標識符

values
processes.properties.values array of string

屬性值

全球值
processes.properties.globalValues array of object

全球價值觀

values
processes.properties.globalValues.values array of object

values

文化特性 (Culture)
processes.properties.globalValues.values.culture string

全球價值文化

收發簡訊
processes.properties.globalValues.values.text string

全域值文字

屬性類型名稱
processes.properties.propertyTypeName string

PropertyType 名稱

propertyName
processes.properties.propertyName string

屬性名稱

priorityEnum
processes.priorityEnum string

優先順序列舉

statusEnum
processes.statusEnum string

狀態列舉

截止日期
processes.dueDate string

到期日

has連結
processes.hasLinks boolean

有鏈接

accessRightsEnumList
processes.accessRightsEnumList array of string

存取權限列舉清單

有更多
hasMore boolean

還有更多

resumePoint
resumePoint string

簡歷點

轉換檔案內容

將文件內容轉換為不同的格式。 將註釋或疊加新增至檔案內容

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

DocumentId
DocumentId True string

文件的 ID

版本標識碼
VersionId string

版本標識符 (Guid)版本標識符 (Guid)

DocumentDataId
DocumentDataId string

文件資料的標識碼 (Guid)

轉譯標識符
RenditionId string

文件轉譯的標識碼 (Guid)

目標格式
TargetFormat True string

目標格式 (例如「png;pdf;tif;...“)

Add註解
AddAnnotatins boolean

定義是否應匯出帶有註釋的文件。 預設值 = 是

AddOverlay
AddOverlay boolean

定義是否應使用覆蓋匯出文件。 預設值 = 是

傳回

已轉換的檔案內容

檔案內容
string

關閉工作並繼續處理程序

關閉工作並繼續處理程序

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
connectionId True string

用於識別連線的連線識別碼

ProcessId
processId True string

進程標識碼 (Guid)

評論
comment string

註解要添加

TaskId
taskId string

工作標識碼

指派使用者
assignUsers True boolean

指派給使用者。 如果設定為否,請指派使用者具有動作更新程序

傳回

名稱 路徑 類型 Description
行動
action string

使用者的動作文字。 顯示給最終使用者

指派的使用者標識碼
assignedUserIds string

指派的使用者 ID 清單

註解
comments array of object

註解

Date
comments.date string

評論日期

Id
comments.id string

註解編號

文字
comments.text string

使用者定義的註解

UserId
comments.userId string

使用者 ID

已完成日期
completedDate string

完成日期。 日期格式:yyyy-MM-ddTHH:mm:ss

已完成使用者標識碼
completedUserIds string

所有已完成的使用者 ID 清單

CreatedDate
createdDate string

創建日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
creatorId string

創建者的用戶 ID

Description
description string

工作描述

截止日期
dueDate string

任務的到期日。 日期格式:yyyy-MM-ddTHH:mm:ss

IntendedUserIds
intendedUserIds string

此作業的預期使用者

提醒日期
reminderDate string

提醒日期。 日期格式:yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
requiresAllRecipients boolean

定義是否所有收件者都必須關閉此工作

顯示關閉工作對話框
showCloseTaskDialog boolean

在工作結束時顯示關閉工作對話方塊

地位
statusEnum string

工作狀態狀態 (開啟、處理中、完成、準備完成、錯誤)

TaskTemplateId
taskTemplateId string

工作範本識別碼

關閉目前工作並將使用者指派給下一個工作

關閉目前工作並將使用者指派給下一個工作

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
ConnectionId True string

用於識別連線的連線識別碼

ProcessId
ProcessId True string

進程標識碼 (Guid)

TaskId
TaskId string

工作標識碼 (Guid)

評論
Comment string

評論

指派使用者登入名稱
AssignUserLoginNames True string

指派使用者登入名稱

傳回

名稱 路徑 類型 Description
行動
action string

使用者的動作文字。 顯示給最終使用者

assignedUserId
assignedUserIds array of string

assignedUserId

註解
comments array of object

註解

Date
comments.date string

評論日期

Id
comments.id string

註解編號

文字
comments.text string

使用者定義的註解

UserId
comments.userId string

已設定註解的使用者識別碼

已完成日期
completedDate string

完成日期。 日期格式:yyyy-MM-ddTHH:mm:ss

已完成使用者標識碼
CompletedUserIds array of string

已完成使用者標識碼

CreatedDate
createdDate string

創建日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
creatorId string

創建者的用戶 ID

Description
description string

工作描述

截止日期
dueDate string

任務的到期日。 日期格式:yyyy-MM-ddTHH:mm:ss

意圖使用者標識碼
intendedUserIds array of string

意圖使用者標識碼

提醒日期
reminderDate string

提醒日期。 日期格式:yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
requiresAllRecipients boolean

定義是否所有收件者都必須關閉此工作

顯示關閉工作對話框
showCloseTaskDialog boolean

在工作結束時顯示關閉工作對話方塊

地位
statusEnum string

工作狀態狀態 (開啟、處理中、完成、準備完成、錯誤)

TaskTemplateId
taskTemplateId string

工作範本識別碼

關閉開啟的程序

關閉開啟的程序

參數

名稱 機碼 必要 類型 Description
存檔網址
ArchiveUrl True string

存檔 api 的 URL (例如: https://documentarchive.ch/sdk/wcfJSON

ConnectionId
connectionId True string

用於識別連線的連線識別碼

ProcessId
processId True string

進程標識碼 (Guid)

評論
comment string

註解要添加

傳回

名稱 路徑 類型 Description
存取權列舉清單
CloseProcessResult.AccessRightsEnumList array of string

accessRightsEnumList

CheckOutStateEnum
CloseProcessResult.CheckOutStateEnum string

文件的簽出狀態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null)

CheckOutUserId
CloseProcessResult.CheckOutUserId string

簽出處理程序之使用者的識別碼

評論
CloseProcessResult.Comments array of object

評論

Date
CloseProcessResult.Comments.Date string

評論日期

Id
CloseProcessResult.Comments.Id string

註解編號

文字
CloseProcessResult.Comments.Text string

使用者定義的註解

UserId
CloseProcessResult.Comments.UserId string

使用者識別碼

已完成日期
CloseProcessResult.CompletedDate string

程序的完成日期。 日期格式:yyyy-MM-ddTHH:mm:ss

已完成任務
CloseProcessResult.CompletedTasks array of object

已完成任務

行動
CloseProcessResult.CompletedTasks.Action string

使用者的動作文字

指派的使用者標識碼
CloseProcessResult.CompletedTasks.AssignedUserIds array of

指派的使用者標識碼

評論
CloseProcessResult.CompletedTasks.Comments array of object

評論

Date
CloseProcessResult.CompletedTasks.Comments.Date string

評論日期

Id
CloseProcessResult.CompletedTasks.Comments.Id string

註解編號

文字
CloseProcessResult.CompletedTasks.Comments.Text string

使用者定義的註解

UserId
CloseProcessResult.CompletedTasks.Comments.UserId string

已設定註解的使用者識別碼

已完成日期
CloseProcessResult.CompletedTasks.CompletedDate string

已完成任務的完成日期。 日期格式:yyyy-MM-ddTHH:mm:ss

已完成使用者標識碼
CloseProcessResult.CompletedTasks.CompletedUserIds array of string

已完成使用者標識碼

CreatedDate
CloseProcessResult.CompletedTasks.CreatedDate string

已完成任務的建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
CloseProcessResult.CompletedTasks.CreatorId string

已完成任務建立者的使用者 ID

Description
CloseProcessResult.CompletedTasks.Description string

已完成任務的任務描述

截止日期
CloseProcessResult.CompletedTasks.DueDate string

任務的到期日。 日期格式:yyyy-MM-ddTHH:mm:ss

Id
CloseProcessResult.CompletedTasks.Id string

任務的標識碼

IntendedUserIds
CloseProcessResult.CompletedTasks.IntendedUserIds array of

IntendedUserIds

提醒日期
CloseProcessResult.CompletedTasks.ReminderDate string

提醒已完成任務的日期。 日期格式:yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
CloseProcessResult.CompletedTasks.RequiresAllRecipients boolean

定義是否所有收件者都必須關閉此工作

顯示關閉工作對話框
CloseProcessResult.CompletedTasks.ShowCloseTaskDialog boolean

在工作結束時顯示關閉工作對話方塊

StatusEnum
CloseProcessResult.CompletedTasks.StatusEnum string

任務狀態 (開啟、處理中、完成、準備完成、錯誤)

TaskTemplateId
CloseProcessResult.CompletedTasks.TaskTemplateId string

工作範本識別碼

CreatedDate
CloseProcessResult.CreatedDate string

處理程序的建立日期格式:yyyy-MM-ddTHH:mm:ss

行動
CloseProcessResult.CurrentTask.Action string

使用者的動作文字

指派的使用者標識碼
CloseProcessResult.CurrentTask.AssignedUserIds array of string

指派的使用者標識碼

評論
CloseProcessResult.CurrentTask.Comments array of object

評論

Date
CloseProcessResult.CurrentTask.Comments.Date string

評論日期

Id
CloseProcessResult.CurrentTask.Comments.Id string

註解編號

文字
CloseProcessResult.CurrentTask.Comments.Text string

使用者定義的註解

UserId
CloseProcessResult.CurrentTask.Comments.UserId string

已設定註解的使用者識別碼

已完成日期
CloseProcessResult.CurrentTask.CompletedDate string

目前任務的完成日期。 日期格式:yyyy-MM-ddTHH:mm:ss

已完成使用者標識碼
CloseProcessResult.CurrentTask.CompletedUserIds array of string

已完成使用者標識碼

CreatedDate
CloseProcessResult.CurrentTask.CreatedDate string

目前任務的建立日期。 日期格式:yyyy-MM-ddTHH:mm:ss

CreatorId
CloseProcessResult.CurrentTask.CreatorId string

目前工作建立者的使用者 ID

Description
CloseProcessResult.CurrentTask.Description string

目前任務的任務描述

截止日期
CloseProcessResult.CurrentTask.DueDate string

目前任務的到期日。 日期格式:yyyy-MM-ddTHH:mm:ss

Id
CloseProcessResult.CurrentTask.Id string

目前工作的標識碼

IntendedUserIds
CloseProcessResult.CurrentTask.IntendedUserIds array of string

IntendedUserIds

提醒日期
CloseProcessResult.CurrentTask.ReminderDate string

提醒當前任務的日期。 日期格式:yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
CloseProcessResult.CurrentTask.RequiresAllRecipients boolean

定義是否所有收件者都必須關閉目前的工作

顯示關閉工作對話框
CloseProcessResult.CurrentTask.ShowCloseTaskDialog boolean

在目前工作中顯示關閉工作對話方塊

StatusEnum
CloseProcessResult.CurrentTask.StatusEnum string

目前工作的狀態 (開啟、處理中、完成、準備完成、錯誤)

TaskTemplateId
CloseProcessResult.CurrentTask.TaskTemplateId string

目前任務的工作範本識別碼

自訂屬性
CloseProcessResult.CustomProperties array of object

自訂屬性

CustomPropertyTypeEnum
CloseProcessResult.CustomProperties.CustomPropertyTypeEnum string

自訂屬性的自訂屬性類型列舉值 (字串、日期、數字)

名稱
CloseProcessResult.CustomProperties.Name string

自訂屬性的名稱

價值觀
CloseProcessResult.CustomProperties.Value string

自訂屬性的值

文件標識符
CloseProcessResult.DocumentIds array of string

文件標識符

截止日期
CloseProcessResult.DueDate string

該過程的截止日期。 日期格式:yyyy-MM-ddTHH:mm:ss

Id
CloseProcessResult.Id string

進程的標識碼

價值觀
CloseProcessResult.Name.Values array of object

價值觀

文化特性
CloseProcessResult.Name.Values.Culture string

給出文本的文化(de、en、fr、...

文字
CloseProcessResult.Name.Values.Text string

進程名稱

插件流
CloseProcessResult.PluginStream array of

插件流

優先順序列舉
CloseProcessResult.PriorityEnum string

進程優先順序 (高、正常、低)

ProcessTemplateId
CloseProcessResult.ProcessTemplateId string

程序範本識別碼

屬性
CloseProcessResult.Properties array of object

屬性

全球價值觀
CloseProcessResult.Properties.GlobalValues array of object

全球價值觀

價值觀
CloseProcessResult.Properties.GlobalValues.Values array of object

價值觀

文化特性
CloseProcessResult.Properties.GlobalValues.Values.Culture string

文化特性

文字
CloseProcessResult.Properties.GlobalValues.Values.Text string

文字

屬性類型標識符
CloseProcessResult.Properties.PropertyTypeId string

索引欄位的類型 ID

價值觀
CloseProcessResult.Properties.Values array of string

價值觀

保護網域標識符
CloseProcessResult.ProtectionDomainId string

進程的保護網域ID

工作階段計數
CloseProcessResult.SessionCount integer

工作階段計數

StatusEnum
CloseProcessResult.StatusEnum string

進程狀態 (開啟、InProcess、Complete、PreparedToComplete、Error)