Documents

[PUT] /api/v2/common/documents/{id}/thumbnails/upload

上传文档缩略图。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：1e5d7247-450e-4383-b0dd-09d5cf651907

返回值

状态码: 200

成功

ThumbnailUploadResponseModel

状态码: 400

错误的请求

ServerPluginError

[DELETE] /api/v2/common/documents/{id}/thumbnails

删除指定的文档缩略图。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：1e5d7247-450e-4383-b0dd-09d5cf651907

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/{id}/referenced-documents/update

更新依赖于指定文档的文档以引用指定文档的最新版本。

参数:

名称	类型	位置	描述
id必填项	string	path	指定文档 ID。例如：1e5d7247-450e-4383-b0dd-09d5cf651907

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[DELETE] /api/v2/common/documents/{id}

根据文档 ID 删除文档。根据配置和请求参数，此操作可以是软删除，也可以是硬删除。

参数:

名称	类型	位置	描述
id必填项	string	path	要删除的文档的唯一标识符。例如：“1E5D7247-450E-4383-B0DD-09D5CF651907”。

请求数据格式

DocumentDeleteRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/common/documents/{id}

使用文档的唯一标识符检索有关文档的详细信息。

参数:

名称	类型	位置	描述
id必填项	string	path	文档 ID。示例：e3808c7e-c0e7-44da-96a2-200b3bb216c6
extendQuery	ExtendQuery	query	查询响应的详细程度。例如：参考、修订
includeIndirectReference	Boolean	query	为真时包括间接引用。与 extendQuery 中的引用相关。
deleted	Boolean	query	True 表示仅查询已删除的文档，false 表示未删除。

返回值

状态码: 200

成功

DocumentVO

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/batch-delete

根据提供的请求模型执行文档批量删除。此操作可配置为执行软删除或硬删除。

请求数据格式

BatchDeleteDocumentsRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/{id}/restore

恢复文档。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：1e5d7247-450e-4383-b0dd-09d5cf651907

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/common/documents/batch-restore

批量恢复文档。

请求数据格式

BatchRestoreDocumentsRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

[PUT] /api/v2/common/documents/{id}/properties

更新文档属性

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：1e5d7247-450e-4383-b0dd-09d5cf651907

请求数据格式

DocumentPropertyRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/batch-hide-in-document-portal

在文档门户中批量隐藏文档。

请求数据格式

BatchHideDocumentInDocumentPortalRequestModel

返回值

状态码: 200

成功

BatchHideDocumentInDocumentPortalResponseModel

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/common/documents/{id}/duplicate

复制文档。使用范围：数据模型、数据集、报表、仪表板、语言资源。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：1e5d7247-450e-4383-b0dd-09d5cf651907

请求数据格式

CopyDocumentRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/{documentId}/tags/{tagId}

向文档添加指定的标签。

参数:

名称	类型	位置	描述
documentId必填项	string	path	将添加标签的文档的唯一标识符。
tagId必填项	string	path	要添加到文档的标签的唯一标识符。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[DELETE] /api/v2/common/documents/{documentId}/tags/{tagId}

从文档中删除指定的标签。

参数:

名称	类型	位置	描述
documentId必填项	string	path	将从中删除标签的文档的唯一标识符。
tagId必填项	string	path	要从文档中删除的标签的唯一标识符。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/tags/modify

根据指定的操作更改一批文档的类别（标签）。

This method supports adding, removing, or replacing tags for a batch of documents. The operation type in the request model determines the action to be performed.

请求数据格式

ChangeCategoriesRequestModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[PUT] /api/v2/common/documents/homepage

将指定文档设置为当前用户的主页文档。此操作将更新用户的个人资料以引用指定文档作为其主页文档。

This method checks if the specified document exists and if the current user's information is available. If the document exists
and the user is valid, it updates the user's profile to set the specified document as their home document. This method handles
various exceptions, including cases where the home document is already set, the document is not found, or any database access issues occur.

请求数据格式

SetHomeDocumentRequestModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/search

根据指定条件查询分页的文档列表，支持过滤、排序和分页控制。

请求数据格式

QueryDocumentsWithPaginationRequestModel

返回值

状态码: 200

成功

DocumentPaginationResponseModel

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/common/documents/favorites

带分页查询文档

请求数据格式

DocumentTagPaginationRequestModel

返回值

状态码: 200

成功

DocumentPaginationResponseModel

状态码: 400

错误的请求

ServerPluginError

[GET] /api/v2/common/documents/document-types

查询并检索系统内所有可用文档类型的列表。

参数:

名称	类型	位置	描述
key	string	query

返回值

状态码: 200

成功

QueryDocumentTypesResponseModel

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/common/documents/{id}/document-translate-titles

更新文档翻译标题

参数:

名称	类型	位置
id必填项	string	path

请求数据格式

DocumentTranslateTitleRequest

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/common/documents/{id}/document-translate-titles

获取文档所有翻译标题

参数:

名称	类型	位置
id必填项	string	path

返回值

状态码: 200

成功

DocumentTranslateTitle

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/common/documents/{id}/document-translate-titles/{languageCode}

通过语言代码获取文档翻译标题

参数:

名称	类型	位置	描述
id必填项	string	path
languageCode必填项	string	path	语言代码。例如：en

返回值

状态码: 200

成功

DocumentTranslateTitle

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/encrypt-url

加密给定的URL路径，并返回加密后的URL路径。

请求数据格式

EncryptPathRequestModel

返回值

状态码: 200

成功

EncryptPathResponseModel

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/admin/export

导出文档及其引用。

请求数据格式

ExportRequestModel

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/admin/import

导入文件。

返回值

状态码: 200

成功

ImportResult

状态码: 400

错误的请求

ServerPluginError

[PUT] /api/v2/common/documents/{id}/permission

更新文档权限

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号

请求数据格式

PermissionRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/permissions/batch-update

批量更改文档权限

请求数据格式

BatchChangePermissionRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/{id}/permission/apply-min-needed-permission

根据文档的当前权限，对其子文档应用必要的最低权限。

参数:

名称	类型	位置	描述
id必填项	string	path	文档的唯一标识符。

请求数据格式

MinNeededPermissionRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/permission/batch-apply-min-needed-permission

批量授予当前文档引用文档所需的最少权限

请求数据格式

BatchApplyMinNeededPermissionRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/drafts/publish-requests

为指定的草稿文档创建发布请求。此方法负责通过创建发布请求来启动将文档从草稿状态移至已发布状态的过程。

请求数据格式

CreatePublishRequestModel

返回值

状态码: 200

成功

CreatePublishRequestResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/drafts/publish-requests/approve

批准发布请求。此方法负责批准发布请求，从而将文档从其当前状态移至已发布状态，使其可供公众或指定查看者使用。这是文档生命周期管理中的关键步骤，可确保仅发布经过审阅和批准的文档。

请求数据格式

PublishRequestModel

返回值

状态码: 200

成功

DoApproveResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/drafts/publish-requests/reject

拒绝发布请求。此方法负责拒绝发布请求，这将阻止文档从其当前状态转变为已发布状态。这是文档生命周期管理中的重要步骤，确保不发布不符合所需标准或准则的文档。

请求数据格式

PublishRequestModel

返回值

状态码: 200

成功

DoRejectResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/common/resources/download

批量下载资源。

参数:

名称	类型	位置	描述
ids	string	query	文档 ID。例如：[“f00fc3e6-8554-467d-9a7e-4598e623bb2f”，“8259e551-5afb-489e-8593-0fd6384e123b”]

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

ServerPluginError

[GET] /api/v2/common/resources/{id}/download

获取资源。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：1e5d7247-450e-4383-b0dd-09d5cf651907
rev	int32	query	文件修订。例如：null 或 1

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/upload

上传文件。

返回值

状态码: 200

成功

QueueStatsResponseModel

状态码: 400

错误的请求

ServerPluginError

类型定义

Ƭ ThumbnailUploadResponseModel

表示上传文档缩略图响应模型。

名称	类型	描述	示例
thumbnailUrl可为空	string	文档缩略图 URL。

Ƭ ServerPluginError

服务器插件错误

名称	类型	描述
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	ServerPluginError

Ƭ DocumentResponseModel

表示文档的响应模型，包括其元数据和状态。

名称	类型	描述
documentId可为空	string	获取或设置文档的唯一标识符。
title可为空	string	获取或设置文档的标题。
fileExt可为空	string	获取或设置文档的文件扩展名。
contentType可为空	string	获取或设置文档的内容类型。
creatorName可为空	string	获取或设置文档创建者的姓名。
modifierName可为空	string	获取或设置最后修改文档的人员的姓名。
deleterName可为空	string	获取或设置删除文档的人员的姓名（如果适用）。
description可为空	string	获取或设置文档的描述。
isSystemReserved可为空	Boolean	获取或设置一个值，指示该文档是否被系统保留。
isResource	Boolean	获取或设置一个值，指示该文档是否被视为资源。
hideOnMobile可为空	Boolean	获取或设置一个值，指示文档是否应在移动设备上隐藏。
meta可为空	string	获取或设置与文档相关的元数据。
hideInDocumentPortal可为空	Boolean	获取或设置一个值，指示文档是否应在文档门户中隐藏。
organizationId可为空	string	获取或设置与文档关联的组织 ID。
organizationIdPath可为空	string	获取或设置与文档关联的组织 ID 的路径。
thumbnail可为空	string	获取或设置文档的缩略图。
schemaVersion可为空	string	获取或设置文档的架构版本。

Ƭ DocumentDeleteRequestModel

表示删除文档的请求模型，包括强制删除和永久删除的选项。

名称	类型	描述	示例
force	Boolean	获取或设置一个值，指示是否应强制删除文档。强制删除会绕过任何软删除机制。	`true`
permanent	Boolean	获取或设置一个值，指示是否应永久删除文档。永久删除会将文档从数据库中彻底删除。

Ƭ ExtendQuery

Enum:

None
EffectiveOps
Security
References
Revisions
Tags
All

定义使用附加信息扩展文档查询的选项。

此枚举允许指定应在文档查询响应中包含哪些附加数据。
它支持按位运算来组合多个选项。

* None - 0 - 不包含任何附加数据。
* EffectiveOps - 1 - 包含适用于文档的有效操作。
* Security - 2 - 包含安全信息，如访问控制列表。
* References - 4 - 包含对其他文档的引用。
* Revisions - 8 - 包含有关文档修订的信息。
* Tags - 16 - 包含与文档关联的标签。
* All - 31 - 包含所有可用的扩展信息。

Ƭ DocumentVO

表示文档的视图对象，封装各种元数据和状态信息。

名称	类型	描述
created可为空	ISO DateTime Sting	文档的创建时间戳。
deleted可为空	ISO DateTime Sting	如果已删除，则显示文档的删除时间戳。
modified可为空	ISO DateTime Sting	文档的最后修改时间戳。
createdBy	SampleUserResponseModel
modifiedBy	SampleUserResponseModel
deletedBy	SampleUserResponseModel
description可为空	string	该文件的简要描述。
displayName可为空	string	文档的显示名称。
ext可为空	string	文档的文件扩展名。
hideInDocumentPortal	Boolean	指示文档是否在文档门户中隐藏。
hideOnMobile	Boolean	指示文档在移动设备上是否隐藏。
id可为空	string	文档的唯一标识符。
isResource	Boolean	指示该文档是否是资源。
meta可为空	string	与文档相关的元数据。
organizationId可为空	string	与文档关联的组织 ID。
organizationIdPath可为空	string	与文档关联的组织 ID 的路径。
thumbnail可为空	string	文档缩略图的 URL。
title可为空	string	文档的标题。
type可为空	string	文档的类型。
customPermissions可为空	`Array<string>`	与文档相关的自定义权限。
contentUrl可为空	string	访问文档内容的 URL。
revisionNo	int32	文档的修订号。
revisionContentUrl可为空	string	访问特定文档修订内容的 URL。
isSystemReserved	Boolean	表示该文件是否被系统保留。
effectiveOps可为空	string	允许对该文档进行有效的操作。
security	SecurityResponseModel
references可为空	ReferenceResponseModel	与文档相关的参考文献。
revisions可为空	RevisionResponseModel	文档的修订历史。
tags可为空	TagResponseInfoModel	与文档相关的标签。

Ƭ SampleUserResponseModel

表示用户的简化模型，提供各种响应模型中使用的基本信息。

名称	类型	描述	示例
id可为空	string	用户的唯一标识符。
name可为空	string	用户的名称。

Ƭ SecurityResponseModel

文档的安全设置。

名称	类型	描述	示例
ownerId可为空	string	所有者的唯一标识符。
permissions可为空	AclEntryQueryModel	文档访问权限。

Ƭ ReferenceResponseModel

表示文档引用的模型，包括有关文档及其权限的详细信息。

名称	类型	描述
documentId可为空	string	引用文档的唯一标识符。
resourceName可为空	string	与该文档关联的资源的名称。
resourceDocType可为空	string	资源文档的类型。
resourceDocName可为空	string	资源文档的名称。
displayName可为空	string	供参考的显示名称。
meta可为空	string	与文档相关的元数据。
documentRev可为空	string	文件的修订。
isDirectChild	Boolean	指示该文档是否是父文档的直接子文档。
permission可为空	string	文档的权限级别。
contentUrl可为空	string	访问文档内容的 URL。
minimalPermission可为空	string	访问文档所需的最低权限。

Ƭ RevisionResponseModel

表示文档修订的模型，包括修订号、注释、元数据和相关用户信息等详细信息。

名称	类型	描述
no	int32	修订号。这通常是一个整数，随着每个新修订而递增。
comment可为空	string	描述本次修订所做更改的评论。
meta可为空	string	与修订相关的元数据，可能包括标签或关键字等详细信息。
createdBy	SampleUserResponseModel
created可为空	ISO DateTime Sting	此修订的创建日期和时间。
modifiedBy	SampleUserResponseModel
modified可为空	ISO DateTime Sting	上次修改此修订的日期和时间。
contentUrl可为空	string	访问此修订内容的 URL。
references可为空	ReferenceResponseModel	与此次修订相关的参考列表，例如相关文档或资源。

Ƭ TagResponseInfoModel

表示标签的响应模型，包括其元数据和状态。

名称	类型	描述
id可为空	string	标签的唯一标识符。
parentId可为空	string	父标签的唯一标识符（如果有）。
realName可为空	string	标签的显示名称。
order	int32	标签在其兄弟标签中的显示顺序。
url可为空	string	与标签关联的 URL，通常用于导航。
iconCssClass可为空	string	标签图标的 CSS 类，用于视觉呈现。
color可为空	string	与标签相关的颜色，用于视觉呈现。
isFavorites	Boolean	指示标签是否被标记为收藏。
isPersonal	Boolean	指示标签是否属于用户个人。
orgId可为空	string	与标签关联的组织的唯一标识符。
documentCount	int32	与标签关联的文档的数量。
name可为空	string	用于识别和搜索的标签名称。

Ƭ AclEntryQueryModel

为子角色定义 ACL 条目权限。

名称	类型	描述
sub	RoleResponseModel
ops可为空	`Array<string>`	授權操作。
opflags	int32	用于额外控制的操作标志。

Ƭ RoleResponseModel

代表系统内的角色。

名称	类型	描述
id可为空	string	角色的唯一标识符。
name可为空	string	角色的名称。
type可为空	string	角色的类型。

Ƭ BatchDeleteDocumentsRequestModel

批量删除的文档信息

名称	类型	描述	示例
documentIds	`Array<string>`	批量操作文档id	`["F00FC3E6-8554-467D-9A7E-4598E623BB2F","F00FC3E6-8554-467D-9A7E-4598E623BB2D"]`
force	Boolean	是否强制删除文档
permanent	Boolean	是否永久删除文档

Ƭ BatchRestoreDocumentsRequestModel

批量恢复文档信息

名称	类型	描述	示例
documentIds	`Array<string>`	批量操作文档id	`["F00FC3E6-8554-467D-9A7E-4598E623BB2F","F00FC3E6-8554-467D-9A7E-4598E623BB2D"]`

Ƭ DocumentPropertyRequestModel

文件属性

名称	类型	描述	示例
newName可为空	string	新文档名称	`"newDocument"`
meta可为空	string	文档元	`"DSC_PROVIDER=CSV"`
description可为空	string	文件说明	`"Document Description"`
fontOriginalName可为空	string	字体文档原名	`"Oswald"`
hideOnMobile可为空	Boolean	移动端是否隐藏文档
hideInDocumentPortal可为空	Boolean	是否隐藏文档门户中的文档

Ƭ BatchHideDocumentInDocumentPortalResponseModel

批量隐藏文档门户中的文档

名称	类型	描述	示例
updated_Document_Ids可为空	`Array<string>`	更新了文档 ID。
updated_Failed_Documents可为空	UpdateFailedInfo	更新失败的文档。

Ƭ UpdateFailedInfo

更新隐藏文档失败信息

名称	类型	描述	示例
documentIds可为空	`Array<string>`	文档 ID 列表
error	ErrorContent

Ƭ ErrorContent

名称	类型	描述	示例
code	ServiceErrorCodeEnum
message可为空	string
context可为空	any

Ƭ ServiceErrorCodeEnum

Enum:

UserInfoNotFoundErrorCode
UserInfoUpdateFailedErrorCode
RequiredParameterMissingErrorCode
DocumentNameExistsErrorCode
DocumentAccessDeniedErrorCode
NoEntityPermissionErrorCode
NoSufficientPermissionsErrorCode
ExceedLicenseCountErrorCode
DocumentNotFoundErrorCode
UnknownDocumentTypeErrorCode
DocumentUsedByOtherDocumentsErrorCode
NoEntityPermissionToRenameErrorCode
RemoveDefaultThemeErrorCode
NoPermissionErrorCode
RemoveBuiltInDocumentErrorCode
UpdateDocumentDescriptionErrorCode
InvalidDocumentNameErrorCode
InvalidDocumentTypeErrorCode
InvalidTagNameErrorCode
TagNotFoundErrorCode
TagNameExistsErrorCode
TagUrlNameExistsErrorCode
TagOrderExistsErrorCode
TagIdSameErrorCode
TagOrderNullErrorCode
RemoveDefaultLanguageResourceErrorCode
UnknownDeleteErrorCode
DuplicateDocumentErrorCode
AddOrRemoveTagDocNotFoundErrorCode
AddTagTagNotFoundErrorCode
SystemReservedTagErrorCode
TagOrganizationIdInvalidErrorCode
ToTagIdIsChildrenOfFromTagErrorCode
DraftIsApprovalErrorCode
DraftIsDisabledErrorCode
TagLikeFavoriteDeleteErrorCode
RemoveUserSyncDatasetErrorCode

Ƭ BatchHideDocumentInDocumentPortalRequestModel

文档信息批量隐藏在文档门户中

名称	类型	描述	示例
documentIds	`Array<string>`	批量操作文档id	`["F00FC3E6-8554-467D-9A7E-4598E623BB2F","F00FC3E6-8554-467D-9A7E-4598E623BB2D"]`
hideInDocumentPortal	Boolean	文档门户中是否隐藏文档

Ƭ CopyDocumentRequestModel

复印文件基本信息

名称	类型	描述	示例
newDocName	string	新文档名称	`"newDocumentName"`
currentTagId可为空	string	当前标签ID	`"D01EF9CA-48A2-4ABA-B54E-AD9DA89955F3"`
copyAsTemplate	Boolean	是否复制文档作为模板，使用range：报表文档。

Ƭ ChangeCategoriesRequestModel

表示更改与一批文档关联的类别（标签）的请求模型。此模型支持根据指定的操作类型添加、移除或替换标签。

名称	类型	描述	示例
documentIds可为空	`Array<string>`	获取要修改的文档的唯一标识符列表。	`["F00FC3E6-8554-467D-9A7E-4598E623BB2F","F00FC3E6-8554-467D-9A7E-4598E623BB2D"]`
tagIds可为空	`Array<string>`	获取要添加、删除或替换的标签的唯一标识符列表。	`["D01EF9CA-48A2-4ABA-B54E-AD9DA89955F3","D02EF9CA-48A2-4ABA-B54E-AD9DA89955F4"]`
operationType可为空	string	获取对指定文档的标签执行的操作类型。

Ƭ SetHomeDocumentRequestModel

表示将指定文档设置为当前用户的主文档的请求模型。

名称	类型	描述	示例
documentId可为空	string	获取或设置要设置为主文档的文档的唯一标识符。

Ƭ DocumentPaginationResponseModel

表示分页文档查询的响应模型。

名称	类型	描述	示例
pagination	PaginationModel
data可为空	DocumentVO	表示当前文档页面的文档视图对象 (VO) 的只读列表。每个 DocumentVO 都包含文档元数据以及显示或处理所需的任何其他信息。

Ƭ PaginationModel

表示返回项目列表的查询的分页信息。此模型用于通过指定每页的大小和当前页码来管理大型数据集的分页。

名称	类型	描述
pageSize	int32	获取或设置单页上显示的项目数。
pageNumber	int32	获取或设置当前页码。
total	int64	获取或设置所有页面上的项目总数。

Ƭ QueryDocumentsWithPaginationRequestModel

表示用于分页查询文档的请求模型。

名称	类型	描述	示例
documentId可为空	string	获取或设置文档 ID。	`"e3808c7e-c0e7-44da-96a2-200b3bb216c6"`
search可为空	string	获取或设置搜索关键字。	`"example search keyword"`
types可为空	string	获取或设置要过滤的文档类型。	`"example document type"`
orderBy可为空	string	获取或设置用于对文档进行排序的字段。	`"example field name"`
pageSize	int32	获取或设置每页显示的文档数。	`10`
pageNumber	int32	获取或设置要显示的页码。	`1`
deleted	Boolean	获取或设置一个值，指示是否应将已删除的文档包含在结果中。	`true`
searchForAllTags	Boolean	获取或设置是否搜索所有标签的值。
disableHideInDocumentPortalFilter	Boolean	获取或设置一个值，指示是否禁用文档门户过滤器中的隐藏。	`true`
enableDataModelFilter	Boolean	获取或设置一个值，指示是否启用数据模型过滤器。	`true`
isSystemReserved可为空	Boolean	获取或设置一个值，指示文档是否是系统保留的。	`true`
createdTimeRange可为空	`Array<string>`	获取或设置文档的创建时间范围。
modifiedTimeRange可为空	`Array<string>`	获取或设置文档的修改时间范围。
creator可为空	string	获取或设置文档的创建者。	`"John Doe"`
modifier可为空	string	获取或设置文档的修饰符。	`"Jane Smith"`
fromAdminPortal	Boolean	获取或设置一个值，指示请求是否来自管理门户。	`true`
extendQuery	ExtendQuery
includeIndirectReference	Boolean	获取或设置一个值，指示是否包含间接引用文档。	`true`

Ƭ DocumentTagPaginationRequestModel

文档分页请求模型

名称	类型	描述	示例
documentId可为空	string	获取或设置文档 ID。	`"e3808c7e-c0e7-44da-96a2-200b3bb216c6"`
pageSize	int32	获取或设置每页显示的文档数。	`10`
pageNumber	int32	获取或设置要显示的页码。	`1`
orderBy可为空	string	获取或设置用于对文档进行排序的字段。	`"creationDate"`
disableHideInDocumentPortalFilter	Boolean	获取或设置一个值，指示是否禁用文档门户过滤器中的隐藏。
filterByType可为空	string	获取或设置要筛选的文档类型。	`"report"`
isFromExportPage	Boolean	获取或设置一个值，指示查询是否来自导出页面。
search可为空	string	获取或设置文档标题的搜索关键字。	`"annual report"`
createdTimeRange可为空	`Array<string>`	获取或设置文档的创建时间范围。
modifiedTimeRange可为空	`Array<string>`	获取或设置文档的修改时间范围。
creator可为空	string	获取或设置文档的创建者。	`"John Doe"`
modifier可为空	string	获取或设置文档的修饰符。	`"Jane Smith"`
lng可为空	string	获取或设置语言代码。	`"en-US"`
extendQuery	ExtendQuery
includeIndirectReference	Boolean	获取或设置是否包含间接引用文档。仅当extendQuery所代表的含义包含Reference时，该配置才生效。	`true`

Ƭ QueryDocumentTypesResponseModel

表示 QueryDocumentTypes 操作的响应模型，包含文档类型的集合。

名称	类型	描述	示例
documentTypes可为空	DocumentTypeViewModel	文档类型标识符列表。

Ƭ DocumentTypeViewModel

表示文档类型的视图模型，封装了该文档类型的关键信息和特征。

名称	类型	描述
key可为空	string	文档类型的唯一标识符。
baseDocumentTypeKey可为空	string	如果适用，则为该文档类型继承的基本文档类型的键。
name可为空	string	文档类型的名称。
description可为空	string	文档类型的简要描述。
iconCssClass可为空	string	表示文档类型的图标的 CSS 类。此类可用于 UI 组件中，以显示与文档类型关联的图标。
knownFileTypes可为空	`Array<string>`	与文档类型相关的文件扩展名列表。
knownContentTypes可为空	`Array<string>`	与文档类型相关的 MIME 类型列表。
containsResource	Boolean	指示文档类型是否包含图像或其他嵌入内容等资源。
customPermissions可为空	`Array<string>`	访问或操作此类文档所需的自定义权限列表。

Ƭ DocumentTranslateTitleRequest

翻译标题的语言代码和标题模型

名称	类型	描述	示例
translateTitles	DocumentTranslateTitleItem	翻译标题的语言代码和标题列表

Ƭ DocumentTranslateTitleItem

文档翻译标题

名称	类型	描述	示例
languageCode	string	语言代码	`"EN-US"`
title可为空	string	文档翻译标题	`"Translate title"`
isDefault	Boolean	为默认标题，与原文档名称相同

Ƭ DocumentTranslateTitle

名称	类型	描述	示例
docId可为空	string
languageCode可为空	string
title可为空	string
isDefault	Boolean

Ƭ EncryptPathResponseModel

名称	类型	描述	示例
path可为空	string

Ƭ EncryptPathRequestModel

名称	类型	描述	示例
path可为空	string

Ƭ ExportRequestModel

代表导出模型。

名称	类型	描述	示例
items	ExportItemModel	需要导出的项目。
includeDocumentPermissions	Boolean	导出文档时是否包含文档的权限，默认为false。	`true`
excludeReferenceDocumentTypes可为空	`Array<string>`	不允许导出的引用文档的文档类型，具有比参数“IncludeReferenceDocumentTypes”更高的优先级。	`["dst","dbd"]`
includeReferenceDocumentTypes可为空	`Array<string>`	允许导出的引用文档的文档类型的优先级低于参数“ExcludeReferenceDocumentTypes”。	`["dst","dbd"]`
includeDocumentScheduleTasks	Boolean	导出文档时是否包含文档的计划任务，默认值为false。

Ƭ ExportItemModel

表示导出项模型。

名称	类型	描述	示例
type	string	需要导出的项目类型，有效类型为: "$$documents" ->文档, "sys-conf-ui" -> UI 设置， "sys-cat" -> 类别， "sys-clp" -> 自定义语言包、 "sys-ctheme" -> 自定义主题、 "sys-et" -> 导出模板， "sys-role" -> 角色， "sys-st " -> 计划模板， "sys-secprovider" -> 安全提供程序， "sys-secset" -> 安全设置， "sys-uf" -> 用户函数， "sys-conf-wq " -> 工作队列设置， "auditLogConfiguration" -> 审核日志设置， "sys-conf-dashboard-common" -> 仪表板常用设置， “sys-conf-dashboard-designer” -> 仪表板设计器设置， “sys-conf-dashboard-view” -> 仪表板查看设置， "sys-conf-ddt" -> 默认文档主题， "sys-conf-es" -> 电子邮件设置， "sys-conf-rs" -> 报表设置， "sys-conf-ss" -> 日程设置，	`"sys-conf-ui"`
items	`Array<string>`	获取或设置需要导出的项目。	`["1FB74CF4-FFB0-492F-A2D5-29AA761955CF","DD695D78-015D-43E2-9F3A-8919F4F534FE"]`

Ƭ ImportResult

表示导入结果模型。

名称	类型	描述	示例
documents可为空	DocumentImportResult	获取或设置导入的文档。
settings可为空	UploadSetting	获取或设置导入的设置。

Ƭ DocumentImportResult

表示文档导入结果模型。

名称	类型	描述
success	Boolean	获取或设置文档导入结果。
operation	DocumentOperation
error	ImportError
document	UploadDocument

Ƭ UploadSetting

代表上传设置模型。

名称	类型	描述	示例
name可为空	string	获取或设置设置名称。
type可为空	string	获取或设置设置类型。

Ƭ DocumentOperation

Enum:

Add
Update
Ignore
Upgrade

导入文档操作类型的枚举。

* add - 0 - 添加文档。
* update - 1 - 更新文档。
* ignore - 3 -忽略文档。
* upgrade - 4 - 升级文档。

Ƭ ImportError

名称	类型	描述	示例
errorCode	int32
errorText可为空	string
context可为空	any

Ƭ UploadDocument

表示上传文档模型。

名称	类型	描述
id可为空	string	获取或设置文档 ID。
title可为空	string	获取或设置文档标题。
documentType可为空	string	获取或设置文档类型。
fileExt可为空	string	获取或设置文档文件扩展名。
contentType可为空	string	获取或设置文档内容类型。
createdBy可为空	string	获取或设置文档创建者。
modifiedBy可为空	string	获取或设置文档编辑器。
created可为空	ISO DateTime Sting	获取或设置文档创建时间。
modified可为空	ISO DateTime Sting	获取或设置文档修改时间。

Ƭ PermissionRequestModel

权限请求模型

名称	类型	描述	示例
grantCollection可为空	AccessEntryStringDto	授予权限的集合
revokeCollection可为空	AccessEntryStringDto	待撤销权限集合

Ƭ AccessEntryStringDto

访问条目字符串 dto

名称	类型	描述	示例
role可为空	string	角色名称	`"Tester"`
ops可为空	`Array<string>`	操作： /可执行：["execute"] /只读：["execute", "read"] /读写：["execute", "read", "update"]	`["Execute","Read","Update"]`

Ƭ BatchChangePermissionRequestModel

批量更改文档权限请求模型

名称	类型	描述	示例
documentIds可为空	`Array<string>`	更改权限的文档 ID。	`["1FB74CF4-FFB0-492F-A2D5-29AA761955CF","DD695D78-015D-43E2-9F3A-8919F4F534FE"]`
operationType可为空	string	操作类型(addnew/removeexisting/removeexistingandaddnew)	`"AddNew"`
grantCollection可为空	AccessEntryStringDto	要授予的权限的集合。

Ƭ MinNeededPermissionRequestModel

授予当前文档请求模型的引用文档所需的最少权限

名称	类型	描述	示例
role可为空	string	角色名称	`"Tester"`

Ƭ BatchApplyMinNeededPermissionRequestModel

批量授予当前文档请求模型的引用文档所需的最少权限

名称	类型	描述	示例
documentIds可为空	`Array<string>`	文档 ID	`["1FB74CF4-FFB0-492F-A2D5-29AA761955CF","DD695D78-015D-43E2-9F3A-8919F4F534FE"]`
roleNames可为空	`Array<string>`	角色名称	`["Tester","Viewer"]`

Ƭ CreatePublishRequestResponseModel

表示创建发布请求操作的响应模型。此模型包含新创建的发布请求的唯一标识符。

名称	类型	描述	示例
publishRequestId可为空	string	已创建的发布请求的唯一标识符。

Ƭ CreatePublishRequestModel

表示用于创建草稿文档发布请求的请求模型。此模型用于通过提供草稿文档的唯一标识符来启动发布文档的过程。

名称	类型	描述	示例
draftId可为空	string	获取或设置要发布的草稿文档的唯一标识符。

Ƭ DoApproveResponseModel

表示文档审批操作的响应模型。此模型包括审批流程的结果以及已审批文档的唯一标识符。

名称	类型	描述	示例
success	Boolean	指示批准操作是否成功。
documentId可为空	string	已批准文件的唯一标识符。

Ƭ PublishRequestModel

表示发布文档请求的模型。此模型包括发布请求标识符和可选的提交消息。

名称	类型	描述	示例
publishRequestId可为空	string	获取或设置发布请求的唯一标识符。
commit可为空	string	获取或设置与发布请求关联的提交消息。此消息可以提供所发布更改的上下文或描述。

Ƭ DoRejectResponseModel

表示文档拒绝操作的响应模型。此模型包括拒绝过程的结果，表明拒绝是否成功。

名称	类型	描述	示例
success	Boolean	指示拒绝操作是否成功。

Ƭ QueueStatsResponseModel

表示队列统计响应模型。

名称	类型	描述	示例
workers可为空	WorkerInfo	获取或设置工人信息列表。
tasks可为空	CommonTaskInfo	获取或设置任务信息列表。

Ƭ WorkerInfo

名称	类型	描述	示例
id可为空	string
url可为空	string
lastSeen	ISO DateTime Sting
tasksInProgress	int32
displayName可为空	string
specializations可为空	`Array<string>`

Ƭ CommonTaskInfo

代表一个常见的任务信息响应模型。

名称	类型	描述
taskID	TaskID
workerUrl可为空	string	获取或设置工作人员 url。
workerID可为空	string	获取或设置工人 ID。
initiator可为空	string	获取或设置任务发起者。
documentName可为空	string	获取或设置文档名称。
displayDocName可为空	string	获取或设置显示名称。
documentId可为空	string	获取或设置文档 ID。
documentType可为空	string	获取或设置文档类型。
startTime	ISO DateTime Sting	获取或设置任务开始时间。
endTime可为空	ISO DateTime Sting	获取或设置任务结束时间。
progress可为空	string	获取或设置任务进度。
errorMessage可为空	string	获取或设置任务错误消息。
description可为空	string	获取或设置任务描述。
breakStatus	CommonTaskInfo+TaskStatus
status	CommonTaskInfo+TaskStatus
type	CommonTaskInfo+TaskType

Ƭ TaskID

名称	类型	描述	示例
parent	TaskID
id可为空	string

Ƭ CommonTaskInfo+TaskStatus

Enum:

NotStarted
WaitingForActivation
WaitingToRun
Started
ReadingResult
Verifying
Canceled
Failed
Finished

任务状态枚举

* notstarted - 0 - 未启动。
* waitingforactivation - 1 - 等待激活。
* waitingtorun - 2 - 等待激活运行。
* started - 3 - 已开始。
* readingresult - 4 - 读取结果。
* verifying - 5 - 正在验证。
* canceled - 6 - 已取消。
* failed - 7 - 失败。
* finished - 8 - 已完成。

Ƭ CommonTaskInfo+TaskType

Enum:

Queue
Scheduler

任务类型枚举。

* queue - 0 - 队列任务。
* scheduler - 1 - 计划程序任务。