通过

DocuWare

从流中访问常见的 DocuWare 功能。

此连接器在以下产品和区域中可用：

服务 Class 区域
Copilot Studio 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域 ：
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部（DoD）
Power Apps 高级 除以下各项外的所有 Power Apps 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
Power Automate 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
联系人​​
Name DocuWare GmbH
URL https://support.docuware.com
Email support@docuware.com
连接器元数据
发布者 DocuWare
网站 https://start.docuware.com
隐私策略 https://start.docuware.com/data-privacy
类别 内容和文件;生产力

DocuWare 提供强大而广泛的 REST API。 借助 DocuWare 的 Power Automate 连接器，用户现在可以利用 Power Automate 中 DocuWare REST API 的许多最常见功能。 这允许用户更灵活地创建完全满足其业务需求的流，这得益于与 DocuWare 的无缝集成。

先决条件

需要满足以下条件才能继续作：

  • DocuWare 云订阅
  • 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. 填写“Name”和“Description”（可选）值，然后单击“创建”
    • 按“创建”后，配置过程创建密钥时可能会稍有延迟。
    • 此外，请务必保存 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 Flow 设计器不支持 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 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name 类型 Description 必选
API 密钥 securestring 用于访问 DocuWare 的 API 密钥 True

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

下载文件

下载存储在文件柜或文档托盘中的文档的文件/部分。
下载文档

从文件柜或文档托盘下载文档。
传输文档

将一个或多个文档从一个文件柜/文档托盘移动到另一个文件柜/文档托盘。
列出文档托盘中的文档

列出指定文档托盘中的文档。
删除文件

从现有文档中删除文件/节。
删除文档

从文件柜或文档托盘中删除文档。
在文件柜中搜索

在文件柜中搜索与指定条件匹配的文档。
存储到文件柜

将新文档存储在文件柜中。
导入到文档托盘

将新文档导入文档托盘。
放置印章

在文档上放置印章。
更新索引字段

更新文档的索引字段。
替换文件

替换现有文档中的文件/节。
获取对话

获取文件柜或文档托盘的对话框列表。
获取对话框字段

获取对话框的字段
获取文件柜和文档托盘

获取文件柜和/或文档托盘的列表。
获取文件柜字段

获取文件柜的字段列表。
获取文档信息

获取有关文档的信息。
获取标记字段

获取标记的字段列表。
获取组织

获取组织名称。
获取邮票

获取文件柜或文档托盘的图章列表。
追加文件

将文件/节追加到现有文档。

下载文件

操作 ID:
DownloadFile

下载存储在文件柜或文档托盘中的文档的文件/部分。

参数

名称 密钥 必需 类型 说明
文件柜/文档托盘
 FileCabinetID True string

选择包含文档的文件柜或文档托盘。
文档 ID
 DocumentId True integer

使用要下载的文件指定文档的 ID。
文件编号
 FileNumber True string

指定要下载的文件的文件编号。
文档格式
 DocumentFormat True string

选择下载的文档的格式。

返回

Body

Body
binary

下载文档

操作 ID:
DownloadDocument

从文件柜或文档托盘下载文档。

参数

名称 密钥 必需 类型 说明
文件柜/文档托盘
 FileCabinetID True string

选择包含文档的文件柜或文档托盘。
文档 ID
 DocumentId True integer

指定要下载的文档的 ID。
文档格式
 DocumentFormat True string

选择下载的文档的格式。

返回

Body

Body
binary

传输文档

操作 ID:
TransferDocument

将一个或多个文档从一个文件柜/文档托盘移动到另一个文件柜/文档托盘。

参数

名称 密钥 必需 类型 说明
目标文件柜/文档托盘
 DestinationFileCabinetID True string

选择目标文件柜或文档托盘。
“存储”对话框
 StoreDialogID string

选择存储对话框，以便为要移动的文档编制索引。
源文件内阁/文档托盘
 SourceFileCabinetId True string

选择源文件内阁或文档托盘。
ID
 DocumentId integer

指定文档 ID。
Name
 Name string

选择或指定字段名称。
价值
 Value string

指定字段值。
保留源
 KeepSource boolean

选择是否应删除源文档。
填充 Intellix
 FillIntellix boolean

选择在存储时是否应使用智能索引。

返回

名称 路径 类型 说明
计数
 Count integer

计数
文档
 Documents array of object

文档
章节
 Documents.Sections array of object

章节
SignatureStatus
 Documents.Sections.SignatureStatus array of string

SignatureStatus
SectionId
 Documents.Sections.SectionId string

SectionId
内容类型
 Documents.Sections.ContentType string

内容类型
HaveMorePages
 Documents.Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Documents.Sections.PageCount integer

PageCount
文件大小
 Documents.Sections.FileSize integer

文件大小
OriginalFileName
 Documents.Sections.OriginalFileName string

OriginalFileName
ContentModified
 Documents.Sections.ContentModified string

ContentModified
HasTextAnnotation
 Documents.Sections.HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 Documents.Sections.AnnotationsPreview boolean

AnnotationsPreview
DocumentId
 Documents.DocumentId integer

DocumentId
IndexFields
 Documents.IndexFields object

IndexFields
DocumentTitle
 Documents.DocumentTitle string

DocumentTitle
FileCabinetId
 Documents.FileCabinetId string

FileCabinetId
TotalPages
 Documents.TotalPages integer

TotalPages
文件大小
 Documents.FileSize integer

文件大小
内容类型
 Documents.ContentType string

内容类型
VersionStatus
 Documents.VersionStatus string

VersionStatus
isCold
 Documents.DocumentFlags.isCold boolean

isCold
isDBRecord
 Documents.DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 Documents.DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 Documents.DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 Documents.DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 Documents.DocumentFlags.isProtected boolean

isProtected
isDeleted
 Documents.DocumentFlags.isDeleted boolean

isDeleted
isEmail
 Documents.DocumentFlags.isEmail boolean

isEmail

列出文档托盘中的文档

操作 ID:
ListDocumentsInDocumentTray

列出指定文档托盘中的文档。

参数

名称 密钥 必需 类型 说明
文档托盘
 DocumentTray True string

选择要搜索的文档栏。

返回

名称 路径 类型 说明
计数
 Count integer

计数
文档
 Documents array of object
章节
 Documents.Sections array of

章节
DocumentId
 Documents.DocumentId integer

DocumentId
IndexFields
 Documents.IndexFields object

IndexFields
DocumentTitle
 Documents.DocumentTitle string

DocumentTitle
FileCabinetId
 Documents.FileCabinetId string

FileCabinetId
TotalPages
 Documents.TotalPages integer

TotalPages
文件大小
 Documents.FileSize integer

文件大小
内容类型
 Documents.ContentType string

内容类型
VersionStatus
 Documents.VersionStatus string

VersionStatus
isCold
 Documents.DocumentFlags.isCold boolean

isCold
isDBRecord
 Documents.DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 Documents.DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 Documents.DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 Documents.DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 Documents.DocumentFlags.isProtected boolean

isProtected
isDeleted
 Documents.DocumentFlags.isDeleted boolean

isDeleted
isEmail
 Documents.DocumentFlags.isEmail boolean

isEmail

删除文件

操作 ID:
DeleteFile

从现有文档中删除文件/节。

参数

名称 密钥 必需 类型 说明
文件柜/文档托盘
 FileCabinet True string

选择包含文档的文件柜或文档托盘。
文档 ID
 DocumentID True integer

指定要从中删除的文档的 ID。
文件编号
 FileNumber True integer

指定要删除的文件编号。

删除文档

操作 ID:
DeleteDocument

从文件柜或文档托盘中删除文档。

参数

名称 密钥 必需 类型 说明
文件柜/文档托盘
 FileCabinetID True string

选择包含文档的文件柜或文档托盘。
文档 ID
 DocumentID True integer

指定要删除的文档的 ID。

在文件柜中搜索

操作 ID:
SearchForDocumentsInFileCabinet

在文件柜中搜索与指定条件匹配的文档。

参数

名称 密钥 必需 类型 说明
档案柜
 FileCabinet True string

选择要搜索的文件柜。
搜索对话框
 SearchDialogId True string

选择要用于搜索的搜索对话框。
搜索查询
 SearchQuery True

返回

名称 路径 类型 说明
计数
 Count integer

计数
文档
 Documents array of object

文档
章节
 Documents.Sections array of

章节
DocumentId
 Documents.DocumentId integer

DocumentId
IndexFields
 Documents.IndexFields object

IndexFields
DocumentTitle
 Documents.DocumentTitle string

DocumentTitle
FileCabinetId
 Documents.FileCabinetId string

FileCabinetId
TotalPages
 Documents.TotalPages integer

TotalPages
文件大小
 Documents.FileSize integer

文件大小
内容类型
 Documents.ContentType string

内容类型
VersionStatus
 Documents.VersionStatus string

VersionStatus
isCold
 Documents.DocumentFlags.isCold boolean

isCold
isDBRecord
 Documents.DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 Documents.DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 Documents.DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 Documents.DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 Documents.DocumentFlags.isProtected boolean

isProtected
isDeleted
 Documents.DocumentFlags.isDeleted boolean

isDeleted
isEmail
 Documents.DocumentFlags.isEmail boolean

isEmail

存储到文件柜

操作 ID:
StoreToFileCabinet

将新文档存储在文件柜中。

参数

名称 密钥 必需 类型 说明
档案柜
 FileCabinet True string

选择要存储到的文件柜。
“存储”对话框
 StoreDialogId True string

选择要用于存储的存储对话框。
索引数据
 index string

指定文档的索引数据。
文件内容
 file file

指定要存储的文件的内容。

返回

名称 路径 类型 说明
章节
 Sections array of object

章节
SignatureStatus
 Sections.SignatureStatus array of string

SignatureStatus
SectionId
 Sections.SectionId string

SectionId
内容类型
 Sections.ContentType string

内容类型
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
文件大小
 Sections.FileSize integer

文件大小
OriginalFileName
 Sections.OriginalFileName string

OriginalFileName
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 Sections.AnnotationsPreview boolean

AnnotationsPreview
DocumentId
 DocumentId integer

DocumentId
IndexFields
 IndexFields object

IndexFields
DocumentTitle
 DocumentTitle string

DocumentTitle
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
文件大小
 FileSize integer

文件大小
内容类型
 ContentType string

内容类型
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isDeleted
 DocumentFlags.isDeleted boolean

isDeleted
isEmail
 DocumentFlags.isEmail boolean

isEmail

导入到文档托盘

操作 ID:
ImportToDocumentTray

将新文档导入文档托盘。

参数

名称 密钥 必需 类型 说明
文档托盘
 DocumentTray True string

选择要导入到的文档托盘。
“存储”对话框
 StoreDialogId string

选择要在导入期间使用的存储对话框。
索引数据
 index string

指定文档的索引数据。
文件内容
 file file

指定要导入的文件的内容。

返回

名称 路径 类型 说明
章节
 Sections array of object

章节
SignatureStatus
 Sections.SignatureStatus array of string

SignatureStatus
SectionId
 Sections.SectionId string

SectionId
内容类型
 Sections.ContentType string

内容类型
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
文件大小
 Sections.FileSize integer

文件大小
OriginalFileName
 Sections.OriginalFileName string

OriginalFileName
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 Sections.AnnotationsPreview boolean

AnnotationsPreview
DocumentId
 DocumentId integer

DocumentId
IndexFields
 IndexFields object

IndexFields
DocumentTitle
 DocumentTitle string

DocumentTitle
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
文件大小
 FileSize integer

文件大小
内容类型
 ContentType string

内容类型
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isDeleted
 DocumentFlags.isDeleted boolean

isDeleted
isEmail
 DocumentFlags.isEmail boolean

isEmail

放置印章

操作 ID:
PlaceAStamp

在文档上放置印章。

参数

名称 密钥 必需 类型 说明
文件柜/文档托盘
 FileCabinetID True string

选择包含文档的文件柜或文档托盘。
文档 ID
 DocumentID True integer

指定要标记的文档的 ID。
文件编号
 FileNumber True integer

指定要标记的页面的文件/节。
页码
 PageNumber True integer

指定要放置标记的页码。
层
 Layer True integer

指定要在 [1-5] 上放置图章的文档层
水平位置 （X 位置）
 PositionX number

[可选]位于页面左边缘的位置（以 mm 为单位）。
垂直位置 （Y 位置）
 PositionY number

[可选]从页面的上边缘位置（以 mm 为单位）。
邮票
 StampId True string

选择或指定要使用的标记。
密码
 Password string

指定标记的密码（如果需要）。
Name
 Name string

指定字段名称。
价值
 Value string

指定字段值。

返回

名称 路径 类型 说明
用户
 Created.User string

用户
Time
 Created.Time string

Time
类型
 Type string

类型
颜色
 Color string

颜色
旋转
 Rotation integer

旋转
Transparent
 Transparent boolean

Transparent
StrokeWidth
 StrokeWidth integer

StrokeWidth
Guid
 Guid string

Guid

更新索引字段

操作 ID:
UpdateIndexFields

更新文档的索引字段。

参数

名称 密钥 必需 类型 说明
档案柜
 FileCabinetID True string

选择包含要更新的文档的文件柜。
文档 ID
 DocumentID True integer

指定要更新的文档的 ID。
Name
 Name string

选择或指定索引字段。
价值
 Value string

指定索引值。

返回

名称 路径 类型 说明
章节
 Sections array of object

章节
SignatureStatus
 Sections.SignatureStatus array of string

SignatureStatus
SectionId
 Sections.SectionId string

SectionId
内容类型
 Sections.ContentType string

内容类型
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
文件大小
 Sections.FileSize integer

文件大小
OriginalFileName
 Sections.OriginalFileName string

OriginalFileName
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 Sections.AnnotationsPreview boolean

AnnotationsPreview
DocumentId
 DocumentId integer

DocumentId
IndexFields
 IndexFields object

IndexFields
DocumentTitle
 DocumentTitle string

DocumentTitle
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
文件大小
 FileSize integer

文件大小
内容类型
 ContentType string

内容类型
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isDeleted
 DocumentFlags.isDeleted boolean

isDeleted
isEmail
 DocumentFlags.isEmail boolean

isEmail

替换文件

操作 ID:
ReplaceFile

替换现有文档中的文件/节。

参数

名称 密钥 必需 类型 说明
文件柜/文档托盘
 FileCabinet True string

选择包含文档的文件柜或文档托盘。
文档 ID
 DocumentID True integer

使用要替换的文件指定要替换的文档的 ID。
文件编号
 FileNumber True integer

指定要替换的文件编号。
文件内容
 file file

指定要存储的文件的内容。

返回

名称 路径 类型 说明
SignatureStatus
 SignatureStatus array of string

SignatureStatus
SectionId
 SectionId string

SectionId
内容类型
 ContentType string

内容类型
HaveMorePages
 HaveMorePages boolean

HaveMorePages
PageCount
 PageCount integer

PageCount
文件大小
 FileSize integer

文件大小
OriginalFileName
 OriginalFileName string

OriginalFileName
ContentModified
 ContentModified string

ContentModified
HasTextAnnotation
 HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 AnnotationsPreview boolean

AnnotationsPreview

获取对话

操作 ID:
GetDialogs

获取文件柜或文档托盘的对话框列表。

参数

名称 密钥 必需 类型 说明
文件柜/文档托盘
 FileCabinet True string

选择要从中获取对话框的文件柜或文档栏。
对话框类型
 DialogType string

选择要返回的对话框的类型。

返回

名称 路径 类型 说明
Dialogs
 Dialogs array of object

Dialogs
Name
 Dialogs.Name string

Name
Guid
 Dialogs.Guid string

Guid
颜色
 Dialogs.Color string

颜色
IsDefault
 Dialogs.IsDefault boolean

IsDefault
类型
 Dialogs.Type string

类型
FileCabinetId
 Dialogs.FileCabinetId string

FileCabinetId

获取对话框字段

操作 ID:
GetDialogFields

获取对话框的字段

参数

名称 密钥 必需 类型 说明
档案柜
 FileCabinet True string

选择文件柜
Dialog
 DialogId True string

选择对话框以获取其字段。

返回

名称 路径 类型 说明
Fields
 Fields array of object

Fields
DBFieldName
 Fields.DBFieldName string

DBFieldName
DWFieldType
 Fields.DWFieldType string

DWFieldType
显示名称
 Fields.DisplayName string

显示名称
ReadOnly
 Fields.ReadOnly boolean

ReadOnly
可见
 Fields.Visible boolean

可见

获取文件柜和文档托盘

操作 ID:
GetFileCabinets

获取文件柜和/或文档托盘的列表。

参数

名称 密钥 必需 类型 说明
文件柜类型
 FileCabinetType True string

选择要返回的类型。

返回

名称 路径 类型 说明
FileCabinets
 FileCabinets array of object

FileCabinets
Name
 FileCabinets.Name string

Name
Guid
 FileCabinets.Guid string

Guid
颜色
 FileCabinets.Color string

颜色
IsTray
 FileCabinets.IsTray boolean

IsTray

获取文件柜字段

操作 ID:
GetFileCabinetFields

获取文件柜的字段列表。

参数

名称 密钥 必需 类型 说明
档案柜
 FileCabinet True string

选择要获取其字段的文件柜。
字段类型
 FieldType string

选择要返回的字段类型。

返回

名称 路径 类型 说明
Fields
 Fields array of object

Fields
TableFieldColumns
 Fields.TableFieldColumns array of object

TableFieldColumns
DBFieldName
 Fields.TableFieldColumns.DBFieldName string

DBFieldName
DWFieldType
 Fields.TableFieldColumns.DWFieldType string

DWFieldType
显示名称
 Fields.TableFieldColumns.DisplayName string

显示名称
DropLeadingBlanks
 Fields.TableFieldColumns.DropLeadingBlanks boolean

DropLeadingBlanks
DropLeadingZero
 Fields.TableFieldColumns.DropLeadingZero boolean

DropLeadingZero
FieldInfoText
 Fields.TableFieldColumns.FieldInfoText string

FieldInfoText
FixedEntry
 Fields.TableFieldColumns.FixedEntry string

FixedEntry
长度
 Fields.TableFieldColumns.Length integer

长度
NotEmpty
 Fields.TableFieldColumns.NotEmpty boolean

NotEmpty
精准率
 Fields.TableFieldColumns.Precision integer

精准率
Scope
 Fields.TableFieldColumns.Scope string

Scope
UsedAsDocumentName
 Fields.UsedAsDocumentName boolean

UsedAsDocumentName
DBFieldName
 Fields.DBFieldName string

DBFieldName
DWFieldType
 Fields.DWFieldType string

DWFieldType
显示名称
 Fields.DisplayName string

显示名称
DropLeadingBlanks
 Fields.DropLeadingBlanks boolean

DropLeadingBlanks
DropLeadingZero
 Fields.DropLeadingZero boolean

DropLeadingZero
FieldInfoText
 Fields.FieldInfoText string

FieldInfoText
FixedEntry
 Fields.FixedEntry string

FixedEntry
长度
 Fields.Length integer

长度
NotEmpty
 Fields.NotEmpty boolean

NotEmpty
精准率
 Fields.Precision integer

精准率
Scope
 Fields.Scope string

Scope

获取文档信息

操作 ID:
GetDocumentInformation

获取有关文档的信息。

参数

名称 密钥 必需 类型 说明
文件柜/文档托盘
 FileCabinetID True string

选择包含文档的文件柜或文档托盘。
文档 ID
 DocumentID True integer

指定要了解的文档的 ID。

返回

名称 路径 类型 说明
章节
 Sections array of object

章节
SignatureStatus
 Sections.SignatureStatus array of string

SignatureStatus
SectionId
 Sections.SectionId string

SectionId
内容类型
 Sections.ContentType string

内容类型
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
文件大小
 Sections.FileSize integer

文件大小
OriginalFileName
 Sections.OriginalFileName string

OriginalFileName
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 Sections.AnnotationsPreview boolean

AnnotationsPreview
DocumentId
 DocumentId integer

DocumentId
IndexFields
 IndexFields object

IndexFields
DocumentTitle
 DocumentTitle string

DocumentTitle
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
文件大小
 FileSize integer

文件大小
内容类型
 ContentType string

内容类型
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isDeleted
 DocumentFlags.isDeleted boolean

isDeleted
isEmail
 DocumentFlags.isEmail boolean

isEmail

获取标记字段

操作 ID:
GetStampFields

获取标记的字段列表。

参数

名称 密钥 必需 类型 说明
文件柜/文档托盘
 FileCabinet True string

选择具有所需戳记的文件柜或文档托盘。
邮票
 Stamp True string

选择标记以获取其字段。

返回

名称 路径 类型 说明
Fields
 Fields array of object

Fields
Id
 Fields.Id string

Id
标签
 Fields.Label string

标签
显示名称
 Fields.DisplayName string

显示名称

获取组织

操作 ID:
GetOrganization

获取组织名称。

返回

名称 路径 类型 说明
Name
 Name string

Name

获取邮票

操作 ID:
GetStamps

获取文件柜或文档托盘的图章列表。

参数

名称 密钥 必需 类型 说明
文件柜/文档托盘
 FileCabinet True string

选择要从中获取邮票的文件柜或文档托盘。

返回

名称 路径 类型 说明
邮票
 Stamps array of object

邮票
Id
 Stamps.Id string

Id
Name
 Stamps.Name string

Name
显示名称
 Stamps.DisplayName string

显示名称
颜色
 Stamps.Color string

颜色
Signature
 Stamps.Signature string

Signature
PasswordProtected
 Stamps.PasswordProtected boolean

PasswordProtected
改写
 Stamps.Overwrite boolean

改写
类型
 Stamps.Type string

类型
FileCabinetId
 Stamps.FileCabinetId string

FileCabinetId

追加文件

操作 ID:
AppendFile

将文件/节追加到现有文档。

参数

名称 密钥 必需 类型 说明
文件柜/文档托盘
 FileCabinet True string

选择包含文档的文件柜或文档托盘。
文档 ID
 DocID True string

指定要追加到的文档的 ID。
文件内容
 file file

指定要存储的文件的内容。

返回

名称 路径 类型 说明
SignatureStatus
 SignatureStatus array of string

SignatureStatus
SectionId
 SectionId string

SectionId
内容类型
 ContentType string

内容类型
HaveMorePages
 HaveMorePages boolean

HaveMorePages
PageCount
 PageCount integer

PageCount
文件大小
 FileSize integer

文件大小
OriginalFileName
 OriginalFileName string

OriginalFileName
ContentModified
 ContentModified string

ContentModified
HasTextAnnotation
 HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 AnnotationsPreview boolean

AnnotationsPreview

定义

二进制

这是基本数据类型“binary”。