105 lines
2.6 KiB
Markdown
105 lines
2.6 KiB
Markdown
|
# API 文档 - 流程提交
|
|||
|
|
|
|||
|
|
## 元数据
|
|||
|
|
- 需求编号：001
|
|||
|
|
- 子需求编号：001-01
|
|||
|
|
- 接口编号：003
|
|||
|
|
- 创建时间：2026-02-02
|
|||
|
|
- 创建人：AI Assistant
|
|||
|
|
- 状态：已完成
|
|||
|
|
|
|||
|
|
## 接口概述
|
|||
|
|
将 Salesforce 记录提交到审批流程进行审批。
|
|||
|
|
|
|||
|
|
## 基本信息
|
|||
|
|
|
|||
|
|
- **功能描述**：提交记录到审批流程
|
|||
|
|
- **请求方式**：POST
|
|||
|
|
- **请求路径**：`/partner/advanced/process-submit-request`
|
|||
|
|
- **权限要求**：`@PreAuthorize("@ss.hasPermi('partner:advanced:processSubmit')")`
|
|||
|
|
|
|||
|
|
## 请求参数
|
|||
|
|
|
|||
|
|
### 请求体（JSON）
|
|||
|
|
|
|||
|
|
| 参数名 | 类型 | 必填 | 说明 | 示例值 |
|
|||
|
|
|--------|------|------|------|--------|
|
|||
|
|
| objectId | String | 是 | 对象 ID | 001xx0000001Gw2EAA |
|
|||
|
|
| comments | String | 否 | 评论（可选） | 请审批此记录 |
|
|||
|
|
|
|||
|
|
### 请求示例
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"objectId": "001xx0000001Gw2EAA",
|
|||
|
|
"comments": "请审批此记录，所有信息已核对无误"
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 响应参数
|
|||
|
|
|
|||
|
|
| 参数名 | 类型 | 说明 |
|
|||
|
|
|--------|------|------|
|
|||
|
|
| code | Integer | 状态码（200 成功，其他失败） |
|
|||
|
|
| msg | String | 提示信息 |
|
|||
|
|
| data | Object | 响应数据 |
|
|||
|
|
| data.processInstanceId | String | 流程实例 ID |
|
|||
|
|
| data.success | Boolean | 是否成功 |
|
|||
|
|
| data.errors | Array | 错误信息列表 |
|
|||
|
|
|
|||
|
|
### 成功响应示例
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"code": 200,
|
|||
|
|
"msg": "操作成功",
|
|||
|
|
"data": {
|
|||
|
|
"processInstanceId": "04gxx0000001Gw2EAA",
|
|||
|
|
"success": true,
|
|||
|
|
"errors": null
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 失败响应示例
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"code": 500,
|
|||
|
|
"msg": "流程提交失败",
|
|||
|
|
"data": {
|
|||
|
|
"processInstanceId": null,
|
|||
|
|
"success": false,
|
|||
|
|
"errors": [
|
|||
|
|
{
|
|||
|
|
"statusCode": "NO_APPLICABLE_PROCESS",
|
|||
|
|
"message": "No applicable approval process found for this record"
|
|||
|
|
}
|
|||
|
|
]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 错误码
|
|||
|
|
|
|||
|
|
| 错误码 | 说明 | 处理建议 |
|
|||
|
|
|--------|------|----------|
|
|||
|
|
| 200 | 操作成功 | - |
|
|||
|
|
| 400 | 请求参数错误 | 检查请求参数格式和必填项 |
|
|||
|
|
| 401 | 未登录或登录已过期 | 请重新登录 |
|
|||
|
|
| 403 | 无权限访问 | 请检查用户权限 |
|
|||
|
|
| 500 | 服务器内部错误 | 请联系管理员或稍后重试 |
|
|||
|
|
|
|||
|
|
## 注意事项
|
|||
|
|
|
|||
|
|
1. 记录必须配置了审批流程才能提交
|
|||
|
|
2. 用户必须有提交审批的权限
|
|||
|
|
3. 一条记录只能同时处于一个审批流程中
|
|||
|
|
4. 提交后，记录会被锁定，直到审批完成或被拒绝
|
|||
|
|
5. 可以通过 processInstanceId 查询审批进度
|
|||
|
|
|
|||
|
|
## 相关文档
|
|||
|
|
- [需求文档](../../requirements/2026-01-28-001-PartnerAPI源org实现.md)
|
|||
|
|
- [设计文档](../../design/2026-01-29-001-01-认证和会话管理-设计.md)
|
|||
|
|
- [决策记录](../../decisions/2026-01-29-001-01-ADR-认证和会话管理技术选型.md)
|