Draft

[GET] /api/v2/common/drafts/{draftId}

通过文件 ID 获取特定草案文件的详细信息。

参数:

名称	类型	位置	描述
draftId必填项	string	path	要检索的草稿文档的唯一标识符。例如：e3808c7e-c0e7-44da-96a2-200b3bb216c6
extendQuery	ExtendQuery	query	查询响应的详细级别。例如：参考文献、修订版本
includeIndirectReference	Boolean	query	指示是否在回复中包含间接引用。例如：true

返回值

状态码: 200

成功

DraftVO

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[DELETE] /api/v2/common/drafts/{draftId}

删除文档草稿

参数:

名称	类型	位置	描述
draftId必填项	string	path	草稿编号

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/common/drafts

根据指定类型检索草稿文档列表。

参数:

名称	类型	位置	描述
types	string	query	以逗号分隔的文档类型列表，用于筛选草稿。如果为空，则默认使用预定义的类型。例如：“article,report”

返回值

状态码: 200

成功

GetDraftsInfoResponseModel

状态码: 400

错误的请求

ServerPluginError

[GET] /api/v2/common/drafts/publish-requests/{publishRequestId}

通过 ID 获取有关特定发布请求的详细信息。

参数:

名称	类型	位置	描述
publishRequestId必填项	string	path	要检索的发布请求的唯一标识符。例如：e3808c7e-c0e7-44da-96a2-200b3bb216c6

返回值

状态码: 200

成功

PublishRequestVO

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

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

根据指定的文档类型和发布请求类型检索发布请求列表。

参数:

名称	类型	位置	描述
types	string	query	以逗号分隔的文档类型列表，用于筛选发布请求。如果为空，则默认使用预定义类型。例如：“dbd,rdl”
prType	string	query	要筛选的发布请求类型。例如：“紧急”

返回值

状态码: 200

成功

GetPublishRequestsInfoResponseModel

状态码: 400

错误的请求

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

类型定义

Ƭ ExtendQuery

Enum:

None
EffectiveOps
Security
References
Revisions
Tags
Draft
All

定义用于扩展文档查询的选项。

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

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

Ƭ DraftVO

表示草稿文档的视图模型，封装了与草稿相关的所有相关信息和元数据。

名称	类型	描述
id可为空	string	草稿的唯一标识符。
type可为空	string	草稿类型。
title可为空	string	草案标题。
displayName可为空	string	草稿的显示名称。
description可为空	string	草案简述。
ext可为空	string	草稿文档的文件扩展名。
createdBy	SampleUserResponseModel
created可为空	ISO DateTime Sting	草稿的创建日期和时间。
isDraft	Boolean	指示该文档是否为草稿。
isApproval	Boolean	表明该草案是否需要批准。
contentType可为空	string	草稿的内容类型。
contentUrl可为空	string	访问草案内容的网址。
revisionNo	int32	草案的修订号。
revisionContentUrl可为空	string	访问该草案特定修订版本内容的网址。
isSystemReserved	Boolean	表示该选秀权是否已被系统保留。
hideOnMobile	Boolean	指示是否应在移动设备上隐藏草稿。
meta可为空	string	草稿相关的元数据。
hideInDocumentPortal	Boolean	指示是否应在文档门户中隐藏草稿。
isResource	Boolean	指示该文档是否被视为资源。
organizationId可为空	string	与该草案相关的组织标识符。
organizationIdPath可为空	string	与草案关联的组织标识符路径。
thumbnail可为空	string	草稿缩略图的网址。
modified可为空	ISO DateTime Sting	草稿最后修改的日期和时间。
modifiedBy	SampleUserResponseModel
customPermissions可为空	`Array<string>`	与草稿关联的自定义权限列表。
effectiveOps可为空	string	对草稿可以进行的有效操作。
security	SecurityResponseModel
references可为空	ReferenceResponseModel	该草案的相关参考文献列表。
revisions可为空	RevisionResponseModel	草案修订清单。

Ƭ SampleUserResponseModel

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

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

Ƭ SecurityResponseModel

文档的安全设置。

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

Ƭ ReferenceResponseModel

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

名称	类型	描述
documentId可为空	string	被引用文档的唯一标识符。
resourceName可为空	string	文档所关联的资源名称。
resourceDocType可为空	string	资源文档的类型。
resourceDocExt可为空	string	文档的文件扩展名。
resourceDocName可为空	string	资源文档的名称。
directReferencesIds可为空	`Array<string>`	父文档 ID。
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	访问此版本内容的网址。
references可为空	ReferenceResponseModel	与本次修订相关的参考资料列表，例如相关文档或资源。

Ƭ AclEntryQueryModel

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

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

Ƭ RoleResponseModel

代表系统中的一个角色。

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

Ƭ ServerPluginError

服务器插件错误

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

Ƭ GetDraftsInfoResponseModel

表示 GetDraftsInfo 操作的响应模型，其中包含草稿文档的集合。

名称	类型	描述	示例
drafts可为空	DraftVO	表示草稿文档的 Grapecity.Enterprise.Server.V2.Models.DraftVO 对象的可枚举集合。

Ƭ PublishRequestVO

表示发布文档的请求，包括文档的详细信息、审批状态和相关元数据。

名称	类型	描述
id可为空	string	发布请求的唯一标识符。
title可为空	string	与发布请求关联的文档标题。
displayName可为空	string	与发布请求关联的文档的显示名称。
draftId可为空	string	与发布请求关联的文档草稿标识符。
status	int32	发布请求的状态，以整数表示。
docType可为空	string	与发布请求关联的文档类型。
commit可为空	string	与待发布文档版本关联的提交标识符。
modifiedBy	SampleUserResponseModel
approvedBy	SampleUserResponseModel
createdBy	SampleUserResponseModel
modified可为空	ISO DateTime Sting	发布请求最后修改的日期和时间。
approved可为空	ISO DateTime Sting	发布请求获得批准的日期和时间。
created可为空	ISO DateTime Sting	发布请求的创建日期和时间。
effectiveOps可为空	string	与发布请求相关的有效操作。
draft	DraftVO
documentId可为空	string	与发布请求关联的文档标识符。

Ƭ GetPublishRequestsInfoResponseModel

表示 GetPublishRequestsInfo 操作的响应模型，其中包含发布请求信息的集合。

名称	类型	描述	示例
publishRequestsInfo可为空	PublishRequestVO	Grapecity.Enterprise.Server.V2.Models.PublishRequestVO 对象的可枚举集合，表示每个发布请求的详细信息。

Ƭ CreatePublishRequestResponseModel

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

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

Ƭ CreatePublishRequestModel

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

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

Ƭ DoApproveResponseModel

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

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

Ƭ PublishRequestModel

表示发布文档请求的模型。该模型包含发布请求标识符和一个可选的提交消息。

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

Ƭ DoRejectResponseModel

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

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