共用方式為

紀錄片

從流程中存取常見的 DocuWare 功能。

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

服務 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）
連絡人​​
名稱 DocuWare GmbH
URL https://support.docuware.com
Email support@docuware.com
連接器中繼資料
Publisher 紀錄片
網站 https://start.docuware.com
隱私策略 https://start.docuware.com/data-privacy
類別 內容和文件;生產力

DocuWare 提供強大且廣泛的 REST API。 借助 DocuWare 的 Power Automate 連接器，用戶現在可以在 Power Automate 中利用 DocuWare REST API 的許多最常見功能。 由於與 DocuWare 的無縫集成，這使用戶能夠更靈活地創建完全滿足其業務需求的流程。

先決條件

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

  • DocuWare Cloud 訂閱
  • Microsoft Power Apps 或 Power Automate 帳戶

如何取得認證

建立新的 API 金鑰非常簡單，可以在 DocuWare 中完成。

請依照以下步驟在 DocuWare 中建立新的 API 金鑰：

  1. 登入您要與 Power Automate 搭配使用的 DocuWare 帳戶
  2. 從主選單中，導覽至「設定」
  3. 從「設定」頁面，移至 [整合] 區段，然後按一下「Power Automate API 金鑰」圖示
    • 如果您沒有看到「Power Automate API 金鑰」圖示，則您的使用者可能沒有正確的權限。 請聯絡您的 DocuWare 管理員以解決此問題。
  4. 點擊「建立 API 金鑰」按鈕
  5. 填寫「名稱」和「描述」（可選）值，然後按一下「建立」
    • 按下「建立」後，設定過程會建立金鑰時可能會有輕微的延遲。
    • 另外，請務必保存您的 API 密鑰。 這將是您查看完整 API 金鑰的唯一機會。 如果您遺失此金鑰，則需要建立另一個金鑰。

此時，您現在擁有有效的 API 金鑰，可在 Power Automate 中用於建立與 DocuWare 的連線。 然後，此連線可以與 DocuWare Power Automate 連接器搭配使用。

開始使用連接器

在 Power Automate 中建立連線很容易，並且可以在建立流程時完成。

請依照下列步驟在 Power Automate 中建立新連線：

  1. 登入 Power Automate
  2. 建立新流程或開啟現有流程
  3. 將活動從 DocuWare Power Automate 連接器新增至您的流程
    • 按一下「+ 新步驟」，將新步驟新增至您的流程
    • 當出現「選擇作業」時，請從類別選擇中選擇「全部」，然後在搜尋欄位中輸入「DocuWare」。
    • 選取「DocuWare」連接器，然後從可用動作清單中選擇。
  4. 將動作新增至流程時，系統會提示您建立新的連線。
  5. 輸入您在上一節中從DocuWare收到的連線名稱（「連線名稱」）和API金鑰（以下簡稱「API金鑰」），然後按一下「建立」。

從此時起，從DocuWare聯結器新增的所有活動都將使用此連線。 您可以通過單擊“...”，然後點擊彈出的選單底部的「+ 新增連線」。

已知問題與限制

目前，新的 Power Automate 流程設計工具不支援 DocuWare 的 Power Automate 連接器。

常見錯誤和補救措施

HTTP 錯誤代碼：

  • 400：確保您已填寫活動中的所有必填欄位。 有些欄位是必填欄位，必須先填寫，才能執行活動。
  • 401：確保您輸入了正確的 API 金鑰。 您也可以在「設定」頁面的「整合」-> 「Power Automate API 金鑰」下檢查 API 金鑰的狀態。
  • 404：請確定指定的文件和/或檔案櫃存在，而且您可以存取它們。 如果文件或文件櫃不存在，或者您無權存取它們，那麼您將收到錯誤 404。
  • 500：這是一個一般錯誤，可能由許多不同的問題引起。 如果您收到此錯誤，請聯絡 DocuWare 支援尋求協助。

FAQ

最佳做法

以下是我們在使用 DocuWare Power Automate 連接器時建議的一些最佳實踐：

  • 一律使用專用的 DocuWare 使用者來驗證 DocuWare Power Automate 連接器。 這將使您能夠輕鬆跟踪和管理連接器正在執行的操作。
  • 首先使用「取得組織」活動測試您的流程。 這是 DocuWare Power Automate 連接器中提供的最基本動作，可讓您驗證連線是否正常運作。

正在建立連線

連接器支援下列驗證類型：
預設值 建立連線的參數。 所有區域 不可共享

預設

適用：所有地區

建立連線的參數。

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

名稱 類型 Description 為必填項目
API 金鑰 securestring 用於存取 DocuWare 的 API 金鑰 對

節流限制

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

動作

下載文件

從文件櫃或文件匣下載文件。
下載檔案

下載儲存在檔案櫃或文件匣中的檔案/文件區段。
刪除文件

從檔案櫃或文件匣中刪除文件。
刪除檔案

從現有文件中刪除檔案/區段。
匯入至文件匣

將新文件匯入文件匣。
取代檔案

取代現有文件中的檔案/區段。
取得圖章欄位

取得戳記的欄位清單。
取得對話方塊

取得檔案櫃或文件匣的對話方塊清單。
取得對話方塊欄位

取得對話方塊的欄位
取得文件櫃和文件托盤

取得檔案櫃和/或文件匣的清單。
取得文件資訊

取得文件的相關資訊。
取得檔案櫃欄位

取得檔案櫃的欄位清單。
取得組織

取得組織名稱。
在文件匣中列出文件

列出指定文件匣中的文件。
在檔案櫃中搜尋

在檔案櫃中搜尋符合指定條件的文件。
存儲到文件櫃

將新文件儲存到檔案櫃中。
放置圖章

在文件上蓋章。
更新索引欄位

更新文件的索引欄位。
獲取郵票

取得檔案櫃或文件匣的圖章清單。
轉移文件

將一或多個文件從一個檔案櫃/文件匣移至另一個檔案櫃/文件匣。
附加檔案

將檔案/區段附加至現有文件。

下載文件

作業識別碼：
DownloadDocument

從文件櫃或文件匣下載文件。

參數

名稱 機碼 必要 類型 Description
文件櫃/文件托盤
 FileCabinetID True string

選取包含文件的檔案櫃或文件匣。
文件 ID
 DocumentId True integer

指定您要下載的文件的 ID。
文件格式
 DocumentFormat True string

選取下載文件的格式。

傳回

身體

身體
binary

下載檔案

作業識別碼：
DownloadFile

下載儲存在檔案櫃或文件匣中的檔案/文件區段。

參數

名稱 機碼 必要 類型 Description
文件櫃/文件托盤
 FileCabinetID True string

選取包含文件的檔案櫃或文件匣。
文件 ID
 DocumentId True integer

指定您要下載的檔案的文件 ID。
檔案編號
 FileNumber True string

指定您要下載的檔案的檔案編號。
文件格式
 DocumentFormat True string

選取下載文件的格式。

傳回

身體

身體
binary

刪除文件

作業識別碼：
DeleteDocument

從檔案櫃或文件匣中刪除文件。

參數

名稱 機碼 必要 類型 Description
文件櫃/文件托盤
 FileCabinetID True string

選取包含文件的檔案櫃或文件匣。
文件 ID
 DocumentID True integer

指定您要刪除的文件的 ID。

刪除檔案

作業識別碼：
DeleteFile

從現有文件中刪除檔案/區段。

參數

名稱 機碼 必要 類型 Description
文件櫃/文件托盤
 FileCabinet True string

選取包含文件的檔案櫃或文件匣。
文件 ID
 DocumentID True integer

指定要從中刪除的文件的 ID。
檔案編號
 FileNumber True integer

指定要刪除的檔案編號。

匯入至文件匣

作業識別碼：
ImportToDocumentTray

將新文件匯入文件匣。

參數

名稱 機碼 必要 類型 Description
文件托盤
 DocumentTray True string

選取要匯入到的文件匣。
儲存對話方塊
 StoreDialogId string

選取要在匯入期間使用的存放區對話方塊。
索引資料
 index string

指定文件的索引資料。
檔案內容
 file file

指定要匯入的檔案內容。

傳回

名稱 路徑 類型 Description
章節
 Sections array of object

章節
簽章狀態
 Sections.SignatureStatus array of string

簽章狀態
區段標識符
 Sections.SectionId string

區段標識符
內容類型
 Sections.ContentType string

內容類型
有更多頁面
 Sections.HaveMorePages boolean

有更多頁面
頁數
 Sections.PageCount integer

頁數
文件大小
 Sections.FileSize integer

文件大小
原始檔案名稱
 Sections.OriginalFileName string

原始檔案名稱
內容修改
 Sections.ContentModified string

內容修改
HasText註解
 Sections.HasTextAnnotation boolean

HasText註解
註解預覽
 Sections.AnnotationsPreview boolean

註解預覽
DocumentId
 DocumentId integer

DocumentId
索引欄位
 IndexFields object

索引欄位
文件標題
 DocumentTitle string

文件標題
檔案內閣 ID
 FileCabinetId string

檔案內閣 ID
總頁數
 TotalPages integer

總頁數
文件大小
 FileSize integer

文件大小
內容類型
 ContentType string

內容類型
版本狀態
 VersionStatus string

版本狀態
是冷的
 DocumentFlags.isCold boolean

是冷的
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
是簽出
 DocumentFlags.isCheckedOut boolean

是簽出
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoice可用
 DocumentFlags.isVoiceAvailable boolean

isVoice可用
hasAppended文件
 DocumentFlags.hasAppendedDocuments boolean

hasAppended文件
是受保護的
 DocumentFlags.isProtected boolean

是受保護的
已刪除
 DocumentFlags.isDeleted boolean

已刪除
是電子郵件
 DocumentFlags.isEmail boolean

是電子郵件

取代檔案

作業識別碼：
ReplaceFile

取代現有文件中的檔案/區段。

參數

名稱 機碼 必要 類型 Description
文件櫃/文件托盤
 FileCabinet True string

選取包含文件的檔案櫃或文件匣。
文件 ID
 DocumentID True integer

指定要取代之檔案的文件 ID。
檔案編號
 FileNumber True integer

指定要取代的檔案編號。
檔案內容
 file file

指定要儲存的檔案內容。

傳回

名稱 路徑 類型 Description
簽章狀態
 SignatureStatus array of string

簽章狀態
區段標識符
 SectionId string

區段標識符
內容類型
 ContentType string

內容類型
有更多頁面
 HaveMorePages boolean

有更多頁面
頁數
 PageCount integer

頁數
文件大小
 FileSize integer

文件大小
原始檔案名稱
 OriginalFileName string

原始檔案名稱
內容修改
 ContentModified string

內容修改
HasText註解
 HasTextAnnotation boolean

HasText註解
註解預覽
 AnnotationsPreview boolean

註解預覽

取得圖章欄位

作業識別碼：
GetStampFields

取得戳記的欄位清單。

參數

名稱 機碼 必要 類型 Description
文件櫃/文件托盤
 FileCabinet True string

選擇帶有所需圖章的文件櫃或文件托盤。
郵票
 Stamp True string

選取戳記以取得其欄位。

傳回

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

Fields
Id
 Fields.Id string

Id
標籤
 Fields.Label string

標籤
顯示名稱
 Fields.DisplayName string

顯示名稱

取得對話方塊

作業識別碼：
GetDialogs

取得檔案櫃或文件匣的對話方塊清單。

參數

名稱 機碼 必要 類型 Description
文件櫃/文件托盤
 FileCabinet True string

選取要從中取得對話方塊的檔案櫃或文件匣。
對話類型
 DialogType string

選取要傳回的對話方塊類型。

傳回

名稱 路徑 類型 Description
對話框
 Dialogs array of object

對話框
名稱
 Dialogs.Name string

名稱
Guid
 Dialogs.Guid string

Guid
顏色
 Dialogs.Color string

顏色
IsDefault
 Dialogs.IsDefault boolean

IsDefault
類型
 Dialogs.Type string

類型
檔案內閣 ID
 Dialogs.FileCabinetId string

檔案內閣 ID

取得對話方塊欄位

作業識別碼：
GetDialogFields

取得對話方塊的欄位

參數

名稱 機碼 必要 類型 Description
文件櫃
 FileCabinet True string

選取檔案櫃
Dialog
 DialogId True string

選取對話方塊以取得其欄位。

傳回

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

Fields
DBField名稱
 Fields.DBFieldName string

DBField名稱
DWField類型
 Fields.DWFieldType string

DWField類型
顯示名稱
 Fields.DisplayName string

顯示名稱
ReadOnly
 Fields.ReadOnly boolean

ReadOnly
可見
 Fields.Visible boolean

可見

取得文件櫃和文件托盤

作業識別碼：
GetFileCabinets

取得檔案櫃和/或文件匣的清單。

參數

名稱 機碼 必要 類型 Description
文件櫃類型
 FileCabinetType True string

選取您要傳回的類型。

傳回

名稱 路徑 類型 Description
檔案櫃
 FileCabinets array of object

檔案櫃
名稱
 FileCabinets.Name string

名稱
Guid
 FileCabinets.Guid string

Guid
顏色
 FileCabinets.Color string

顏色
伊斯托盤
 FileCabinets.IsTray boolean

伊斯托盤

取得文件資訊

作業識別碼：
GetDocumentInformation

取得文件的相關資訊。

參數

名稱 機碼 必要 類型 Description
文件櫃/文件托盤
 FileCabinetID True string

選取包含文件的檔案櫃或文件匣。
文件 ID
 DocumentID True integer

指定您要提供資訊的文件的 ID。

傳回

名稱 路徑 類型 Description
章節
 Sections array of object

章節
簽章狀態
 Sections.SignatureStatus array of string

簽章狀態
區段標識符
 Sections.SectionId string

區段標識符
內容類型
 Sections.ContentType string

內容類型
有更多頁面
 Sections.HaveMorePages boolean

有更多頁面
頁數
 Sections.PageCount integer

頁數
文件大小
 Sections.FileSize integer

文件大小
原始檔案名稱
 Sections.OriginalFileName string

原始檔案名稱
內容修改
 Sections.ContentModified string

內容修改
HasText註解
 Sections.HasTextAnnotation boolean

HasText註解
註解預覽
 Sections.AnnotationsPreview boolean

註解預覽
DocumentId
 DocumentId integer

DocumentId
索引欄位
 IndexFields object

索引欄位
文件標題
 DocumentTitle string

文件標題
檔案內閣 ID
 FileCabinetId string

檔案內閣 ID
總頁數
 TotalPages integer

總頁數
文件大小
 FileSize integer

文件大小
內容類型
 ContentType string

內容類型
版本狀態
 VersionStatus string

版本狀態
是冷的
 DocumentFlags.isCold boolean

是冷的
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
是簽出
 DocumentFlags.isCheckedOut boolean

是簽出
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoice可用
 DocumentFlags.isVoiceAvailable boolean

isVoice可用
hasAppended文件
 DocumentFlags.hasAppendedDocuments boolean

hasAppended文件
是受保護的
 DocumentFlags.isProtected boolean

是受保護的
已刪除
 DocumentFlags.isDeleted boolean

已刪除
是電子郵件
 DocumentFlags.isEmail boolean

是電子郵件

取得檔案櫃欄位

作業識別碼：
GetFileCabinetFields

取得檔案櫃的欄位清單。

參數

名稱 機碼 必要 類型 Description
文件櫃
 FileCabinet True string

選取要取得其欄位的檔案櫃。
欄位類型
 FieldType string

選取要傳回的欄位類型。

傳回

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

Fields
TableField資料行
 Fields.TableFieldColumns array of object

TableField資料行
DBField名稱
 Fields.TableFieldColumns.DBFieldName string

DBField名稱
DWField類型
 Fields.TableFieldColumns.DWFieldType string

DWField類型
顯示名稱
 Fields.TableFieldColumns.DisplayName string

顯示名稱
DropLeadingBlanks
 Fields.TableFieldColumns.DropLeadingBlanks boolean

DropLeadingBlanks
DropLeading零
 Fields.TableFieldColumns.DropLeadingZero boolean

DropLeading零
欄位資訊文字
 Fields.TableFieldColumns.FieldInfoText string

欄位資訊文字
固定項目
 Fields.TableFieldColumns.FixedEntry string

固定項目
長度
 Fields.TableFieldColumns.Length integer

長度
非空白
 Fields.TableFieldColumns.NotEmpty boolean

非空白
精確度
 Fields.TableFieldColumns.Precision integer

精確度
Scope
 Fields.TableFieldColumns.Scope string

Scope
UsedAs文件名稱
 Fields.UsedAsDocumentName boolean

UsedAs文件名稱
DBField名稱
 Fields.DBFieldName string

DBField名稱
DWField類型
 Fields.DWFieldType string

DWField類型
顯示名稱
 Fields.DisplayName string

顯示名稱
DropLeadingBlanks
 Fields.DropLeadingBlanks boolean

DropLeadingBlanks
DropLeading零
 Fields.DropLeadingZero boolean

DropLeading零
欄位資訊文字
 Fields.FieldInfoText string

欄位資訊文字
固定項目
 Fields.FixedEntry string

固定項目
長度
 Fields.Length integer

長度
非空白
 Fields.NotEmpty boolean

非空白
精確度
 Fields.Precision integer

精確度
Scope
 Fields.Scope string

Scope

取得組織

作業識別碼：
GetOrganization

取得組織名稱。

傳回

名稱 路徑 類型 Description
名稱
 Name string

名稱

在文件匣中列出文件

作業識別碼：
ListDocumentsInDocumentTray

列出指定文件匣中的文件。

參數

名稱 機碼 必要 類型 Description
文件托盤
 DocumentTray True string

選取要搜尋的文件匣。

傳回

名稱 路徑 類型 Description
Count
 Count integer

Count
Documents
 Documents array of object
章節
 Documents.Sections array of

章節
DocumentId
 Documents.DocumentId integer

DocumentId
索引欄位
 Documents.IndexFields object

索引欄位
文件標題
 Documents.DocumentTitle string

文件標題
檔案內閣 ID
 Documents.FileCabinetId string

檔案內閣 ID
總頁數
 Documents.TotalPages integer

總頁數
文件大小
 Documents.FileSize integer

文件大小
內容類型
 Documents.ContentType string

內容類型
版本狀態
 Documents.VersionStatus string

版本狀態
是冷的
 Documents.DocumentFlags.isCold boolean

是冷的
isDBRecord
 Documents.DocumentFlags.isDBRecord boolean

isDBRecord
是簽出
 Documents.DocumentFlags.isCheckedOut boolean

是簽出
isCopyRightProtected
 Documents.DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoice可用
 Documents.DocumentFlags.isVoiceAvailable boolean

isVoice可用
hasAppended文件
 Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppended文件
是受保護的
 Documents.DocumentFlags.isProtected boolean

是受保護的
已刪除
 Documents.DocumentFlags.isDeleted boolean

已刪除
是電子郵件
 Documents.DocumentFlags.isEmail boolean

是電子郵件

在檔案櫃中搜尋

作業識別碼：
SearchForDocumentsInFileCabinet

在檔案櫃中搜尋符合指定條件的文件。

參數

名稱 機碼 必要 類型 Description
文件櫃
 FileCabinet True string

選取要搜尋的檔案櫃。
搜尋對話方塊
 SearchDialogId True string

選取要用於搜尋的搜尋對話方塊。
搜尋查詢
 SearchQuery True

傳回

名稱 路徑 類型 Description
Count
 Count integer

Count
Documents
 Documents array of object

Documents
章節
 Documents.Sections array of

章節
DocumentId
 Documents.DocumentId integer

DocumentId
索引欄位
 Documents.IndexFields object

索引欄位
文件標題
 Documents.DocumentTitle string

文件標題
檔案內閣 ID
 Documents.FileCabinetId string

檔案內閣 ID
總頁數
 Documents.TotalPages integer

總頁數
文件大小
 Documents.FileSize integer

文件大小
內容類型
 Documents.ContentType string

內容類型
版本狀態
 Documents.VersionStatus string

版本狀態
是冷的
 Documents.DocumentFlags.isCold boolean

是冷的
isDBRecord
 Documents.DocumentFlags.isDBRecord boolean

isDBRecord
是簽出
 Documents.DocumentFlags.isCheckedOut boolean

是簽出
isCopyRightProtected
 Documents.DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoice可用
 Documents.DocumentFlags.isVoiceAvailable boolean

isVoice可用
hasAppended文件
 Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppended文件
是受保護的
 Documents.DocumentFlags.isProtected boolean

是受保護的
已刪除
 Documents.DocumentFlags.isDeleted boolean

已刪除
是電子郵件
 Documents.DocumentFlags.isEmail boolean

是電子郵件

存儲到文件櫃

作業識別碼：
StoreToFileCabinet

將新文件儲存到檔案櫃中。

參數

名稱 機碼 必要 類型 Description
文件櫃
 FileCabinet True string

選取要儲存的檔案櫃。
儲存對話方塊
 StoreDialogId True string

選取要用於儲存的儲存對話方塊。
索引資料
 index string

指定文件的索引資料。
檔案內容
 file file

指定要儲存的檔案內容。

傳回

名稱 路徑 類型 Description
章節
 Sections array of object

章節
簽章狀態
 Sections.SignatureStatus array of string

簽章狀態
區段標識符
 Sections.SectionId string

區段標識符
內容類型
 Sections.ContentType string

內容類型
有更多頁面
 Sections.HaveMorePages boolean

有更多頁面
頁數
 Sections.PageCount integer

頁數
文件大小
 Sections.FileSize integer

文件大小
原始檔案名稱
 Sections.OriginalFileName string

原始檔案名稱
內容修改
 Sections.ContentModified string

內容修改
HasText註解
 Sections.HasTextAnnotation boolean

HasText註解
註解預覽
 Sections.AnnotationsPreview boolean

註解預覽
DocumentId
 DocumentId integer

DocumentId
索引欄位
 IndexFields object

索引欄位
文件標題
 DocumentTitle string

文件標題
檔案內閣 ID
 FileCabinetId string

檔案內閣 ID
總頁數
 TotalPages integer

總頁數
文件大小
 FileSize integer

文件大小
內容類型
 ContentType string

內容類型
版本狀態
 VersionStatus string

版本狀態
是冷的
 DocumentFlags.isCold boolean

是冷的
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
是簽出
 DocumentFlags.isCheckedOut boolean

是簽出
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoice可用
 DocumentFlags.isVoiceAvailable boolean

isVoice可用
hasAppended文件
 DocumentFlags.hasAppendedDocuments boolean

hasAppended文件
是受保護的
 DocumentFlags.isProtected boolean

是受保護的
已刪除
 DocumentFlags.isDeleted boolean

已刪除
是電子郵件
 DocumentFlags.isEmail boolean

是電子郵件

放置圖章

作業識別碼：
PlaceAStamp

在文件上蓋章。

參數

名稱 機碼 必要 類型 Description
文件櫃/文件托盤
 FileCabinetID True string

選取包含文件的檔案櫃或文件匣。
文件 ID
 DocumentID True integer

指定要蓋章的文件的 ID。
檔案編號
 FileNumber True integer

指定包含要蓋章的頁面的檔案/區段。
頁碼
 PageNumber True integer

指定要放置圖章的頁碼。
層
 Layer True integer

指定要在[1-5]上放置圖章的文件圖層
水平位置（X 位置）
 PositionX number

[選用]從頁面左邊緣開始的位置，以毫米為單位。
垂直位置（Y 位置）
 PositionY number

[選用]從頁面上邊緣開始的位置，以毫米為單位。
郵票
 StampId True string

選擇或指定要使用的圖章。
密碼
 Password string

指定戳記的密碼 （如有需要）。
名稱
 Name string

指定欄位名稱。
價值觀
 Value string

指定欄位值。

傳回

名稱 路徑 類型 Description
User
 Created.User string

User
Time
 Created.Time string

Time
類型
 Type string

類型
顏色
 Color string

顏色
Rotation
 Rotation integer

Rotation
Transparent
 Transparent boolean

Transparent
筆劃寬度
 StrokeWidth integer

筆劃寬度
Guid
 Guid string

Guid

更新索引欄位

作業識別碼：
UpdateIndexFields

更新文件的索引欄位。

參數

名稱 機碼 必要 類型 Description
文件櫃
 FileCabinetID True string

選取包含要更新的文件的檔案櫃。
文件 ID
 DocumentID True integer

指定要更新的文件 ID。
名稱
 Name string

選取或指定索引欄位。
價值觀
 Value string

指定索引值。

傳回

名稱 路徑 類型 Description
章節
 Sections array of object

章節
簽章狀態
 Sections.SignatureStatus array of string

簽章狀態
區段標識符
 Sections.SectionId string

區段標識符
內容類型
 Sections.ContentType string

內容類型
有更多頁面
 Sections.HaveMorePages boolean

有更多頁面
頁數
 Sections.PageCount integer

頁數
文件大小
 Sections.FileSize integer

文件大小
原始檔案名稱
 Sections.OriginalFileName string

原始檔案名稱
內容修改
 Sections.ContentModified string

內容修改
HasText註解
 Sections.HasTextAnnotation boolean

HasText註解
註解預覽
 Sections.AnnotationsPreview boolean

註解預覽
DocumentId
 DocumentId integer

DocumentId
索引欄位
 IndexFields object

索引欄位
文件標題
 DocumentTitle string

文件標題
檔案內閣 ID
 FileCabinetId string

檔案內閣 ID
總頁數
 TotalPages integer

總頁數
文件大小
 FileSize integer

文件大小
內容類型
 ContentType string

內容類型
版本狀態
 VersionStatus string

版本狀態
是冷的
 DocumentFlags.isCold boolean

是冷的
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
是簽出
 DocumentFlags.isCheckedOut boolean

是簽出
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoice可用
 DocumentFlags.isVoiceAvailable boolean

isVoice可用
hasAppended文件
 DocumentFlags.hasAppendedDocuments boolean

hasAppended文件
是受保護的
 DocumentFlags.isProtected boolean

是受保護的
已刪除
 DocumentFlags.isDeleted boolean

已刪除
是電子郵件
 DocumentFlags.isEmail boolean

是電子郵件

獲取郵票

作業識別碼：
GetStamps

取得檔案櫃或文件匣的圖章清單。

參數

名稱 機碼 必要 類型 Description
文件櫃/文件托盤
 FileCabinet True string

選取要從中取得圖章的檔案櫃或文件匣。

傳回

名稱 路徑 類型 Description
郵票
 Stamps array of object

郵票
Id
 Stamps.Id string

Id
名稱
 Stamps.Name string

名稱
顯示名稱
 Stamps.DisplayName string

顯示名稱
顏色
 Stamps.Color string

顏色
Signature
 Stamps.Signature string

Signature
密碼保護
 Stamps.PasswordProtected boolean

密碼保護
改寫
 Stamps.Overwrite boolean

改寫
類型
 Stamps.Type string

類型
檔案內閣 ID
 Stamps.FileCabinetId string

檔案內閣 ID

轉移文件

作業識別碼：
TransferDocument

將一或多個文件從一個檔案櫃/文件匣移至另一個檔案櫃/文件匣。

參數

名稱 機碼 必要 類型 Description
目的地文件櫃/文件托盤
 DestinationFileCabinetID True string

選擇目的地文件櫃或文件匣。
儲存對話方塊
 StoreDialogID string

選取儲存對話方塊，以索引要移動的文件。
來源檔案櫃/文件匣
 SourceFileCabinetId True string

選取來源檔案櫃或文件匣。
ID
 DocumentId integer

指定文件 ID。
名稱
 Name string

選取或指定欄位名稱。
價值觀
 Value string

指定欄位值。
保留來源
 KeepSource boolean

選擇是否應刪除來源文件。
填充 Intellix
 FillIntellix boolean

選擇儲存時是否應使用智慧型索引。

傳回

名稱 路徑 類型 Description
Count
 Count integer

Count
Documents
 Documents array of object

Documents
章節
 Documents.Sections array of object

章節
簽章狀態
 Documents.Sections.SignatureStatus array of string

簽章狀態
區段標識符
 Documents.Sections.SectionId string

區段標識符
內容類型
 Documents.Sections.ContentType string

內容類型
有更多頁面
 Documents.Sections.HaveMorePages boolean

有更多頁面
頁數
 Documents.Sections.PageCount integer

頁數
文件大小
 Documents.Sections.FileSize integer

文件大小
原始檔案名稱
 Documents.Sections.OriginalFileName string

原始檔案名稱
內容修改
 Documents.Sections.ContentModified string

內容修改
HasText註解
 Documents.Sections.HasTextAnnotation boolean

HasText註解
註解預覽
 Documents.Sections.AnnotationsPreview boolean

註解預覽
DocumentId
 Documents.DocumentId integer

DocumentId
索引欄位
 Documents.IndexFields object

索引欄位
文件標題
 Documents.DocumentTitle string

文件標題
檔案內閣 ID
 Documents.FileCabinetId string

檔案內閣 ID
總頁數
 Documents.TotalPages integer

總頁數
文件大小
 Documents.FileSize integer

文件大小
內容類型
 Documents.ContentType string

內容類型
版本狀態
 Documents.VersionStatus string

版本狀態
是冷的
 Documents.DocumentFlags.isCold boolean

是冷的
isDBRecord
 Documents.DocumentFlags.isDBRecord boolean

isDBRecord
是簽出
 Documents.DocumentFlags.isCheckedOut boolean

是簽出
isCopyRightProtected
 Documents.DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoice可用
 Documents.DocumentFlags.isVoiceAvailable boolean

isVoice可用
hasAppended文件
 Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppended文件
是受保護的
 Documents.DocumentFlags.isProtected boolean

是受保護的
已刪除
 Documents.DocumentFlags.isDeleted boolean

已刪除
是電子郵件
 Documents.DocumentFlags.isEmail boolean

是電子郵件

附加檔案

作業識別碼：
AppendFile

將檔案/區段附加至現有文件。

參數

名稱 機碼 必要 類型 Description
文件櫃/文件托盤
 FileCabinet True string

選取包含文件的檔案櫃或文件匣。
文件 ID
 DocID True string

指定要附加的文件 ID。
檔案內容
 file file

指定要儲存的檔案內容。

傳回

名稱 路徑 類型 Description
簽章狀態
 SignatureStatus array of string

簽章狀態
區段標識符
 SectionId string

區段標識符
內容類型
 ContentType string

內容類型
有更多頁面
 HaveMorePages boolean

有更多頁面
頁數
 PageCount integer

頁數
文件大小
 FileSize integer

文件大小
原始檔案名稱
 OriginalFileName string

原始檔案名稱
內容修改
 ContentModified string

內容修改
HasText註解
 HasTextAnnotation boolean

HasText註解
註解預覽
 AnnotationsPreview boolean

註解預覽

定義

二進位

這是基本數據類型 『binary』。