客户端调用流程引擎接口

注意：目前仅适用于【宜兴市政企通】项目

domain说明

序号 系统 环境 地址 备注
1 宜兴政企通 测试 https://test-admin-console.app.zqtong.com/tng-boot 适用【宜兴政企通】

流程启动类接口明细

序号 接口详情 地址
1.1 发起流程（带表单） {domain}/a1bpmn/api/runtime/instance/v2/start
1.2 发起流程（不带表单） {domain}/a1bpmn/api/runtime/instance/v3/start
1.3 查看某个流程（流程图） {domain}/a1bpmn/api/model/get/{modelId}
1.4 获取办理按钮的列表 {domain}/
1.5 获取流程表单的数据接口 {domain}/

流程任务查询接口明细

序号 接口详情 地址
2.0 查看流程模型 {domain}/a1bpmn/api/models/listJson
2.1 待办 {domain}/a1bpmn/api/runtime/task/v2/list/
2.2 已办 {domain}/a1bpmn/api/history/task/v2/list/
2.3 我的转办 {domain}/
2.4 转办给我 {domain}/
2.5 已延时 {domain}/
2.6 我发起的流程（所有流程，可根据状态查询） {domain}/a1bpmn/api/startUp/list/{status}
2.7 我结办的流程（完成的流程） {domain}/a1bpmn/api/startUp/his/list
2.9 抄送我的（已读） {domain}/a1bpmn/api/commu/his/list
2.10 抄送我的（未读） {domain}/a1bpmn/api/commu/list
2.11 流程预测（查看下个节点的办理人） {domain}/a1bpmn/api/cockpit/process-instance/getNextNode/{taskId}
2.12 根据流程实例ID查询流程状态 {domain}/a1bpmn/api/runtime/instance/v1/getInstanceList

流程办理类接口明细

序号 接口详情 地址
3.1 办理（完成流程） {domain}/a1bpmn/api/runtime/task/v2/complete
3.2 抄送（传阅） {domain}/a1bpmn/api/cockpit/process-instance/informed/{taskId}
3.3 转办 {domain}/
3.4 特事特办 {domain}/
3.5 退回 {domain}/
3.6 会签通过 {domain}/
3.7 会签拒绝 {domain}/
3.8 作废（拒绝，不通过，普通节点） {domain}/a1bpmn/api/history/task/v1/invalid
3.9 流程图（意见和悬浮） {domain}/a1bpmn/api/runtime/hisInstance/v1/nodeOpinion?instId={instId}
3.10 添加临时节点 {domain}/
3.11 加签 {domain}/
3.12 抄送已读（未读变成已读） {domain}/a1bpmn/api/commu/tagReadTimeAllNotification
3.13 撤销流程（取回流程，撤销到发起人） {domain}/a1bpmn/api/cockpit/task/v1/changeActivityState

接口: 1.1 发起流程（带表单）

  • 请求URL

    {domain}/a1bpmn/api/runtime/instance/v2/start

  • 请求方式

    POST

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/x-www-form-urlencoded application/x-www-form-urlencoded 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
defId 流程定义 ID String XXX 是
modelId 模型 ID Long XXX 是
typeTitle 分类标题 String XXX 否
formData 表单数据 String XXX 否
userId 启动人 id String XXX 是
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}
参数 描述
userId 用户id

接口: 1.2 发起流程（不带表单）

  • 请求URL

    {domain}/a1bpmn/api/runtime/instance/v3/start

  • 请求方式

    POST

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/x-www-form-urlencoded application/x-www-form-urlencoded 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
defId 流程定义 ID String XXX 是
modelId 模型 ID Long XXX 是
typeTitle 分类标题 String XXX 否
formData 表单数据 String XXX 否
bizKey 业务key，可用于扩展 String XXX 否
userId 启动人 id String XXX 是
username 启动人姓名 String XXX 是
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}

接口: 1.3 查看流程某个（流程图）

  • 请求URL

    {domain}/a1bpmn/api/model/get/{modelId}

  • 请求方式

    GET

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/json application/json 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
modelId 模型 ID Long XXX 是
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}

接口: 2.0 查看流程模型

  • 请求URL

    {domain}/a1bpmn/api/models/listJson

  • 请求方式

    GET

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/json application/json 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
limit 每页的数据 int XXX 否
page 当前的页码 int XXX 否
type 类型 int XXX 是，固定2
modelKey 模型key String XXX 是
status 0-未发布，1-已发布 String XXX 否
main 传入任意值主版本-即当前最新的版本，不传所有版本 String XXX 否
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {
  }
}

接口: 2.1 待办

  • 请求URL

    {domain}/a1bpmn/api/runtime/task/v2/list/

  • 请求方式

    POST

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/json application/json 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
limit 每页的数据 int XXX 否
page 当前的页码 int XXX 否
userId 启动人 id String XXX 是
typeKey 流程分类（可查询某个具体分类下数据） String XXX 否
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {
    "suspensionState": 1, 
    "": 
  }
}

接口: 2.2 已办

  • 请求URL

    {domain}/a1bpmn/api/history/task/v2/list/

  • 请求方式

    POST

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/json application/json 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
limit 每页的数据 int XXX 否
page 当前的页码 int XXX 否
userId 启动人 id String XXX 是
typeKey 流程分类（可查询某个具体分类下数据） String XXX 否
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}

接口: 2.6 我发起的流程（所有流程，可根据状态查询）

  • 请求URL

    {domain}/a1bpmn/api/startUp/list/{status}

  • 请求方式

    POST

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/x-www-form-urlencoded application/x-www-form-urlencoded 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
limit 每页的数据 int XXX 否
page 当前的页码 int XXX 否
userId 启动人 id String XXX 是
status 路径参数（可选项，all-所有,invalid-作废（不通过）,running-正在运行,completed-完成（通过）） String XXX 是
typeKey 流程分类（可查询某个具体分类下数据） String XXX 否
procDefId 流程定义id String XXX 否
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}

接口: 2.7 我结办的流程（完成的流程）

  • 请求URL

    {domain}/a1bpmn/api/startUp/his/list

  • 请求方式

    POST

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/x-www-form-urlencoded application/x-www-form-urlencoded 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
limit 每页的数据 int XXX 否
page 当前的页码 int XXX 否
userId 启动人 id String XXX 是
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}

接口: 2.9 抄送我的（已读）

  • 请求URL

    {domain}/a1bpmn/api/commu/his/list

  • 请求方式

    POST

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/x-www-form-urlencoded application/x-www-form-urlencoded 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
limit 每页的数据 int XXX 否
page 当前的页码 int XXX 否
userId 启动人 id String XXX 是
typeKey 流程分类（可查询某个具体分类下数据） String XXX 否
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}

接口: 2.10 抄送我的（未读）

  • 请求URL

    {domain}/a1bpmn/api/commu/list

  • 请求方式

    POST

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/x-www-form-urlencoded application/x-www-form-urlencoded 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
limit 每页的数据 int XXX 否
page 当前的页码 int XXX 否
userId 启动人 id String XXX 是
typeKey 流程分类（可查询某个具体分类下数据） String XXX 否
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}

接口: 2.11 流程预测（查看下个节点的办理人）

  • 请求URL

    {domain}/a1bpmn/api/cockpit/process-instance/getNextNode/{taskId}

  • 请求方式

    GET

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/x-www-form-urlencoded application/x-www-form-urlencoded 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
taskId 任务id String XXX 是
userId 当前用户id String XXX 否
username 当前用户姓名 String XXX 否
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}

接口: 2.12 根据流程实例ID查询流程状态

  • 请求URL

    {domain}/a1bpmn/api/runtime/instance/v1/getInstanceList

  • 请求方式

    POST

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/x-www-form-urlencoded application/x-www-form-urlencoded 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
procId 流程实例id String XXX 是
page 页码 Number XXX 否
limit 每页数量 Number XXX 否
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}

接口: 3.1 办理（完成流程）

  • 请求URL

    {domain}/a1bpmn/api/runtime/task/v2/complete

  • 请求方式

    POST

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/x-www-form-urlencoded application/x-www-form-urlencoded 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
taskId 任务 id String XXX 是
userId 用户 id String XXX 是
username 用户姓名 String XXX 是
actionName 操作动作 String XXX 否
opinion 审核意见 String XXX 否
priority 优先级 int XXX 否
taskTitle 任务标题 String XXX 否
chooseNode 用于跳转任意节点，多个，分割 String XXX 否
chooseNodeUser 跳转节点 名称，多个，分割 String XXX 否
formData 表单数据 String XXX 否
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}

接口: 3.2 抄送（传阅）

  • 请求URL

    {domain}/a1bpmn/api/cockpit/process-instance/informed/{taskId}

  • 请求方式

    POST

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/x-www-form-urlencoded application/x-www-form-urlencoded 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
taskId 任务 id String XXX 是
currentUserId 当前传阅人id String XXX 是
currentUsername 当前传阅人姓名 String XXX 是
userId 需要传阅人id的集合 String[] XXX 是
userName 需要传阅人姓名的集合 String[] XXX 是
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}

接口: 3.8 作废（拒绝，不通过普通节点）

  • 请求URL

    {domain}/a1bpmn/api/history/task/v1/invalid

  • 请求方式

    POST

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/x-www-form-urlencoded application/x-www-form-urlencoded 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
taskId 流程实例 id String XXX 是
userId 办理人 id String XXX 是
username 办理人姓名 String XXX 是
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}

接口: 3.9 流程图（意见和悬浮）

  • 请求URL

    {domain}/a1bpmn/api/runtime/hisInstance/v1/nodeOpinion?instId={instId}

  • 请求方式

    GET

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/json application/json 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
instId 流程实例 id String XXX 是
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}

接口: 3.12 抄送已读

  • 请求URL

    {domain}/a1bpmn/api/commu/tagReadTimeAllNotification

  • 请求方式

    POST

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/json application/json 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
userId 用户id String XXX 是
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}

接口: 3.13 撤销流程（取回流程，撤销到发起人）

  • 请求URL

    {domain}/a1bpmn/api/cockpit/task/v1/changeActivityState

  • 请求方式

    POST

  • 请求Header参数 >

key value 举例 是否必须
Content-Type application/x-www-form-urlencoded application/x-www-form-urlencoded 是
  • 请求Query参数
参数 描述 格式 举例 是否必须
limit 每页的数据 int XXX 否
page 当前的页码 int XXX 否
userId 启动人 id String XXX 是
  • 返回

返回成功

{
  "status": 200,
  "msg": "success",
  "data": {}
}
江苏卓易信息科技股份有限公司-TNG基础平台组 all right reserved，powered by Gitbook该文件最后修改时间： 2021-01-27 06:23:28

results matching ""

    No results matching ""