标准应用自身 API 参考
此册来自本应用真实挂载路由和输入模型,不是平台SDK对外接口。登录由平台认证员工,应用签发自己的会话。
GET /api/api-directory
本应用 API 登记与实际挂载目录;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[]
参数
[
{
"name": "q",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 120,
"default": "",
"title": "Q"
},
"description": "搜索文字"
},
{
"name": "module",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 100,
"default": "",
"title": "Module"
},
"description": "模块分类"
},
{
"name": "method",
"in": "query",
"required": false,
"schema": {
"type": "string",
"pattern": "^(|GET|POST|PUT|PATCH|DELETE)$",
"default": "",
"title": "Method"
},
"description": "HTTP方法"
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1,
"title": "Page"
},
"description": "从1开始的页号"
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 20,
"title": "Size"
},
"description": "单页数量,上限100"
}
]
请求正文模型
null
返回说明
"items/total/page/page_size/mounted_count/documented_count/gaps,逐项真实 method/path、中文用途、请求 schema、身份、返回语义和错误。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/approvals/changes
对账审批模板变更;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;APPROVALS.VIEW;写入另需 SUBMIT/DECIDE 与实例参与范围"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[]
请求正文模型
null
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/approvals/copies
本人抄送;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS + APPROVALS.VIEW + CUSTOMERS.VIEW;仅当前应用且受对象参与范围限制"
请求头
[]
参数
[]
请求正文模型
null
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/approvals/documents
分页查询审批单;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS + APPROVALS.VIEW + CUSTOMERS.VIEW;仅当前应用且受对象参与范围限制"
请求头
[]
参数
[
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1,
"title": "Page"
},
"description": "从1开始的页号"
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 20,
"title": "Size"
},
"description": "单页数量,上限100"
}
]
请求正文模型
null
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/approvals/documents
创建审批草稿;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS + APPROVALS.VIEW + CUSTOMERS.VIEW;仅当前应用且受对象参与范围限制;APPROVALS.SUBMIT"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)",
"Idempotency-Key: 本次操作的独立 UUID;同一操作重试沿用,内容改变必须换号"
]
参数
[]
请求正文模型
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReviewCreate"
}
}
}
}
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[]
状态
{
"201": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"使用 Idempotency-Key 与内容摘要;相同操作读回原结果,不同内容冲突;更新另检查 expected_version"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/approvals/documents/{id}
审批单详情及历史;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS + APPROVALS.VIEW + CUSTOMERS.VIEW;仅当前应用且受对象参与范围限制"
请求头
[]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
null
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/approvals/documents/{id}/reconcile
核对审批实例当前资格;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS + APPROVALS.VIEW + CUSTOMERS.VIEW;仅当前应用且受对象参与范围限制;APPROVALS.SUBMIT"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)",
"Idempotency-Key: 本次操作的独立 UUID;同一操作重试沿用,内容改变必须换号"
]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReviewVersion"
}
}
}
}
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"使用 Idempotency-Key 与内容摘要;相同操作读回原结果,不同内容冲突;更新另检查 expected_version"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/approvals/documents/{id}/refresh
刷新审批草稿投影;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS + APPROVALS.VIEW + CUSTOMERS.VIEW;仅当前应用且受对象参与范围限制;APPROVALS.SUBMIT"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)",
"Idempotency-Key: 本次操作的独立 UUID;同一操作重试沿用,内容改变必须换号"
]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReviewVersion"
}
}
}
}
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"使用 Idempotency-Key 与内容摘要;相同操作读回原结果,不同内容冲突;更新另检查 expected_version"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/approvals/documents/{id}/submit
发起审批;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS + APPROVALS.VIEW + CUSTOMERS.VIEW;仅当前应用且受对象参与范围限制;APPROVALS.SUBMIT"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)",
"Idempotency-Key: 本次操作的独立 UUID;同一操作重试沿用,内容改变必须换号"
]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReviewSubmit"
}
}
}
}
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"使用 Idempotency-Key 与内容摘要;相同操作读回原结果,不同内容冲突;更新另检查 expected_version"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/approvals/documents/{id}/visualization
审批实例只读流程图;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS + APPROVALS.VIEW + CUSTOMERS.VIEW;仅当前应用且受对象参与范围限制"
请求头
[]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
null
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/approvals/notifications
审批通知兼容状态查询;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;APPROVALS.VIEW"
请求头
[]
参数
[]
请求正文模型
null
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "NOTIFICATION_INPUT_INVALID",
"message": "消息查询只允许一个事件编号"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/approvals/personal
我的待办抄送发起和参与;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS + APPROVALS.VIEW + CUSTOMERS.VIEW;仅当前应用且受对象参与范围限制"
请求头
[]
参数
[
{
"name": "category",
"in": "query",
"required": false,
"schema": {
"type": "string",
"pattern": "^(pending|copies|initiated|participated)$",
"default": "pending",
"title": "Category"
},
"description": "个人审批分类"
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1,
"title": "Page"
},
"description": "从1开始的页号"
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 20,
"title": "Size"
},
"description": "单页数量,上限100"
},
{
"name": "q",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 120,
"default": "",
"title": "Q"
},
"description": "搜索文字"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string",
"pattern": "^(all|DRAFT|PENDING|APPROVED|REJECTED)$",
"default": "all",
"title": "Status"
},
"description": "业务状态筛选"
}
]
请求正文模型
null
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "APPROVAL_QUERY_INVALID",
"message": "审批查询包含重复或不受支持的参数"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/approvals/sync
同步审批模板人员投影;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;APPROVALS.VIEW;写入另需 SUBMIT/DECIDE 与实例参与范围"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[]
请求正文模型
null
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/approvals/tasks/{id}/decision
提交审批意见;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS + APPROVALS.VIEW + CUSTOMERS.VIEW;仅当前应用且受对象参与范围限制;APPROVALS.DECIDE"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)",
"Idempotency-Key: 本次操作的独立 UUID;同一操作重试沿用,内容改变必须换号"
]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskDecision"
}
}
}
}
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"使用 Idempotency-Key 与内容摘要;相同操作读回原结果,不同内容冲突;更新另检查 expected_version"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/approvals/templates
已同步审批模板与版本;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;APPROVALS.VIEW"
请求头
[]
参数
[]
请求正文模型
null
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[
"instance_execution",
"items",
"message"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/approvals/templates/{template_id}/versions/{version}/resolve
正式发起前只读预览;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;APPROVALS.VIEW;写入另需 SUBMIT/DECIDE 与实例参与范围"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[
{
"name": "template_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Template Id"
},
"description": "审批模板稳定编号"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"title": "Version"
},
"description": "指定文件或结构版本"
}
]
请求正文模型
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectionPreview"
}
}
}
}
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[
"presentation"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/approvals/templates/{template_id}/versions/{version}/visualization
只读审批模板流程图;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;APPROVALS.VIEW"
请求头
[]
参数
[
{
"name": "template_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Template Id"
},
"description": "审批模板稳定编号"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"title": "Version"
},
"description": "指定文件或结构版本"
}
]
请求正文模型
null
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/approvals/todos
本人待办;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS + APPROVALS.VIEW + CUSTOMERS.VIEW;仅当前应用且受对象参与范围限制"
请求头
[]
参数
[]
请求正文模型
null
返回说明
"返回本应用审批模板/实例/任务、当前版本、人员显示信息与状态;列表 items。发起与办理通过平台签名和在线资格校验,历史与客户效果在应用事务内保存。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/audit
分页查询操作审计;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;AUDIT.VIEW"
请求头
[]
参数
[
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1,
"title": "Page"
},
"description": "从1开始的页号"
},
{
"name": "q",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 120,
"default": "",
"title": "Q"
},
"description": "搜索文字"
},
{
"name": "action",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 60,
"default": "",
"title": "Action"
},
"description": "按当前公开合同传入"
},
{
"name": "order",
"in": "query",
"required": false,
"schema": {
"type": "string",
"pattern": "^(asc|desc)$",
"default": "desc",
"title": "Order"
},
"description": "按当前公开合同传入"
}
]
请求正文模型
null
返回说明
"items/total/page/page_size;记录可信操作者、动作、业务快照、结果及 request_id;不返回密码、Token或完整连接串。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/brand
公开品牌与主题;数据范围由服务端配置与可信会话确定。
身份与权限
"公开入口;登录由平台验证员工手机号及密码"
请求头
[]
参数
[]
请求正文模型
null
返回说明
"公开公司/系统显示名、主题或 Logo 字节;无应用凭据。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/brand/logo
公开企业 Logo;数据范围由服务端配置与可信会话确定。
身份与权限
"公开入口;登录由平台验证员工手机号及密码"
请求头
[]
参数
[]
请求正文模型
null
返回说明
"公开公司/系统显示名、主题或 Logo 字节;无应用凭据。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "LOGO_NOT_FOUND",
"message": "尚未设置 Logo"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/customers
分页查询客户;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;CUSTOMERS.VIEW"
请求头
[]
参数
[
{
"name": "q",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 120,
"default": "",
"title": "Q"
},
"description": "搜索文字"
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1,
"title": "Page"
},
"description": "从1开始的页号"
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 20,
"title": "Size"
},
"description": "单页数量,上限100"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string",
"pattern": "^(all|active|inactive)$",
"default": "all",
"title": "Status"
},
"description": "业务状态筛选"
}
]
请求正文模型
null
返回说明
"列表返回 items、total、page、page_size;详情为客户字段和版本;维护返回当前客户、版本或受理结果。业务写入必须使用当前版本。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/customers
创建客户;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;CUSTOMERS.CREATE"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)",
"Idempotency-Key: 本次操作的独立 UUID;同一操作重试沿用,内容改变必须换号"
]
参数
[]
请求正文模型
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerCreate"
}
}
}
}
返回说明
"列表返回 items、total、page、page_size;详情为客户字段和版本;维护返回当前客户、版本或受理结果。业务写入必须使用当前版本。"
返回字段
[]
状态
{
"201": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"使用 Idempotency-Key 与内容摘要;相同操作读回原结果,不同内容冲突;更新另检查 expected_version"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/customers/{id}
查看客户详情;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;CUSTOMERS.VIEW"
请求头
[]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
null
返回说明
"列表返回 items、total、page、page_size;详情为客户字段和版本;维护返回当前客户、版本或受理结果。业务写入必须使用当前版本。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
PUT /api/customers/{id}
编辑客户资料;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;CUSTOMERS.EDIT"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)",
"Idempotency-Key: 本次操作的独立 UUID;同一操作重试沿用,内容改变必须换号"
]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerEdit"
}
}
}
}
返回说明
"列表返回 items、total、page、page_size;详情为客户字段和版本;维护返回当前客户、版本或受理结果。业务写入必须使用当前版本。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"使用 Idempotency-Key 与内容摘要;相同操作读回原结果,不同内容冲突;更新另检查 expected_version"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/customers/{id}/approval-context
客户停用审批上下文;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;CUSTOMERS.VIEW、APPROVALS.VIEW"
请求头
[]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
null
返回说明
"列表返回 items、total、page、page_size;详情为客户字段和版本;维护返回当前客户、版本或受理结果。业务写入必须使用当前版本。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/customers/{id}/approval-requests
提交客户停用审批申请;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;CUSTOMERS.VIEW、CUSTOMERS.DISABLE、APPROVALS.SUBMIT"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)",
"Idempotency-Key: 本次操作的独立 UUID;同一操作重试沿用,内容改变必须换号"
]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisableApplication"
}
}
}
}
返回说明
"列表返回 items、total、page、page_size;详情为客户字段和版本;维护返回当前客户、版本或受理结果。业务写入必须使用当前版本。"
返回字段
[]
状态
{
"201": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"使用 Idempotency-Key 与内容摘要;相同操作读回原结果,不同内容冲突;更新另检查 expected_version"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/customers/{id}/status
设置客户状态;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;CUSTOMERS.DISABLE"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)",
"Idempotency-Key: 本次操作的独立 UUID;同一操作重试沿用,内容改变必须换号"
]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerStatus"
}
}
}
}
返回说明
"列表返回 items、total、page、page_size;详情为客户字段和版本;维护返回当前客户、版本或受理结果。业务写入必须使用当前版本。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"使用 Idempotency-Key 与内容摘要;相同操作读回原结果,不同内容冲突;更新另检查 expected_version"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/directory
分页查询目录镜像;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;DIRECTORY.VIEW"
请求头
[]
参数
[
{
"name": "kind",
"in": "query",
"required": false,
"schema": {
"type": "string",
"pattern": "^(EMPLOYEE|ORGANIZATION|POSITION|APPOINTMENT)$",
"default": "EMPLOYEE",
"title": "Kind"
},
"description": "目录资源类型"
},
{
"name": "q",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 100,
"default": "",
"title": "Q"
},
"description": "搜索文字"
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1,
"title": "Page"
},
"description": "从1开始的页号"
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 20,
"title": "Size"
},
"description": "单页数量,上限100"
},
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"type": "string",
"pattern": "^(all|current|historical)$",
"default": "all",
"title": "State"
},
"description": "处理或目录状态筛选"
},
{
"name": "organization_id",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 36,
"default": "",
"title": "Organization Id"
},
"description": "组织稳定编号"
}
]
请求正文模型
null
返回说明
"返回当前 scope 的目录 DTO、同步状态、版本及范围;维护返回平台实际结果、审计与同步结果。临时密码仅首次成功按合同返回,重复提交不重置。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "DIRECTORY_QUERY_INVALID",
"message": "目录查询包含重复或不受支持的范围参数"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/directory/commands
权威目录维护并同步镜像;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;DIRECTORY.VIEW;同步/维护另需 DIRECTORY.SYNC 和对应操作权限"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)",
"Idempotency-Key: 本次操作的独立 UUID;同一操作重试沿用,内容改变必须换号"
]
参数
[]
请求正文模型
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaintenanceRequest"
}
}
},
"required": true
}
返回说明
"返回当前 scope 的目录 DTO、同步状态、版本及范围;维护返回平台实际结果、审计与同步结果。临时密码仅首次成功按合同返回,重复提交不重置。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"使用 Idempotency-Key 与内容摘要;相同操作读回原结果,不同内容冲突;更新另检查 expected_version"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "DIRECTORY_RECEIPT_INVALID",
"message": "平台回执无法确认,请保留操作标识并核对"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/directory/maintenance-context
取得目录维护上下文与版本;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;DIRECTORY.VIEW;同步/维护另需 DIRECTORY.SYNC 和对应操作权限"
请求头
[]
参数
[
{
"name": "operation",
"in": "query",
"required": true,
"schema": {
"type": "string",
"maxLength": 100,
"title": "Operation"
},
"description": "实际注册的维护操作"
},
{
"name": "target",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 36
},
{
"type": "null"
}
],
"title": "Target"
},
"description": "操作目标编号"
},
{
"name": "organization",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 36
},
{
"type": "null"
}
],
"title": "Organization"
},
"description": "已选组织编号"
},
{
"name": "organization_version",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
],
"title": "Organization Version"
},
"description": "已选组织版本"
}
]
请求正文模型
null
返回说明
"返回当前 scope 的目录 DTO、同步状态、版本及范围;维护返回平台实际结果、审计与同步结果。临时密码仅首次成功按合同返回,重复提交不重置。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/directory/organization-tree
组织目录树;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;DIRECTORY.VIEW"
请求头
[]
参数
[]
请求正文模型
null
返回说明
"返回当前 scope 的目录 DTO、同步状态、版本及范围;维护返回平台实际结果、审计与同步结果。临时密码仅首次成功按合同返回,重复提交不重置。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/directory/records/{kind}/{id}
组织人员岗位任职详情;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;DIRECTORY.VIEW"
请求头
[]
参数
[
{
"name": "kind",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Kind"
},
"description": "目录资源类型"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
null
返回说明
"返回当前 scope 的目录 DTO、同步状态、版本及范围;维护返回平台实际结果、审计与同步结果。临时密码仅首次成功按合同返回,重复提交不重置。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "DIRECTORY_KIND_INVALID",
"message": "目录类型不受支持"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/directory/sync
完整或增量同步目录;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;DIRECTORY.VIEW;同步/维护另需 DIRECTORY.SYNC 和对应操作权限"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[
{
"name": "mode",
"in": "query",
"required": false,
"schema": {
"type": "string",
"pattern": "^(auto|full|incremental)$",
"default": "auto",
"title": "Mode"
},
"description": "完整或增量同步模式"
}
]
请求正文模型
null
返回说明
"返回当前 scope 的目录 DTO、同步状态、版本及范围;维护返回平台实际结果、审计与同步结果。临时密码仅首次成功按合同返回,重复提交不重置。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/environment
读取运行环境检测;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[]
参数
[]
请求正文模型
null
返回说明
"当前解释器、应用与环境检测状态;不将本机检测扩展为其他主机保证。"
返回字段
[
"compatibility",
"database",
"dependencies",
"odbc_drivers",
"os",
"python",
"sql_server_version",
"storage",
"version"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/files
分页查询业务文件;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;FILES.VIEW"
请求头
[]
参数
[
{
"name": "q",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 120,
"default": "",
"title": "Q"
},
"description": "搜索文字"
},
{
"name": "deleted",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Deleted"
},
"description": "是否查看回收文件"
},
{
"name": "folder_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Folder Id"
},
"description": "保存文件夹编号"
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1,
"title": "Page"
},
"description": "从1开始的页号"
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 20,
"title": "Size"
},
"description": "单页数量,上限100"
}
]
请求正文模型
null
返回说明
"查询返回文件元数据(名称、大小、版本、状态、上传人);下载返回文件字节及 Content-Disposition;写入返回文件标识与版本,不返回服务器秘密路径。"
返回字段
[
"items",
"total"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/files
上传业务文件或版本;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;FILES.UPLOAD"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[]
请求正文模型
{
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_upload_file_api_files_post"
}
}
}
}
返回说明
"查询返回文件元数据(名称、大小、版本、状态、上传人);下载返回文件字节及 Content-Disposition;写入返回文件标识与版本,不返回服务器秘密路径。"
返回字段
[
"id",
"stored"
]
状态
{
"201": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/files/{id}/download
下载或预览文件;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;FILES.DOWNLOAD"
请求头
[]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
},
{
"name": "preview",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Preview"
},
"description": "是否在浏览器内预览"
},
{
"name": "version",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
],
"title": "Version"
},
"description": "指定文件或结构版本"
}
]
请求正文模型
null
返回说明
"查询返回文件元数据(名称、大小、版本、状态、上传人);下载返回文件字节及 Content-Disposition;写入返回文件标识与版本,不返回服务器秘密路径。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"读取文件字节,同时保存下载审计"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/files/{id}/versions
文件版本历史;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;FILES.VIEW"
请求头
[]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
null
返回说明
"查询返回文件元数据(名称、大小、版本、状态、上传人);下载返回文件字节及 Content-Disposition;写入返回文件标识与版本,不返回服务器秘密路径。"
返回字段
[
"items"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/files/{id}/{operation}
回收或恢复文件;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;FILES.MANAGE"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
},
{
"name": "operation",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Operation"
},
"description": "实际注册的维护操作"
}
]
请求正文模型
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VersionCommand"
}
}
}
}
返回说明
"查询返回文件元数据(名称、大小、版本、状态、上传人);下载返回文件字节及 Content-Disposition;写入返回文件标识与版本,不返回服务器秘密路径。"
返回字段
[
"updated"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "FILE_OPERATION_INVALID",
"message": "文件操作不存在"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/folders
本人员文件夹;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;FILES.VIEW"
请求头
[]
参数
[]
请求正文模型
null
返回说明
"items 或新文件夹 id;只限当前员工拥有的本 scope 文件夹。"
返回字段
[
"items"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/folders
创建文件夹;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;FILES.UPLOAD"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[]
请求正文模型
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderCommand"
}
}
},
"required": true
}
返回说明
"items 或新文件夹 id;只限当前员工拥有的本 scope 文件夹。"
返回字段
[
"id"
]
状态
{
"201": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "FOLDER_NOT_FOUND",
"message": "上级文件夹不存在"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/health
本应用进程健康状态;数据范围由服务端配置与可信会话确定。
身份与权限
"公开入口;登录由平台验证员工手机号及密码"
请求头
[]
参数
[]
请求正文模型
null
返回说明
"status、version、configured、database_configured;仅本应用配置/进程状态,不代替业务连通验收。"
返回字段
[
"configured",
"database_configured",
"sdk_version",
"status",
"version"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/me
当前员工身份与实时菜单权限;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;当前会话本人;写请求同源和 CSRF"
请求头
[]
参数
[]
请求正文模型
null
返回说明
"actor、csrf、permissions(三态 ALLOW/DENY/ERROR),不跨请求缓存权限。"
返回字段
[
"actor",
"csrf",
"permissions"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "APPLICATION_ENTRY_DENIED",
"message": "当前员工没有进入此应用的权限"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/notifications
分页查询本应用通知;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[]
参数
[
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1,
"title": "Page"
},
"description": "从1开始的页号"
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 20,
"title": "Size"
},
"description": "单页数量,上限100"
},
{
"name": "q",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 120,
"default": "",
"title": "Q"
},
"description": "搜索文字"
},
{
"name": "event_type",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 100,
"default": "",
"title": "Event Type"
},
"description": "原始变更类型"
},
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"type": "string",
"pattern": "^(|success|failure|pending)$",
"default": "",
"title": "State"
},
"description": "处理或目录状态筛选"
},
{
"name": "source_kind",
"in": "query",
"required": false,
"schema": {
"type": "string",
"pattern": "^(|business|test|reconcile)$",
"default": "",
"title": "Source Kind"
},
"description": "业务回调、测试通知或主动对账"
},
{
"name": "template",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 36,
"default": "",
"title": "Template"
},
"description": "模板编号"
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 40,
"default": "",
"title": "Start"
},
"description": "筛选起始UTC时间"
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 40,
"default": "",
"title": "End"
},
"description": "筛选结束UTC时间"
}
]
请求正文模型
null
返回说明
"items/total/page/page_size/counts/coverage;详情包含 event、来源、callback_received_at、downloaded_at、applied_at、receipt_at、attempt_history、first_failure。未采集字段为 null。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/notifications/{id}
通知处理时间线;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
null
返回说明
"items/total/page/page_size/counts/coverage;详情包含 event、来源、callback_received_at、downloaded_at、applied_at、receipt_at、attempt_history、first_failure。未采集字段为 null。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "NOTIFICATION_NOT_FOUND",
"message": "当前应用中没有该事件的本地记录"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/panorama
当前应用组织岗位人员全景;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;DIRECTORY.VIEW"
请求头
[]
参数
[]
请求正文模型
null
返回说明
"返回一致镜像 items/employees/counts/status;组织人员按 ID 去重;员工权限以最终集合为准,完整分页读取本应用权限目录,按 ID/完整编码核对,追加 page_name/property/description/metadata_status;不完整目录明确未确认,不扩展授权集合。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/panorama/employees/{id}/permissions
员工当前应用完整有效权限;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;DIRECTORY.VIEW"
请求头
[]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
null
返回说明
"返回一致镜像 items/employees/counts/status;组织人员按 ID 去重;员工权限以最终集合为准,完整分页读取本应用权限目录,按 ID/完整编码核对,追加 page_name/property/description/metadata_status;不完整目录明确未确认,不扩展授权集合。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "PANORAMA_EMPLOYEE_INACTIVE",
"message": "员工已停用,请刷新当前全景"
},
{
"code": "PANORAMA_PERMISSION_SCOPE_INVALID",
"message": "员工有效权限或目录的企业、应用、ID与编码不匹配,拒绝展示"
},
{
"code": "PANORAMA_PERMISSION_METADATA_UNAVAILABLE",
"message": "有效集合已取得但目录读取失败;200响应中的metadata_issue明确未确认,不显示为空集合"
},
{
"code": "PANORAMA_PERMISSION_METADATA_MISSING",
"message": "部分定义缺失、停用或资料字段未确认;保留有效编码并提示刷新"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/panorama/organizations/{id}/people
组织范围人员并集;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;DIRECTORY.VIEW"
请求头
[]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
null
返回说明
"返回一致镜像 items/employees/counts/status;组织人员按 ID 去重;员工权限以最终集合为准,完整分页读取本应用权限目录,按 ID/完整编码核对,追加 page_name/property/description/metadata_status;不完整目录明确未确认,不扩展授权集合。"
返回字段
[
"items",
"status"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/password
员工本人修改密码;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;当前会话本人;写请求同源和 CSRF"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[]
请求正文模型
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeePasswordChange"
}
}
},
"required": true
}
返回说明
"修改确认并清除当前 Cookie;旧凭据与所有旧认证按平台代次失效。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "INPUT_INVALID",
"message": "本人改密不接受账号、企业或其他查询参数"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/platform/notifications
接收平台人员投影通知;数据范围由服务端配置与可信会话确定。
身份与权限
"回调 Bearer + X-WanLink-Event-ID;固定企业应用;不使用员工 Cookie"
请求头
[
"Authorization: Bearer <回调专用凭据>",
"X-WanLink-Event-ID: 与 JSON event_id 完全一致"
]
参数
[]
请求正文模型
null
返回说明
"accepted/duplicate/test;只确认通知已耐久接收,不等同投影应用或 applied。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"按当前作用域 event_id 去重,重复回调不重复计业务事件,乱序不降投影版本"
副作用
"事件先耐久接收,后台下载、提交和回执分步处理"
错误
[
{
"code": "NOTIFICATION_INVALID",
"message": "消息正文不是有效 JSON"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
DELETE /api/session
退出当前员工会话;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;当前会话本人;写请求同源和 CSRF"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[]
请求正文模型
null
返回说明
"登录返回 actor、csrf;退出撤销本地会话。错误返回 error.code/message/provider 与 request_id。"
返回字段
[
"signed_out"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/session
员工登录;数据范围由服务端配置与可信会话确定。
身份与权限
"公开入口;登录由平台验证员工手机号及密码"
请求头
[]
参数
[]
请求正文模型
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Login"
}
}
},
"required": true
}
返回说明
"登录返回 actor、csrf;退出撤销本地会话。错误返回 error.code/message/provider 与 request_id。"
返回字段
[
"actor",
"csrf",
"redirect"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/settings
读取本应用设置;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[]
参数
[]
请求正文模型
null
返回说明
"返回对应的非秘密配置、配置 revision、草稿 id/state/checks、启用结果或保存确认。只有明确凭据显示接口返回当前秘密,禁止记录或缓存该响应。"
返回字段
[
"brand",
"database",
"historical_storage_roots",
"max_upload_bytes",
"platform",
"storage_root",
"version"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
PUT /api/settings
保存外观与文件存储;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[]
请求正文模型
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SettingsPatch"
}
}
},
"required": true
}
返回说明
"返回对应的非秘密配置、配置 revision、草稿 id/state/checks、启用结果或保存确认。只有明确凭据显示接口返回当前秘密,禁止记录或缓存该响应。"
返回字段
[
"saved"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
PUT /api/settings/database
受控保存数据库配置;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[]
请求正文模型
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabaseConfig"
}
}
},
"required": true
}
返回说明
"返回对应的非秘密配置、配置 revision、草稿 id/state/checks、启用结果或保存确认。只有明确凭据显示接口返回当前秘密,禁止记录或缓存该响应。"
返回字段
[
"saved",
"schema_modified",
"sign_in_again_if_database_changed"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SERVER_SECRET_INPUT_REQUIRED",
"message": "数据库密码请通过服务器安装向导输入"
},
{
"code": "DATABASE_INSTALLER_REQUIRED",
"message": "更换数据库目标请通过服务器安装、备份及恢复流程执行"
},
{
"code": "DATABASE_PASSWORD_REQUIRED",
"message": "更换连接目标或 SQL 账号时需要提供密码"
},
{
"code": "DATABASE_TEST_FAILED",
"message": "目标业务库不可用或迁移状态不正确,未保存"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/settings/database/test
测试数据库连接;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[]
请求正文模型
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabaseConfig"
}
}
},
"required": true
}
返回说明
"返回对应的非秘密配置、配置 revision、草稿 id/state/checks、启用结果或保存确认。只有明确凭据显示接口返回当前秘密,禁止记录或缓存该响应。"
返回字段
[
"connected",
"database",
"schema_modified",
"server_version"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"实际连接验证;当前接入测试回滚目录和投影,草稿测试只保存检查结果,不启用配置"
错误
[
{
"code": "SERVER_SECRET_INPUT_REQUIRED",
"message": "数据库密码请通过服务器安装向导输入"
},
{
"code": "DATABASE_INSTALLER_REQUIRED",
"message": "更换数据库目标请通过服务器安装、备份及恢复流程执行"
},
{
"code": "DATABASE_TEST_FAILED",
"message": "连接测试未通过,请核对服务端配置、网络和数据库权限"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/settings/logo
上传企业 Logo;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[]
请求正文模型
{
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_upload_logo_api_settings_logo_post"
}
}
},
"required": true
}
返回说明
"返回对应的非秘密配置、配置 revision、草稿 id/state/checks、启用结果或保存确认。只有明确凭据显示接口返回当前秘密,禁止记录或缓存该响应。"
返回字段
[
"saved"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "LOGO_TOO_LARGE",
"message": "Logo 不能超过 2 MB"
},
{
"code": "LOGO_TYPE_INVALID",
"message": "Logo 仅支持 PNG 和 JPEG"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/settings/platform
读取已启用 WanLink 接入;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[]
参数
[]
请求正文模型
null
返回说明
"返回对应的非秘密配置、配置 revision、草稿 id/state/checks、启用结果或保存确认。只有明确凭据显示接口返回当前秘密,禁止记录或缓存该响应。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
PUT /api/settings/platform
拒绝直接覆盖已启用配置;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[]
请求正文模型
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/wsea__connection__Command"
}
}
},
"required": true
}
返回说明
"返回对应的非秘密配置、配置 revision、草稿 id/state/checks、启用结果或保存确认。只有明确凭据显示接口返回当前秘密,禁止记录或缓存该响应。"
返回字段
[]
状态
{
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"重复请求均返回 CONFIGURATION_LOCKED"
副作用
"始终拒绝直接覆盖已启用配置,不写入"
错误
[
{
"code": "CONFIGURATION_LOCKED",
"message": "已启用配置只读;请使用修改配置草稿、完整验证和启用流程"
},
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/settings/platform/credential-requests
创建服务器安全输入请求;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[]
请求正文模型
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/wsea__connection__Command"
}
}
},
"required": true
}
返回说明
"返回对应的非秘密配置、配置 revision、草稿 id/state/checks、启用结果或保存确认。只有明确凭据显示接口返回当前秘密,禁止记录或缓存该响应。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/settings/platform/credential-requests/{id}
查询凭据暂存状态;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
null
返回说明
"返回对应的非秘密配置、配置 revision、草稿 id/state/checks、启用结果或保存确认。只有明确凭据显示接口返回当前秘密,禁止记录或缓存该响应。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/settings/platform/credential/reveal
显式读取当前应用凭据;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[]
请求正文模型
null
返回说明
"返回对应的非秘密配置、配置 revision、草稿 id/state/checks、启用结果或保存确认。只有明确凭据显示接口返回当前秘密,禁止记录或缓存该响应。"
返回字段
[
"credential",
"revision"
]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"显式返回当前秘密并记录不含秘密的查看审计;Cache-Control: no-store"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/settings/platform/drafts
加密保存待验证接入草稿;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[]
请求正文模型
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrowserCommand"
}
}
},
"required": true
}
返回说明
"返回对应的非秘密配置、配置 revision、草稿 id/state/checks、启用结果或保存确认。只有明确凭据显示接口返回当前秘密,禁止记录或缓存该响应。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"提交所述业务操作;失败按本模块事务合同回滚"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
GET /api/settings/platform/drafts/{id}
读取本人接入草稿;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
null
返回说明
"返回对应的非秘密配置、配置 revision、草稿 id/state/checks、启用结果或保存确认。只有明确凭据显示接口返回当前秘密,禁止记录或缓存该响应。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"只读查询可重复;仍实时核验身份和权限"
副作用
"只读,不改变业务对象;依赖按当前权限核验"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/settings/platform/drafts/{id}/activate
原子启用已验证接入草稿;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
null
返回说明
"返回对应的非秘密配置、配置 revision、草稿 id/state/checks、启用结果或保存确认。只有明确凭据显示接口返回当前秘密,禁止记录或缓存该响应。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"同一 draft_id 激活读回已启用状态;旧配置版本或未验证草稿拒绝"
副作用
"验证固定身份后原子切换配置、镜像、游标,恢复标记保护通知队列"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/settings/platform/drafts/{id}/test
验证草稿网络身份与投影;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Id"
},
"description": "当前作用域对象的稳定编号"
}
]
请求正文模型
null
返回说明
"返回对应的非秘密配置、配置 revision、草稿 id/state/checks、启用结果或保存确认。只有明确凭据显示接口返回当前秘密,禁止记录或缓存该响应。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"实际连接验证;当前接入测试回滚目录和投影,草稿测试只保存检查结果,不启用配置"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
POST /api/settings/platform/test
测试当前或指定 WanLink 接入;数据范围由服务端配置与可信会话确定。
身份与权限
"真实员工会话 + RUNTIME.ACCESS;SETTINGS.MANAGE"
请求头
[
"X-WSEA-Request: 1",
"X-CSRF-Token: 当前会话(写入)"
]
参数
[]
请求正文模型
{
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/wsea__connection__Command"
},
{
"type": "null"
}
],
"title": "Payload"
}
}
}
}
返回说明
"返回对应的非秘密配置、配置 revision、草稿 id/state/checks、启用结果或保存确认。只有明确凭据显示接口返回当前秘密,禁止记录或缓存该响应。"
返回字段
[]
状态
{
"200": {
"description": "成功;字段语义见返回说明"
},
"401": {
"description": "会话或回调认证失效"
},
"403": {
"description": "实时权限或作用域拒绝"
},
"422": {
"description": "参数无效;实际错误封装为 error.code/message 与 request_id,不回显输入"
},
"409": {
"description": "对象或配置版本冲突、当前状态不允许"
},
"503": {
"description": "平台或数据库依赖无法确认,停止操作"
}
}
幂等
"不承诺幂等;重试前先读回对象状态"
副作用
"实际连接验证;当前接入测试回滚目录和投影,草稿测试只保存检查结果,不启用配置"
错误
[
{
"code": "SESSION_REVOKED / LOGIN_REQUIRED",
"message": "身份无效或已退出时拒绝"
},
{
"code": "PERMISSION_DENIED / PLATFORM_ACCESS_DENIED",
"message": "当前实时权限或平台范围不允许"
},
{
"code": "INPUT_INVALID",
"message": "参数校验未通过;具体字段以请求 schema 为准"
}
]
请求模型(类型、必填及限制)
{
"Body_upload_file_api_files_post": {
"properties": {
"upload": {
"type": "string",
"contentMediaType": "application/octet-stream",
"title": "Upload",
"description": "上传的文件字节"
},
"folder_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Folder Id",
"description": "保存文件夹编号"
},
"customer_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id",
"description": "所属客户编号"
},
"file_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "File Id",
"description": "已有文件编号(新增版本)"
},
"expected_version": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Version",
"description": "当前对象版本,冲突拒绝"
}
},
"type": "object",
"required": [
"upload"
],
"title": "Body_upload_file_api_files_post"
},
"Body_upload_logo_api_settings_logo_post": {
"properties": {
"upload": {
"type": "string",
"contentMediaType": "application/octet-stream",
"title": "Upload",
"description": "上传的文件字节"
}
},
"type": "object",
"required": [
"upload"
],
"title": "Body_upload_logo_api_settings_logo_post"
},
"Brand": {
"properties": {
"company_name": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"title": "Company Name",
"default": "企业工作空间",
"description": "企业显示名称"
},
"system_name": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"title": "System Name",
"default": "WanLink 标准企业应用",
"description": "应用显示名称"
},
"workspace_name": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"title": "Workspace Name",
"default": "工作台",
"description": "工作台显示名称"
},
"page_title": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"title": "Page Title",
"default": "企业工作空间",
"description": "浏览器页面标题"
},
"theme": {
"type": "string",
"title": "Theme",
"default": "ocean",
"description": "已支持主题标识"
}
},
"additionalProperties": false,
"type": "object",
"title": "Brand"
},
"BrowserCommand": {
"properties": {
"base_url": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"title": "Base Url",
"description": "已批准的平台HTTPS来源"
},
"client_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"title": "Client Id",
"description": "当前应用ID"
},
"expected_application_id": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"title": "Expected Application Id",
"description": "当前部署固定的应用ID"
},
"expected_revision": {
"type": "string",
"maxLength": 64,
"minLength": 64,
"title": "Expected Revision",
"description": "加密配置SHA256版本,用于并发保护"
},
"credential_request_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Credential Request Id",
"description": "服务器受保护凭据暂存请求编号"
},
"credential_mode": {
"type": "string",
"enum": [
"existing",
"replace"
],
"title": "Credential Mode",
"default": "existing",
"description": "existing保留,replace使用输入值"
},
"credential_value": {
"anyOf": [
{
"type": "string",
"format": "password",
"writeOnly": true
},
{
"type": "null"
}
],
"title": "Credential Value",
"description": "替换应用凭据;掩码和空值拒绝,服务器加密保存"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"base_url",
"client_id",
"expected_application_id",
"expected_revision"
],
"title": "BrowserCommand"
},
"CustomerCreate": {
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"title": "Name",
"description": "对象名称"
},
"contact": {
"type": "string",
"maxLength": 80,
"title": "Contact",
"default": "",
"description": "联系人"
},
"phone": {
"type": "string",
"maxLength": 40,
"title": "Phone",
"default": "",
"description": "手机号"
},
"email": {
"type": "string",
"maxLength": 120,
"title": "Email",
"default": "",
"description": "电子邮箱"
},
"address": {
"type": "string",
"maxLength": 300,
"title": "Address",
"default": "",
"description": "联系地址"
},
"note": {
"type": "string",
"maxLength": 1000,
"title": "Note",
"default": "",
"description": "备注"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name"
],
"title": "CustomerCreate"
},
"CustomerEdit": {
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"title": "Name",
"description": "对象名称"
},
"contact": {
"type": "string",
"maxLength": 80,
"title": "Contact",
"default": "",
"description": "联系人"
},
"phone": {
"type": "string",
"maxLength": 40,
"title": "Phone",
"default": "",
"description": "手机号"
},
"email": {
"type": "string",
"maxLength": 120,
"title": "Email",
"default": "",
"description": "电子邮箱"
},
"address": {
"type": "string",
"maxLength": 300,
"title": "Address",
"default": "",
"description": "联系地址"
},
"note": {
"type": "string",
"maxLength": 1000,
"title": "Note",
"default": "",
"description": "备注"
},
"code": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"title": "Code",
"description": "稳定编码,不可通过编辑改变"
},
"expected_version": {
"type": "integer",
"minimum": 1.0,
"title": "Expected Version",
"description": "当前对象版本,冲突拒绝"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"code",
"expected_version"
],
"title": "CustomerEdit"
},
"CustomerStatus": {
"properties": {
"active": {
"type": "boolean",
"title": "Active",
"description": "是否启用"
},
"expected_version": {
"type": "integer",
"minimum": 1.0,
"title": "Expected Version",
"description": "当前对象版本,冲突拒绝"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"active",
"expected_version"
],
"title": "CustomerStatus"
},
"DatabaseConfig": {
"properties": {
"server": {
"type": "string",
"title": "Server",
"default": "",
"description": "SQL服务器实例"
},
"name": {
"type": "string",
"title": "Name",
"default": "",
"description": "对象名称"
},
"username": {
"type": "string",
"title": "Username",
"default": "",
"description": "登录账号;员工登录为手机号"
},
"password": {
"type": "string",
"format": "password",
"title": "Password",
"default": "",
"writeOnly": true,
"description": "密码,不在目录示例或日志中显示"
},
"trust_server_certificate": {
"type": "boolean",
"title": "Trust Server Certificate",
"default": false,
"description": "显式SQL证书信任配置"
}
},
"additionalProperties": false,
"type": "object",
"title": "DatabaseConfig"
},
"DisableApplication": {
"properties": {
"expected_version": {
"type": "integer",
"minimum": 1.0,
"title": "Expected Version",
"description": "当前对象版本,冲突拒绝"
},
"template_id": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"title": "Template Id",
"description": "审批模板稳定编号"
},
"template_version": {
"type": "integer",
"minimum": 1.0,
"title": "Template Version",
"description": "冻结审批结构版本"
},
"selected_employee_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Selected Employee Ids",
"description": "节点ID到自选审批员工ID的映射"
},
"reason": {
"type": "string",
"maxLength": 1000,
"minLength": 5,
"title": "Reason",
"description": "操作原因"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"expected_version",
"template_id",
"template_version",
"reason"
],
"title": "DisableApplication"
},
"EmployeePasswordChange": {
"properties": {
"current_password": {
"type": "string",
"maxLength": 1024,
"title": "Current Password",
"description": "本人原密码"
},
"new_password": {
"type": "string",
"maxLength": 1024,
"title": "New Password",
"description": "本人新密码"
},
"confirmation": {
"type": "string",
"maxLength": 1024,
"title": "Confirmation",
"description": "确认新密码"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"current_password",
"new_password",
"confirmation"
],
"title": "EmployeePasswordChange"
},
"FolderCommand": {
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"title": "Name",
"description": "对象名称"
},
"parent_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Parent Id",
"description": "上级对象编号"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name"
],
"title": "FolderCommand"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"Login": {
"properties": {
"username": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"title": "Username",
"description": "登录账号;员工登录为手机号"
},
"password": {
"type": "string",
"maxLength": 1024,
"minLength": 1,
"title": "Password",
"description": "密码,不在目录示例或日志中显示"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"username",
"password"
],
"title": "Login"
},
"MaintenanceRequest": {
"properties": {
"command": {
"$ref": "#/components/schemas/wsea__directory_commands__Command",
"description": "目录维护命令"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"command"
],
"title": "MaintenanceRequest"
},
"ProjectionPreview": {
"properties": {
"selected_employee_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Selected Employee Ids",
"description": "节点ID到自选审批员工ID的映射"
}
},
"additionalProperties": false,
"type": "object",
"title": "ProjectionPreview"
},
"ReviewCreate": {
"properties": {
"customer_id": {
"type": "string",
"maxLength": 36,
"minLength": 1,
"title": "Customer Id",
"description": "所属客户编号"
},
"title": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"title": "Title",
"description": "审批单标题"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"customer_id",
"title"
],
"title": "ReviewCreate"
},
"ReviewSubmit": {
"properties": {
"expected_version": {
"type": "integer",
"minimum": 1.0,
"title": "Expected Version",
"description": "当前对象版本,冲突拒绝"
},
"template_id": {
"type": "string",
"maxLength": 36,
"minLength": 36,
"title": "Template Id",
"description": "审批模板稳定编号"
},
"template_version": {
"type": "integer",
"minimum": 1.0,
"title": "Template Version",
"description": "冻结审批结构版本"
},
"selected_employee_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Selected Employee Ids",
"description": "节点ID到自选审批员工ID的映射"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"expected_version",
"template_id",
"template_version"
],
"title": "ReviewSubmit"
},
"ReviewVersion": {
"properties": {
"expected_version": {
"type": "integer",
"minimum": 1.0,
"title": "Expected Version",
"description": "当前对象版本,冲突拒绝"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"expected_version"
],
"title": "ReviewVersion"
},
"Selection": {
"properties": {
"organization_id": {
"type": "string",
"title": "Organization Id",
"description": "组织稳定编号"
},
"organization_version": {
"type": "integer",
"minimum": 1.0,
"title": "Organization Version",
"description": "已选组织版本"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"organization_id",
"organization_version"
],
"title": "Selection"
},
"SettingsPatch": {
"properties": {
"brand": {
"$ref": "#/components/schemas/Brand",
"description": "品牌与外观配置"
},
"storage_root": {
"type": "string",
"title": "Storage Root",
"description": "服务器文件存储目录"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"brand",
"storage_root"
],
"title": "SettingsPatch"
},
"TaskDecision": {
"properties": {
"expected_version": {
"type": "integer",
"minimum": 1.0,
"title": "Expected Version",
"description": "当前对象版本,冲突拒绝"
},
"decision": {
"type": "string",
"enum": [
"APPROVE",
"REJECT"
],
"title": "Decision",
"description": "审批同意或拒绝"
},
"comment": {
"type": "string",
"maxLength": 1000,
"title": "Comment",
"default": "",
"description": "审批意见"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"expected_version",
"decision"
],
"title": "TaskDecision"
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"VersionCommand": {
"properties": {
"expected_version": {
"type": "integer",
"minimum": 1.0,
"title": "Expected Version",
"description": "当前对象版本,冲突拒绝"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"expected_version"
],
"title": "VersionCommand"
},
"wsea__connection__Command": {
"properties": {
"base_url": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"title": "Base Url",
"description": "已批准的平台HTTPS来源"
},
"client_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"title": "Client Id",
"description": "当前应用ID"
},
"expected_application_id": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"title": "Expected Application Id",
"description": "当前部署固定的应用ID"
},
"expected_revision": {
"type": "string",
"maxLength": 64,
"minLength": 64,
"title": "Expected Revision",
"description": "加密配置SHA256版本,用于并发保护"
},
"credential_request_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Credential Request Id",
"description": "服务器受保护凭据暂存请求编号"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"base_url",
"client_id",
"expected_application_id",
"expected_revision"
],
"title": "Command"
},
"wsea__directory_commands__Command": {
"properties": {
"operation": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"title": "Operation",
"description": "实际注册的维护操作"
},
"target_public_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Target Public Id",
"description": "目标稳定编号"
},
"expected_version": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Expected Version",
"description": "当前对象版本,冲突拒绝"
},
"values": {
"additionalProperties": true,
"type": "object",
"maxProperties": 12,
"title": "Values",
"description": "操作字段,按维护上下文返回的公开规范填写"
},
"selection": {
"anyOf": [
{
"$ref": "#/components/schemas/Selection"
},
{
"type": "null"
}
],
"description": "固定的组织选择及其版本"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"operation"
],
"title": "Command"
}
}