[]
产品官网 帮助文档 API 文档 视频教程 技术社区
v7.0 Update1
在线Demo 免费试用
(Showing Draft Content)

Documents

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}/delete

删除文档。

参数:

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

请求数据格式

DocumentDeleteRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[DELETE] /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/update

更新文档属性

参数:

名称 类型 位置 描述
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

成功

BatchHideDocumentInDocumentPortalReponseModel

状态码: 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/{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/admin/export

导出文档及其引用。

请求数据格式

ExportRequestModel

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/admin/import

导入文件。

返回值

状态码: 200

成功

ImportResult

状态码: 400

错误的请求

ServerPluginError

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

更新文档权限

参数:

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

请求数据格式

PermissionRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/documents/permission/batch-update

批量更改文档权限

请求数据格式

BatchChangePermissionRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

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

授予当前文档引用文档所需的最低权限

参数:

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

请求数据格式

MinNeededPermissionRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

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

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

请求数据格式

BatchApplyMinNeededPermissionRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 204

无内容

状态码: 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 是否永久删除文档 true

Ƭ 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 是否隐藏文档门户中的文档

Ƭ BatchHideDocumentInDocumentPortalReponseModel

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

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

Ƭ UpdateFailedInfo

更新隐藏文档失败信息

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

Ƭ 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：报表文档。

Ƭ DocumentTranslateTitleRequest

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

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

Ƭ DocumentTranslateTitleItem

文档翻译标题

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

Ƭ DocumentTranslateTitle

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

Ƭ ExportRequestModel

代表导出模型。

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

Ƭ 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"]

Ƭ 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 - 计划程序任务。