流程执行（WorkflowExecute）¶

用于对流程实例执行发起、提交、驳回、回撤、终止、挂起、协办、补签、删除等操作，以及自由流程的开启、提交、回退、归档等操作。

接口类型：REST 资源
基址：/api/rest/bpm/runtime
Tag：流程执行模块

公共说明¶

鉴权：所有端点均需在 query 中携带 accessToken（访问令牌）和 userCode（执行用户账号）。鉴权机制详见 ../index.md。
应用 ID 加密：applicationId 参数需经 **DES 加密**后以密文形式传入，服务端按当前执行用户解密（DesUtil.decryptTextByUserId）；请勿传明文 applicationId。
Document 请求体：除特别说明外，所有 POST 端点的 @RequestBody 均为 Document 包体（由 AbstractRESTController.parseDocument() 解析），结构如下：
```
{
  "id": "<文档Id，必填，不能为空>",
  "summary": "<摘要，可选>",
  "items": {
    "<字段名>": "<字段值>",
    "...": "..."
  }
}
```
id 缺失时返回 errcode=406「请求包体id属性不能为空」。
数组类请求体（非 Document）：
/remind body：JSON 字符串数组（催办内容）。
/assist/addition、/auditor、/approvers body：JSON 字符串数组（用户 id 列表，如 ["userId1","userId2"]）。
/submit body：Document + 额外 submitTo 数组。
响应：统一返回 Resource 结构（见 ../index.md「统一响应结构」）。多数端点 data 为 doc.getStateLabelInfo() 经 net.sf.json.JSONArray.fromObject(...) 转换得到的 JSON 数组（节点状态标签信息集合）。
状态码：所有端点成功返回 HTTP 200；业务错误通过 errcode 体现（错误码表见 ../index.md）。

1. 发起流程¶

启动并初始化一条新的流程实例。

接口类型：REST 资源
请求方式：POST
请求路径：/start（完整：/api/rest/bpm/runtime/start）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
flowId	query	string	是	流程定义模型Id
postBody	body	string(Document)	是	请求包体内容（Document JSON 字符串）

请求示例¶

POST /api/rest/bpm/runtime/start?accessToken=xxx&applicationId=xxx&userCode=admin&flowId=xxx HTTP/1.1
Content-Type: application/json

{
  "id": "__8Z4wBAAAAAC3Z6QAA",
  "summary": "差旅报销申请",
  "items": {
    "金额": "1200.00",
    "事由": "客户拜访"
  }
}

请求体¶

Document 结构，详见本页「公共说明 · Document 请求体」。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：JSONArray，文档的状态标签信息集合（doc.getStateLabelInfo()）。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": [
    { "nodeid": "node-start", "state": "running", "label": "开始" }
  ],
  "errors": null
}

失败示例：

{
  "errcode": 406,
  "errmsg": "请求包体id属性不能为空",
  "data": null,
  "errors": null
}

2. 提交流程¶

提交并审批流程（普通提交，不指定下一步审批人）。

接口类型：REST 资源
请求方式：POST
请求路径：/submission（完整：/api/rest/bpm/runtime/submission）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
flowType	query	string	是	流程类型（FlowType）
currNodeId	query	string	是	当前节点的节点定义对象Id
instanceId	query	string	是	流程实例Id
comment	query	string	否	审批意见
nextNodeIds	query	string[]	是	下一节点的节点定义对象Id集合（数组）
postBody	body	string(Document)	是	请求包体内容（Document JSON 字符串）

请求示例¶

POST /api/rest/bpm/runtime/submission?accessToken=xxx&applicationId=xxx&userCode=admin&flowType=normal&currNodeId=xxx&instanceId=xxx&nextNodeIds=node-a&nextNodeIds=node-b HTTP/1.1
Content-Type: application/json

{
  "id": "__8Z4wBAAAAAC3Z6QAA",
  "summary": "差旅报销申请",
  "items": {
    "金额": "1200.00"
  }
}

请求体¶

Document 结构，详见本页「公共说明 · Document 请求体」。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：JSONArray，文档的状态标签信息集合。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": [
    { "nodeid": "node-a", "state": "running", "label": "部门审批" }
  ],
  "errors": null
}

失败示例：

{
  "errcode": 50001,
  "errmsg": "流程异常：节点不存在",
  "data": null,
  "errors": null
}

3. 提交流程(可指定审批人)¶

提交并审批流程，可在包体中通过 submitTo[] 指定下一节点审批人。

接口类型：REST 资源
请求方式：POST
请求路径：/submit（完整：/api/rest/bpm/runtime/submit）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
flowType	query	string	是	流程类型（FlowType）
currNodeId	query	string	是	当前节点的节点定义对象Id
instanceId	query	string	是	流程实例Id
comment	query	string	否	审批意见
nextNodeIds	query	string[]	是	下一节点的节点定义对象Id集合（数组）
postBody	body	string(Document)	是	请求包体内容（Document JSON 字符串，需额外包含 `submitTo` 数组）

请求示例¶

POST /api/rest/bpm/runtime/submit?accessToken=xxx&applicationId=xxx&userCode=admin&flowType=normal&currNodeId=xxx&instanceId=xxx&nextNodeIds=node-a HTTP/1.1
Content-Type: application/json

{
  "id": "__8Z4wBAAAAAC3Z6QAA",
  "summary": "差旅报销申请",
  "items": {
    "金额": "1200.00"
  },
  "submitTo": [
    { "nodeid": "node-a", "userids": "u001;u002" }
  ]
}

请求体¶

在 Document 包体基础上，追加顶层 submitTo 数组，每项结构如下：

字段	类型	必填	说明
nodeid	string	是	目标节点定义对象Id
userids	string	是	该节点审批人用户 id，多个以 `;` 分隔（如 `"u001;u002"`）

说明：submitTo 缺失或为空时，接口直接返回 errcode=0、errmsg="error"、data="请在包体中指定审批人"；某项缺少 userids 时抛出运行时异常。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：JSONArray，文档的状态标签信息集合。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": [
    { "nodeid": "node-a", "state": "running", "label": "部门审批" }
  ],
  "errors": null
}

失败示例：

{
  "errcode": 0,
  "errmsg": "error",
  "data": "请在包体中指定审批人",
  "errors": null
}

4. 流程驳回¶

驳回当前流程到指定下一节点。

接口类型：REST 资源
请求方式：POST
请求路径：/back（完整：/api/rest/bpm/runtime/back）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
flowType	query	string	是	流程类型（FlowType）
currNodeId	query	string	是	当前节点的节点定义对象Id
instanceId	query	string	是	流程实例Id
comment	query	string	否	审批意见
nextNodeIds	query	string[]	是	下一节点的节点定义对象Id集合（数组）
flowId	query	string	是	流程定义Id
postBody	body	string(Document)	是	请求包体内容（Document JSON 字符串）

请求示例¶

POST /api/rest/bpm/runtime/back?accessToken=xxx&applicationId=xxx&userCode=admin&flowType=normal&currNodeId=xxx&instanceId=xxx&nextNodeIds=node-start&flowId=xxx HTTP/1.1
Content-Type: application/json

{
  "id": "__8Z4wBAAAAAC3Z6QAA",
  "summary": "差旅报销申请",
  "items": {
    "金额": "1200.00"
  }
}

请求体¶

Document 结构，详见本页「公共说明 · Document 请求体」。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：JSONArray，文档的状态标签信息集合。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": [
    { "nodeid": "node-start", "state": "running", "label": "开始" }
  ],
  "errors": null
}

失败示例：

{
  "errcode": 50001,
  "errmsg": "流程异常：驳回目标节点无效",
  "data": null,
  "errors": null
}

5. 催办流程¶

对当前流程实例进行催办，向待办人发送催办通知。

接口类型：REST 资源
请求方式：POST
请求路径：/remind（完整：/api/rest/bpm/runtime/remind）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
instanceId	query	string	是	流程实例Id
reminderContent	query	string	是	催办意见
content	body	string[]	是	催办内容（JSON 字符串数组）

请求示例¶

POST /api/rest/bpm/runtime/remind?accessToken=xxx&applicationId=xxx&userCode=admin&instanceId=xxx&reminderContent=请尽快处理 HTTP/1.1
Content-Type: application/json

[
  "请尽快审批",
  "客户拜访报销，请优先处理"
]

请求体¶

JSON 字符串数组，每项为一条催办内容文本。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：JSONArray，文档的状态标签信息集合。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": [
    { "nodeid": "node-a", "state": "running", "label": "部门审批" }
  ],
  "errors": null
}

失败示例：

{
  "errcode": 404,
  "errmsg": "流程实例不存在",
  "data": null,
  "errors": null
}

6. 回撤流程¶

将已提交的流程回撤到上一节点（撤回当前提交）。

接口类型：REST 资源
请求方式：POST
请求路径：/retracement（完整：/api/rest/bpm/runtime/retracement）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
instanceId	query	string	是	流程实例Id
postBody	body	string(Document)	是	请求包体内容（Document JSON 字符串）

请求示例¶

POST /api/rest/bpm/runtime/retracement?accessToken=xxx&applicationId=xxx&userCode=admin&instanceId=xxx HTTP/1.1
Content-Type: application/json

{
  "id": "__8Z4wBAAAAAC3Z6QAA",
  "summary": "差旅报销申请",
  "items": {
    "金额": "1200.00"
  }
}

请求体¶

Document 结构，详见本页「公共说明 · Document 请求体」。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：JSONArray，文档的状态标签信息集合。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": [
    { "nodeid": "node-start", "state": "running", "label": "开始" }
  ],
  "errors": null
}

失败示例：

{
  "errcode": 50001,
  "errmsg": "流程异常：当前节点不允许回撤",
  "data": null,
  "errors": null
}

7. 恢复流程¶

恢复已被挂起或终止的流程实例。

接口类型：REST 资源
请求方式：POST
请求路径：/recovery（完整：/api/rest/bpm/runtime/recovery）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
instanceId	query	string	是	流程实例Id
postBody	body	string(Document)	是	请求包体内容（Document JSON 字符串）

请求示例¶

POST /api/rest/bpm/runtime/recovery?accessToken=xxx&applicationId=xxx&userCode=admin&instanceId=xxx HTTP/1.1
Content-Type: application/json

{
  "id": "__8Z4wBAAAAAC3Z6QAA",
  "summary": "差旅报销申请",
  "items": {
    "金额": "1200.00"
  }
}

请求体¶

Document 结构，详见本页「公共说明 · Document 请求体」。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：JSONArray，文档的状态标签信息集合。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": [
    { "nodeid": "node-a", "state": "running", "label": "部门审批" }
  ],
  "errors": null
}

失败示例：

{
  "errcode": 50001,
  "errmsg": "流程异常：实例状态不允许恢复",
  "data": null,
  "errors": null
}

8. 终止流程¶

终止指定的流程实例。

接口类型：REST 资源
请求方式：POST
请求路径：/termination（完整：/api/rest/bpm/runtime/termination）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
instanceId	query	string	是	流程实例Id
postBody	body	string(Document)	是	请求包体内容（Document JSON 字符串）

请求示例¶

POST /api/rest/bpm/runtime/termination?accessToken=xxx&applicationId=xxx&userCode=admin&instanceId=xxx HTTP/1.1
Content-Type: application/json

{
  "id": "__8Z4wBAAAAAC3Z6QAA",
  "summary": "差旅报销申请",
  "items": {
    "金额": "1200.00"
  }
}

请求体¶

Document 结构，详见本页「公共说明 · Document 请求体」。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：JSONArray，文档的状态标签信息集合。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": [
    { "nodeid": "node-end", "state": "terminated", "label": "已终止" }
  ],
  "errors": null
}

失败示例：

{
  "errcode": 50001,
  "errmsg": "流程异常：实例已完成",
  "data": null,
  "errors": null
}

9. 挂起流程¶

挂起指定的流程实例，暂停后续流转。

接口类型：REST 资源
请求方式：POST
请求路径：/suspend（完整：/api/rest/bpm/runtime/suspend）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
instanceId	query	string	是	流程实例Id
postBody	body	string(Document)	是	请求包体内容（Document JSON 字符串）

请求示例¶

POST /api/rest/bpm/runtime/suspend?accessToken=xxx&applicationId=xxx&userCode=admin&instanceId=xxx HTTP/1.1
Content-Type: application/json

{
  "id": "__8Z4wBAAAAAC3Z6QAA",
  "summary": "差旅报销申请",
  "items": {
    "金额": "1200.00"
  }
}

请求体¶

Document 结构，详见本页「公共说明 · Document 请求体」。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：JSONArray，文档的状态标签信息集合。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": [
    { "nodeid": "node-a", "state": "suspended", "label": "已挂起" }
  ],
  "errors": null
}

失败示例：

{
  "errcode": 50001,
  "errmsg": "流程异常：实例已挂起",
  "data": null,
  "errors": null
}

10. 开启自由流程¶

为当前文档开启一条自由流程，并指定下一审批人。

接口类型：REST 资源
请求方式：POST
请求路径：/startFree（完整：/api/rest/bpm/runtime/startFree）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
comment	query	string	否	审批意见
nextUserCode	query	string	是	下个审批人的UserCode（账号）
postBody	body	string(Document)	是	请求包体内容（Document JSON 字符串）

请求示例¶

POST /api/rest/bpm/runtime/startFree?accessToken=xxx&applicationId=xxx&userCode=admin&nextUserCode=liwei HTTP/1.1
Content-Type: application/json

{
  "id": "__8Z4wBAAAAAC3Z6QAA",
  "summary": "差旅报销申请",
  "items": {
    "金额": "1200.00"
  }
}

请求体¶

Document 结构，详见本页「公共说明 · Document 请求体」。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：JSONArray，文档的状态标签信息集合。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": [
    { "nodeid": "free-node-1", "state": "running", "label": "审批中" }
  ],
  "errors": null
}

失败示例：

{
  "errcode": 50001,
  "errmsg": "流程异常：审批人账号不存在",
  "data": null,
  "errors": null
}

11. 提交自由流程¶

提交自由流程到下一审批人。

接口类型：REST 资源
请求方式：POST
请求路径：/submissionFree（完整：/api/rest/bpm/runtime/submissionFree）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
comment	query	string	否	审批意见
nextUserCode	query	string	是	下个审批人的UserCode（账号）
parentId	query	string	否	业务数据父文档Id
instanceId	query	string	是	流程实例Id
postBody	body	string(Document)	是	请求包体内容（Document JSON 字符串）

请求示例¶

POST /api/rest/bpm/runtime/submissionFree?accessToken=xxx&applicationId=xxx&userCode=admin&nextUserCode=liwei&instanceId=xxx HTTP/1.1
Content-Type: application/json

{
  "id": "__8Z4wBAAAAAC3Z6QAA",
  "summary": "差旅报销申请",
  "items": {
    "金额": "1200.00"
  }
}

请求体¶

Document 结构，详见本页「公共说明 · Document 请求体」。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：JSONArray，文档的状态标签信息集合。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": [
    { "nodeid": "free-node-2", "state": "running", "label": "审批中" }
  ],
  "errors": null
}

失败示例：

{
  "errcode": 50001,
  "errmsg": "流程异常：自由流程已结束",
  "data": null,
  "errors": null
}

12. 回退自由流程¶

回退自由流程到上一审批人。

接口类型：REST 资源
请求方式：POST
请求路径：/backFree（完整：/api/rest/bpm/runtime/backFree）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
comment	query	string	否	审批意见
nextUserId	query	string	是	下个审批人的用户Id
instanceId	query	string	是	流程实例Id
postBody	body	string(Document)	是	请求包体内容（Document JSON 字符串）

请求示例¶

POST /api/rest/bpm/runtime/backFree?accessToken=xxx&applicationId=xxx&userCode=admin&nextUserId=xxx&instanceId=xxx HTTP/1.1
Content-Type: application/json

{
  "id": "__8Z4wBAAAAAC3Z6QAA",
  "summary": "差旅报销申请",
  "items": {
    "金额": "1200.00"
  }
}

请求体¶

Document 结构，详见本页「公共说明 · Document 请求体」。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：JSONArray，文档的状态标签信息集合。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": [
    { "nodeid": "free-node-1", "state": "running", "label": "审批中" }
  ],
  "errors": null
}

失败示例：

{
  "errcode": 50001,
  "errmsg": "流程异常：无上一节点可回退",
  "data": null,
  "errors": null
}

13. 流程协办加签¶

为指定流程实例的当前节点动态加签协办人。

接口类型：REST 资源
请求方式：POST
请求路径：/assist/addition（完整：/api/rest/bpm/runtime/assist/addition）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
instanceId	query	string	是	流程实例Id
userIds	body	string[]	是	请求包体（用户id集合，JSON 字符串数组）

请求示例¶

POST /api/rest/bpm/runtime/assist/addition?accessToken=xxx&applicationId=xxx&userCode=admin&instanceId=xxx HTTP/1.1
Content-Type: application/json

[
  "__8Z4wBAAAAAC3Z6QAA",
  "__8Z4wBAAAAAC3Z6QAB"
]

请求体¶

JSON 字符串数组，每项为待加签的用户 id。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：string，加签操作的结果信息。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": "加签成功",
  "errors": null
}

失败示例：

{
  "errcode": 50001,
  "errmsg": "流程异常：用户不存在",
  "data": null,
  "errors": null
}

14. 流程协办¶

将当前流程实例协办给指定审批意见处理人（无需在 body 中传用户列表，由流程上下文确定）。

接口类型：REST 资源
请求方式：POST
请求路径：/assist（完整：/api/rest/bpm/runtime/assist）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
instanceId	query	string	是	流程实例Id
comment	query	string	是	审批意见

请求示例¶

POST /api/rest/bpm/runtime/assist?accessToken=xxx&applicationId=xxx&userCode=admin&instanceId=xxx&comment=请协助处理 HTTP/1.1

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：string，协办操作的结果信息。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": "协办成功",
  "errors": null
}

失败示例：

{
  "errcode": 50001,
  "errmsg": "流程异常：实例不存在",
  "data": null,
  "errors": null
}

15. 结束自由流程¶

结束（归档）自由流程实例。

接口类型：REST 资源
请求方式：POST
请求路径：/completeFree（完整：/api/rest/bpm/runtime/completeFree）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
comment	query	string	否	审批意见
instanceId	query	string	是	流程实例Id
postBody	body	string(Document)	是	请求包体内容（Document JSON 字符串）

请求示例¶

POST /api/rest/bpm/runtime/completeFree?accessToken=xxx&applicationId=xxx&userCode=admin&instanceId=xxx HTTP/1.1
Content-Type: application/json

{
  "id": "__8Z4wBAAAAAC3Z6QAA",
  "summary": "差旅报销申请",
  "items": {
    "金额": "1200.00"
  }
}

请求体¶

Document 结构，详见本页「公共说明 · Document 请求体」。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：JSONArray，文档的状态标签信息集合。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": [
    { "nodeid": "free-end", "state": "completed", "label": "已归档" }
  ],
  "errors": null
}

失败示例：

{
  "errcode": 50001,
  "errmsg": "流程异常：实例不在自由流程中",
  "data": null,
  "errors": null
}

16. 更改审批人¶

更改指定流程实例当前节点的审批人。

接口类型：REST 资源
请求方式：POST
请求路径：/auditor（完整：/api/rest/bpm/runtime/auditor）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
instanceId	query	string	是	流程实例Id
userIds	body	string[]	是	请求包体（审批人用户id集合，JSON 字符串数组）

请求示例¶

POST /api/rest/bpm/runtime/auditor?accessToken=xxx&applicationId=xxx&userCode=admin&instanceId=xxx HTTP/1.1
Content-Type: application/json

[
  "__8Z4wBAAAAAC3Z6QAA",
  "__8Z4wBAAAAAC3Z6QAB"
]

请求体¶

JSON 字符串数组，每项为新审批人用户 id。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：JSONArray，文档的状态标签信息集合。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": [
    { "nodeid": "node-a", "state": "running", "label": "部门审批" }
  ],
  "errors": null
}

失败示例：

{
  "errcode": 50001,
  "errmsg": "流程异常：审批人列表为空",
  "data": null,
  "errors": null
}

17. 编辑当前节点审批人¶

编辑（覆盖）当前节点审批人列表。

接口类型：REST 资源
请求方式：POST
请求路径：/approvers（完整：/api/rest/bpm/runtime/approvers）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
instanceId	query	string	是	流程实例Id
userIds	body	string[]	是	请求包体（审批人用户id集合，JSON 字符串数组）

请求示例¶

POST /api/rest/bpm/runtime/approvers?accessToken=xxx&applicationId=xxx&userCode=admin&instanceId=xxx HTTP/1.1
Content-Type: application/json

[
  "__8Z4wBAAAAAC3Z6QAA",
  "__8Z4wBAAAAAC3Z6QAB"
]

请求体¶

JSON 字符串数组，每项为编辑后的审批人用户 id。

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：JSONArray，文档的状态标签信息集合。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": [
    { "nodeid": "node-a", "state": "running", "label": "部门审批" }
  ],
  "errors": null
}

失败示例：

{
  "errcode": 50001,
  "errmsg": "流程异常：实例不存在",
  "data": null,
  "errors": null
}

18. 添加/补签意见¶

对指定流程实例追加补签意见（不改变流程流转状态）。

接口类型：REST 资源
请求方式：POST
请求路径：/supplement（完整：/api/rest/bpm/runtime/supplement）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
userCode	query	string	是	用户编码（用户账号）
instanceId	query	string	是	流程实例Id
content	query	string	是	补签意见内容

请求示例¶

POST /api/rest/bpm/runtime/supplement?accessToken=xxx&applicationId=xxx&userCode=admin&instanceId=xxx&content=补充意见：同意 HTTP/1.1

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：string，补签操作的结果信息。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": "补签成功",
  "errors": null
}

失败示例：

{
  "errcode": 50001,
  "errmsg": "流程异常：实例不存在",
  "data": null,
  "errors": null
}

19. 删除流程¶

删除指定的流程实例（按文档Id）。

接口类型：REST 资源
请求方式：GET
请求路径：/delete（完整：/api/rest/bpm/runtime/delete）
鉴权：是（需 accessToken）
Tag：流程执行模块

请求参数¶

参数名	位置	类型	必填	说明
accessToken	query	string	是	访问令牌
applicationId	query	string	是	应用Id（DES 加密密文）
docId	query	string	是	文档Id

请求示例¶

GET /api/rest/bpm/runtime/delete?accessToken=xxx&applicationId=xxx&docId=xxx HTTP/1.1

响应¶

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：string，固定为 "删除成功"。

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": "删除成功",
  "errors": null
}

失败示例：

{
  "errcode": 404,
  "errmsg": "文档不存在",
  "data": null,
  "errors": null
}