流程动作 API

工作流应用提供启动、流转、回退、终止、加签、暂停、唤醒、特送、转发和重新启动等动作的 API 接口。

除了提供 API,工作流也提供了 Java SDK 和 JS SDK

相关的API中status参数的说明可以参考任务 API中"相关API中任务状态参数值说明"

启动并流转查询

  • 请求地址: /wf/biz/process/startAdvanceQuery
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
process String 流程编码
attributes JSONObject 流程实例信息,具体参考任务定义,其中最核心的sData1表示流程实例关联的业务数据主键
executor String 执行者
creator String 创建者
vars JSONObject 流程变量
  • 返回结果: 流程控制信息
  • 案例
{
  "attributes": {
    "sData1": "CA6B389AD6E00001C6D46936E4701B11"
  },
  "process": "order",
  "executor": "",
  "creator": "",
  "vars": {}
}

启动并流转

  • 请求地址: /wf/biz/process/startAdvance
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
process String 流程编码
attributes JSONObject 流程实例信息,具体参考任务定义,其中最核心的sData1表示流程实例关联的业务数据主键
executor String 执行者
creator String 创建者
vars JSONObject 流程变量
control ProcessControl 流程控制信息
  • 返回结果: 流程控制信息
  • 案例
{
  "attributes": {
    "sData1": "CA6B389AD6E00001C6D46936E4701B11"
  },
  "process": "order",
  "executor": "",
  "creator": "",
  "vars": {},
  "control": null
}

启动流程

  • 请求地址:/wf/biz/process/start
  • 请求方式:POST
  • 输入参数
参数名称 必选 类型 描述
process String 流程编码
attributes JSONObject 流程实例信息,具体参考任务定义,其中最核心的 sData1 表示流程实例关联的业务数据主键
executor String 执行者
creator String 创建者
vars JSONObject 流程变量
  • 返回结果:待办任务和流程实例信息
[{
    "process": "/SA/wf/default/order",
    "task": "20781B12FD024FDDACA98C97A35A8386",
    "activity": "businessActivity1",
    "pi": "C53281A07E504E3DBDF3238EDD6AF6BF"
},{
    "pi": "C53281A07E504E3DBDF3238EDD6AF6BF"
}]
  • 案例
{
  "attributes": {
    "sData1": "CA6B389AD6E00001C6D46936E4701B11"
  },
  "process": "order",
  "executor": "",
  "creator": "",
  "vars": {}
}

流转查询

  • 请求地址:/wf/biz/process/advanceQuery
  • 请求方式:POST
  • 输入参数
参数名称 必选 类型 描述
task String 任务标识
vars JSONObject 任务变量
  • 返回结果:流程控制信息
  • 案例
{
  "task": "xxx"
}

流转

  • 请求地址:/wf/biz/process/advance
  • 请求方式:POST
  • 输入参数
参数名称 必选 类型 描述
task String 任务标识
control ProcessControl 流程控制信息
vars JSONObject 任务变量
tasks String 同一批流转的任务标识
  • 返回结果:待办任务和流程实例信息
  • 案例
{
  "task": "xxx"
}

回退查询

  • 请求地址:/wf/biz/process/backQuery
  • 请求方式:POST
  • 输入参数
参数名称 必选 类型 描述
task String 任务标识
backRange String 回退范围,取值范围:首环节(start), 所有环节(all),前序任务(prev-task),前序环节(prev-activity),首环节或前序环节(start-or-prev-activity),默认和前序任务一样(default)。默认值是 default
vars JSONObject 任务变量
  • 返回结果:流程控制信息
  • 案例
{
  "task": "xxx"
}

回退

  • 请求地址:/wf/biz/process/back
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
control ProcessControl 流程控制信息
vars JSONObject 任务变量
  • 返回结果:待办任务和流程实例信息
  • 案例
{
  "task": "xxx"
}

终止查询

  • 请求地址: /wf/biz/process/abortQuery
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
vars JSONObject 任务变量
  • 返回结果: 流程控制信息
  • 案例
{
  "task": "xxx"
}

终止

  • 请求地址: /wf/biz/process/abort
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
control ProcessControl 流程控制信息
vars JSONObject 任务变量
  • 返回结果: 无
  • 案例
{
  "task": "xxx"
}

加签查询

  • 请求地址: /wf/biz/process/addSignQuery
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
vars JSONObject 任务变量
  • 返回结果: 流程控制信息
  • 案例
{
  "task": "xxx"
}

加签

  • 请求地址: /wf/biz/process/addSign
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
control ProcessControl 流程控制信息
vars JSONObject 任务变量
tasks String 同一批加签的任务标识
  • 返回结果: 待办任务和流程实例信息
  • 案例
{
  "task": "xxx"
}

暂停查询

  • 请求地址: /wf/biz/process/suspendQuery
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
vars JSONObject 任务变量
  • 返回结果: 流程控制信息
  • 案例
{
  "task": "xxx"
}

暂停

  • 请求地址: /wf/biz/process/suspend
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
control ProcessControl 流程控制信息
vars JSONObject 任务变量
  • 返回结果: 无
  • 案例
{
  "task": "xxx"
}

转发查询

  • 请求地址: /wf/biz/process/transferQuery
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
vars JSONObject 任务变量
  • 返回结果: 流程控制信息
  • 案例
{
  "task": "xxx"
}

转发

  • 请求地址: /wf/biz/process/transfer
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
control ProcessControl 流程控制信息
vars JSONObject 任务变量
  • 返回结果: 无
  • 案例
{
  "task": "xxx"
}

特送查询

  • 请求地址: /wf/biz/process/specialQuery
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
vars JSONObject 任务变量
  • 返回结果: 流程控制信息
  • 案例
{
  "task": "xxx"
}

特送

  • 请求地址: /wf/biz/process/special
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
control ProcessControl 流程控制信息
vars JSONObject 任务变量
  • 返回结果: 无
  • 案例
{
  "task": "xxx"
}

重启查询

  • 请求地址: /wf/biz/process/restartQuery
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
vars JSONObject 任务变量
mode String 重启模式,取值范围: 最后环节的执行者才能重启(lastActivityExecutor),任意环节的任务都能重启(default)
  • 返回结果: 流程控制信息
  • 案例
{
  "task": "xxx"
}

重启

  • 请求地址: /wf/biz/process/restart
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
control ProcessControl 流程控制信息
vars JSONObject 任务变量
mode String 重启模式,取值范围: 最后环节的执行者才能重启(lastActivityExecutor),任意环节的任务都能重启(default)
  • 返回结果: 无
  • 案例
{
  "task": "xxx"
}

唤醒

  • 请求地址: /wf/biz/process/resume
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
vars JSONObject 任务变量
  • 返回结果: 无
  • 案例
{
  "task": "xxx"
}

结束任务

  • 请求地址: /wf/biz/process/task/finish
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
  • 返回结果: 无

是否允许修改执行者

  • 请求地址: /wf/biz/process/canModifyExecutor
  • 请求方式:GET
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
  • 返回结果: Boolean

修改执行者

  • 请求地址: /wf/biz/process/modifyExecutor
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
fid String 组织标识全路径
check Boolean 是否检查任务是自己的且是活动的,默认值是true
  • 返回结果: 无

回收任务

  • 请求地址: /wf/biz/process/withdrawTask
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
vars JSONObject 任务变量
  • 返回结果: 无

删除流程实例

  • 请求地址: /wf/biz/process/pi
  • 请求方式:DELETE
  • 输入参数:
参数名称 必选 类型 描述
pi String 流程实例标识
task String 任务标识
data String 业务数据标识
process String 流程标识
checkOwner Boolean 检查流程实例的创建者是自己,默认值是true
force Boolean 强制删除
  • 返回结果: 无

修改流程实例的流程版本号

  • 请求地址: /wf/biz/process/pi/version
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
pi String 流程实例标识,多值,使用","分隔
version String 流程版本号
{
    "pi": "a,b",
    "version": "xxx"
}
  • 返回结果: 无

查询流程变量

  • 请求地址: /wf/biz/process/pi/variable
  • 请求方式:GET
  • 输入参数:
参数名称 必选 类型 描述
task String 流程实例标识
process String 流程编码
  • 返回结果: JSONObject

更新流程变量

  • 请求地址: /wf/biz/process/pi/variable
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 流程实例标识
vars JSONObject 流程变量
  • 返回结果: JSONObject

查询任务变量

  • 请求地址: /wf/biz/process/task/variable
  • 请求方式:GET
  • 输入参数:
参数名称 必选 类型 描述
task String 任务标识
process String 流程编码
  • 返回结果: JSONObject

更新任务变量

  • 请求地址: /wf/biz/process/task/variable
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 流程实例标识
vars JSONObject 任务变量
  • 返回结果: JSONObject

查询当前流程设置信息

  • 请求地址: /wf/biz/process/settingQuery
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
task String 流程实例标识
process String 流程编码
vars JSONObject 任务变量
attributes JSONObject 流程实例信息,具体参考任务定义,其中最核心的 sData1 表示流程实例关联的业务数据主键
  • 返回结果: 流程控制信息

根据流程实例查询任务

  • 请求地址: /wf/biz/process/queryTaskByPI
  • 请求方式:GET
  • 输入参数:
参数名称 必选 类型 描述
flow String 流程实例标识
columns String 返回的列
status String 任务状态,取值范围["waiting"、 "finished"、 "submited"],默认值"waiting";允许多值,使用 , 分隔
filter String 过虑条件,例如SA_Task.sName='xx'
  • 返回结果: 任务列表

根据业务数据查询任务

  • 请求地址: /wf/biz/process/queryTaskByData
  • 请求方式:GET
  • 输入参数:
参数名称 必选 类型 描述
sData1 String 业务数据标识
columns String 返回的列
process String 流程编码
status String 任务状态,取值范围["waiting"、 "finished"、 "submited"],默认值"waiting";允许多值,使用 , 分隔
filter String 过虑条件,例如SA_Task.sName='xx'
  • 返回结果: 任务列表

根据业务数据查询流程实例

  • 请求地址: /wf/biz/process/queryPIByData
  • 请求方式:GET
  • 输入参数:
参数名称 必选 类型 描述
sData1 String 业务数据标识
columns String 返回的列
process String 流程编码
status String 任务状态,取值范围["waiting"、 "finished"、 "submited"],默认值"waiting";允许多值,使用 , 分隔
filter String 过虑条件,例如SA_Task.sName='xx'
  • 返回结果: 流程实例列表

查询流程记录

  • 请求地址: /wf/biz/process/record
  • 请求方式:GET
  • 输入参数:
参数名称 必选 类型 描述
filter String 过滤条件,例如 SA_Task.sName='张三' AND SA_Task.sProcess='xx'
offset Int 偏移量,默认值是0
limit Int 分页大小,默认值20,-1表示所有数据
distinct Boolean 去除重复行,默认值false
columns String 返回列,默认所有列
orderBy String 排序方式,例如 sName DESC,sProcess ASC
variabels JSONObject 变量
shardCondition String 流程记录分表信息,格式为data=xx,task=xx,process=xx
  • 返回结果: 任务列表

任务备份

  • 请求地址: /wf/biz/process/task/backup
  • 请求方式:POST
  • 输入参数: 无
  • 返回结果: 无

任务从备份还原

  • 请求地址: /wf/biz/process/task/reset
  • 请求方式:POST
  • 输入参数: 无
  • 返回结果: 无

任务归档

  • 请求地址: /wf/biz/process/task/archive
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
begin Date 开始日期
end Date 结束日期
  • 返回结果: 无

设置流程定义的主版本

  • 请求地址: /wf/biz/process/updateProcessMainVersion
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
process String 流程编码
mainVersion String 版本号
  • 返回结果: 无

发布指定的流程草稿

  • 请求地址: /wf/biz/process/publishProcessById
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
ids String 流程草稿标识,多值使用","分隔
  • 返回结果: 无

设置流程定义的拥有者

  • 请求地址: /wf/biz/process/updateProcessOwner
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
process String 流程编码
fid String 组织标识全路径
fname String 组织名称全路径
  • 返回结果: 无

查询流程定义

  • 请求地址: /wf/biz/process
  • 请求方式:GET
  • 输入参数:
参数名称 必选 类型 描述
filter String 过滤条件,例如 SA_Process.sIsDefaultVersion=1 AND SA_Process.sProcessName='xx'
offset Int 偏移量,默认值是0
limit Int 分页大小,默认值20,-1表示所有数据
distinct Boolean 去除重复行,默认值false
columns String 返回列,默认所有列
orderBy String 排序方式,例如 sProcessName DESC,sProcess ASC
variabels JSONObject 变量,例如 {"justep.shard": "histroy"}
  • 返回结果:

    • 返回头
      Content-Type: application/json
      Content-Range: 分页信息,例如0-19/100
    
    • 返回体: 列信息请参考流程定义
    [{
      "id": "主键",
      "sProcess": "编码", 
      ...
    }]
    

新建流程定义

  • 请求地址: /wf/biz/process
  • 请求方式:PUT
  • 输入参数:
参数名称 必选 类型 描述
请求体 JSONArray 流程定义信息,列信息请参考流程定义
[{
    "id": "主键",
    "sProcess": "编码", 
    ...
}]
  • 返回结果: Int

更新流程定义

  • 请求地址: /wf/biz/process
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
请求体 JSONArray 流程定义信息列表,列信息请参考流程定义,其中version必须指定
[{
    "id": "主键",
    "sProcess": "编码", 
    ...
}]
  • 返回结果: Int

删除流程定义

  • 请求地址: /wf/biz/process
  • 请求方式:DELETE
  • 输入参数:
参数名称 必选 类型 描述
id String 流程定义标识
filter String 过滤条件,例如 SA_Process.sIsDefaultVersion=1 AND SA_Process.sProcessName='xx'
  • 返回结果: Int

查询流程配置

  • 请求地址: /wf/biz/process/config
  • 请求方式:GET
  • 输入参数:
参数名称 必选 类型 描述
filter String 过滤条件,例如 SA_ProcessConfig.sName='流程配置' AND SA_ProcessConfig.sCode='xx'
offset Int 偏移量,默认值是0
limit Int 分页大小,默认值20,-1表示所有数据
distinct Boolean 去除重复行,默认值false
columns String 返回列,默认所有列
orderBy String 排序方式,例如 sName DESC,sCode ASC
variabels JSONObject 变量,例如 {"justep.shard": "histroy"}
  • 返回结果:

    • 返回头
      Content-Type: application/json
      Content-Range: 分页信息,例如0-19/100
    
    • 返回体: 列信息请参考流程配置
    [{
      "id": "主键",
      "sName": "名称", 
      ...
    }]
    

新建流程配置

  • 请求地址: /wf/biz/process/config
  • 请求方式:PUT
  • 输入参数:
参数名称 必选 类型 描述
请求体 JSONArray 流程配置信息,列信息请参考流程配置
[{
    "id": "主键",
    "sName": "名称", 
    ...
}]
  • 返回结果: Int

更新流程配置

  • 请求地址: /wf/biz/process/config
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
请求体 JSONArray 流程配置信息列表,列信息请参考流程配置,其中version必须指定
[{
    "id": "主键",
    "sName": "名称", 
    ...
}]
  • 返回结果: Int

删除流程配置

  • 请求地址: /wf/biz/process/config
  • 请求方式:DELETE
  • 输入参数:
参数名称 必选 类型 描述
id String 流程配置标识
filter String 过滤条件,例如 SA_ProcessConfig.sName='流程配置' AND SA_ProcessConfig.sCode='xx'
  • 返回结果: Int

查询流程函数

  • 请求地址: /wf/biz/process/fn
  • 请求方式:GET
  • 输入参数:
参数名称 必选 类型 描述
filter String 过滤条件,例如 SA_ProcessFn.sName='xxx' AND SA_ProcessFn.sType='xx'
offset Int 偏移量,默认值是0
limit Int 分页大小,默认值20,-1表示所有数据
distinct Boolean 去除重复行,默认值false
columns String 返回列,默认所有列
orderBy String 排序方式,例如 sName DESC,sCreateTime ASC
variabels JSONObject 变量,例如 {"justep.shard": "histroy"}
  • 返回结果:

    • 返回头
      Content-Type: application/json
      Content-Range: 分页信息,例如0-19/100
    
    • 返回体: 列信息请参考流程配置
    [{
      "id": "主键",
      "sName": "名称", 
      ...
    }]
    

新建流程函数

  • 请求地址: /wf/biz/process/fn
  • 请求方式:PUT
  • 输入参数:
参数名称 必选 类型 描述
请求体 JSONArray 流程函数信息,列信息请参考流程函数
[{
    "id": "主键",
    "sName": "名称", 
    ...
}]
  • 返回结果: Int

更新流程函数

  • 请求地址: /wf/biz/process/fn
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
请求体 JSONArray 流程函数信息列表,列信息请参考流程函数,其中version必须指定
[{
    "id": "主键",
    "sName": "名称", 
    ...
}]
  • 返回结果: Int

删除流程函数

  • 请求地址: /wf/biz/process/fn
  • 请求方式:DELETE
  • 输入参数:
参数名称 必选 类型 描述
id String 流程函数标识
filter String 过滤条件,例如 SA_ProcessFn.sName='xxx' AND SA_ProcessFn.sType='xx'
  • 返回结果: Int

修改流程实例的流程版本

  • 请求地址: /wf/biz/process/pi/version
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
pi String 流程实例标识
version String 流程版本号
  • 返回结果: 无

获取流程子管理员所管理的组织

  • 请求地址: /wf/biz/process/queryManagedOrgByProcessSubAdmin
  • 请求方式:GET
  • 输入参数: 无
  • 返回结果:
  {
    "组织1的FID": "组织1的FName",
    "组织2的FID": "组织2的FName",
  }

查询服务定义

  • 请求地址: /wf/biz/process/serviceDefine
  • 请求方式:GET
  • 输入参数:
参数名称 必选 类型 描述
filter String 过滤条件,例如 SA_ServiceDefine.sName='xxx'
offset Int 偏移量,默认值是0
limit Int 分页大小,默认值20,-1表示所有数据
distinct Boolean 去除重复行,默认值false
columns String 返回列,默认所有列
orderBy String 排序方式,例如 sName DESC,sCreateTime ASC
variabels JSONObject 变量,例如 {"justep.shard": "histroy"}
  • 返回结果:

    • 返回头
      Content-Type: application/json
      Content-Range: 分页信息,例如0-19/100
    
    • 返回体: 列信息请参考服务定义配置
    [{
      "id": "主键",
      "sName": "名称", 
      ...
    }]
    

新建服务定义

  • 请求地址: /wf/biz/process/serviceDefine
  • 请求方式:PUT
  • 输入参数:
参数名称 必选 类型 描述
请求体 JSONArray 服务定义列表,列信息请参考服务定义
[{
    "id": "主键",
    "sName": "名称", 
    ...
}]
  • 返回结果: Int

更新服务定义

  • 请求地址: /wf/biz/process/serviceDefine
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
请求体 JSONArray 服务定义列表,列信息请参考服务定义,其中version必须指定
[{
    "id": "主键",
    "sName": "名称", 
    ...
}]
  • 返回结果: Int

删除服务定义

  • 请求地址: /wf/biz/process/serviceDefine
  • 请求方式:DELETE
  • 输入参数:
参数名称 必选 类型 描述
id String 流程函数标识
filter String 过滤条件,例如 SA_ServiceDefine.sName='xxx'
  • 返回结果: Int

导出服务定义

  • 请求地址: /wf/x5/UI2/SA/wf/service/exportServiceDefine.j
  • 请求方式:GET
  • 输入参数:
参数名称 必选 类型 描述
ids String 服务定义标识
search String 查询条件,将会使用sName和sCode做like
  • 返回结果: 服务定义文件

查询流程模型

  • 请求地址: /wf/biz/process/define
  • 请求方式:GET
  • 输入参数:
参数名称 必选 类型 描述
id String 主键
code String 流程编码,id和code两者必须有一个
version Integer 版本号,1表示主版本,-1表示草稿,默认是1
  • 返回结果: 流程模型
[{
  id: "",
  process: "",
  name: "",
  version: "",
  content: {
    start: "",
    end: "",
    activities: [{
      name: "",
      label: "",
      activityType: "",  
      /*范围:
          place, and-activity, auto-activity, condition-activity, if-else-activity, service-activity,   
          business-activity, sub-process-activity, static-activity
      */
      prev: [""],
      next: [""],
      trueNext: "", //if-else-activity特有
      falseNext: "", //if-else-activity特有
      requests: "", //service-activity特有
      async: false, //service-activity, sub-process-activity特有
      retryCount: 0, //service-activity特有
      subProcess: "", //sub-process-activity特有
      subProcessLabel: "", //sub-process-activity特有
      subProcessExpr: "", //sub-process-activity特有
      businessKey: "", //sub-process-activity特有
      businessKeyLabel: "", //sub-process-activity特有
      businessLabel: "", //sub-process-activity特有
      businessLabelLabel: "", //sub-process-activity特有
      autoAdvance: false, //sub-process-activity特有
      startMode: false, //sub-process-activity特有

    }]
  }
}]

导入服务定义

  • 请求地址: /wf/x5/UI2/SA/wf/service/importServiceDefine.j
  • 请求方式:POST
  • 输入参数:
参数名称 必选 类型 描述
process String /SA/wf/manager/managerProcess
activity String make
action String importServiceDefineAction
define File 服务定义文件
  • 返回结果: 无

results matching ""

    No results matching ""