Common

[PUT] /api/v2/common/user-info/{id}/homepage

更新指定用户的主页文档 ID。

参数:

名称	类型	位置	描述
id必填项	string	path	用户的唯一标识符 (GUID)。示例：“83c07dac-e6b7-4a48-8bf5-fb39fea61620”。

请求数据格式

SetUserHomePageRequestModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/common/printers/test

请求数据格式

PrinterConnectionTestModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

[GET] /api/v2/common/printers

返回值

状态码: 200

成功

PrinterInfo

[POST] /api/v2/common/printers

请求数据格式

PrinterAddModel

返回值

状态码: 200

成功

PrinterDetailInfo

状态码: 400

错误的请求

ServerPluginError

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

参数:

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

返回值

状态码: 200

成功

PrinterDetailInfo

状态码: 400

错误的请求

ServerPluginError

状态码: 403

禁止

状态码: 404

未找到

[PUT] /api/v2/common/printers/{id}

参数:

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

请求数据格式

PrinterAddModel

返回值

状态码: 200

成功

PrinterDetailInfo

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

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

参数:

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

返回值

状态码: 200

成功

PrinterInfo

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

[GET] /api/v2/common/user-info/me

获取当前登录用户的信息。

返回值

状态码: 200

成功

UserResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

类型定义

Ƭ ServerPluginError

服务器插件错误

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

Ƭ SetUserHomePageRequestModel

表示设置用户主页文档的请求。

名称	类型	描述	示例
userId可为空	string	用户的唯一标识符 (GUID)。	`"160C30CC-B9FF-43F8-852A-3BD672176C4B"`
userHomeDocumentId可为空	string	要设置为用户主页的文档的唯一标识符 (GUID)。	`"8760F2A1-C217-480F-8EB0-1EE9DB3AE2C5"`

Ƭ PrinterConnectionTestModel

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

Ƭ PrinterInfo

名称	类型	描述	示例
id可为空	string
name可为空	string
description可为空	string

Ƭ PrinterDetailInfo

名称	类型	描述	示例
options	PrinterOptions
id可为空	string
name可为空	string
description可为空	string

Ƭ PrinterOptions

名称	类型	描述	示例
canDuplex	Boolean
landscapeAngle	int32
maximumCopies	int32
paperSizes可为空	`Array<string>`
paperSources可为空	`Array<string>`
supportsColor	Boolean
isDefault	Boolean

Ƭ PrinterAddModel

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

Ƭ UserResponseModel

用户响应模型

名称	类型	描述
id可为空	string	ID
name可为空	string	姓名
email可为空	string	电子邮件
roles可为空	`Array<string>`	角色
home可为空	string	主页 ID
homeTitle可为空	string	主页标题
homeSource	UserHomePageSource
showWelcomeOnStartup	Boolean	启动时显示欢迎信息
isFirstLogin	Boolean	首次登录
theme可为空	string	主题
language可为空	string	语言
tenantId可为空	string	租户 ID
tenantName可为空	string	租户名称
securityProvider可为空	string	安全提供程序
themeName可为空	string	主题名称
fullName可为空	string	姓名
categoryDocTypes可为空	string	分类文件类型
timeZoneId可为空	string	时区 ID
delegatedBy可为空	DelegatedByItemModel	已将任务委托给当前用户的用户列表。

Ƭ UserHomePageSource

Enum:

None
Personal
Organizational

Ƭ DelegatedByItemModel

名称	类型	描述	示例
id可为空	string
name可为空	string
orgId可为空	string
actions可为空	`Array<string>`
roles可为空	`Array<string>`