dujiabo
/
zhongyouweb
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
15 Commits
1 Branch
0 Tags
4.4 MiB
 
 
 
 
Tree: 1b9570aff9
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '1b9570aff9'
${ noResults }
zhongyouweb/docs/api/modules/18-flow-task.md

29 KiB
Raw Blame History

工作流流程任务管理

本模块共 23 个接口。源文件：api.json。

快速索引

接口名称 方法 路径 用途
多实例加签 POST /gd_dataserver/flowable/task/addMultiInstanceExecution -
转办任务 POST /gd_dataserver/flowable/task/assignTask -
认领/签收任务 POST /gd_dataserver/flowable/task/claim -
审批任务 POST /gd_dataserver/flowable/task/complete -
委派任务 POST /gd_dataserver/flowable/task/delegateTask -
删除任务 POST /gd_dataserver/flowable/task/delete -
清空任务 GET /gd_dataserver/flowable/task/deleteAll -
多实例减签 POST /gd_dataserver/flowable/task/deleteMultiInstanceExecution -
获取已办任务 GET /gd_dataserver/flowable/task/finishedList -
流程初始化表单 GET /gd_dataserver/flowable/task/flowFormData -
流程历史流转记录 GET /gd_dataserver/flowable/task/flowRecord -
我发起的流程 GET /gd_dataserver/flowable/task/myProcess -
获取下一节点 POST /gd_dataserver/flowable/task/nextFlowNode -
流程发起时获取下一节点 POST /gd_dataserver/flowable/task/nextFlowNodeByStart -
获取流程变量 GET /gd_dataserver/flowable/task/processVariables/{taskId} -
驳回任务 POST /gd_dataserver/flowable/task/reject -
任务归还 POST /gd_dataserver/flowable/task/resolveTask -
退回任务 POST /gd_dataserver/flowable/task/return -
获取所有可回退的节点 POST /gd_dataserver/flowable/task/returnList -
撤回流程 POST /gd_dataserver/flowable/task/revokeProcess -
取消申请 POST /gd_dataserver/flowable/task/stopProcess -
获取待办列表 GET /gd_dataserver/flowable/task/todoList -
取消认领/签收任务 POST /gd_dataserver/flowable/task/unClaim -

接口详情

多实例加签

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/addMultiInstanceExecution
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： addMultiInstanceExecutionUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

转办任务

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/assignTask
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： assignUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

认领/签收任务

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/claim
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： claimUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

审批任务

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/complete
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： completeUsingPOST_1

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

委派任务

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/delegateTask
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： delegateUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

删除任务

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/delete
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

清空任务

  • 用途： 接口文档未提供用途说明。
  • 请求： GET /gd_dataserver/flowable/task/deleteAll
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteAllUsingGET

参数：

无

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

多实例减签

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/deleteMultiInstanceExecution
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteMultiInstanceExecutionUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

获取已办任务

  • 用途： 接口文档未提供用途说明。
  • 请求： GET /gd_dataserver/flowable/task/finishedList
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： finishedListUsingGET

参数：

字段 位置 必填 类型 说明 示例
businessId query 否 string 业务id -
businessType query 否 string 业务类型 -
endTime query 否 string 结束时间 -
name query 否 string 流程名称 -
pageNum query 否 integer / int32 当前页码 -
pageSize query 否 integer / int32 每页条数 -
procInsId query 否 string 流程编码 -
startTime query 否 string 开始时间 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

流程初始化表单

  • 用途： 接口文档未提供用途说明。
  • 请求： GET /gd_dataserver/flowable/task/flowFormData
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： flowFormDataUsingGET

参数：

字段 位置 必填 类型 说明 示例
deployId query 否 string deployId -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

流程历史流转记录

  • 用途： 接口文档未提供用途说明。
  • 请求： GET /gd_dataserver/flowable/task/flowRecord
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： flowRecordUsingGET

参数：

字段 位置 必填 类型 说明 示例
procInsId query 否 string procInsId -
deployId query 否 string deployId -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

我发起的流程

  • 用途： 接口文档未提供用途说明。
  • 请求： GET /gd_dataserver/flowable/task/myProcess
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： myProcessUsingGET

参数：

字段 位置 必填 类型 说明 示例
businessId query 否 string 业务id -
businessType query 否 string 业务类型 -
endTime query 否 string 结束时间 -
name query 否 string 流程名称 -
pageNum query 否 integer / int32 当前页码 -
pageSize query 否 integer / int32 每页条数 -
procInsId query 否 string 流程编码 -
startTime query 否 string 开始时间 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

获取下一节点

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/nextFlowNode
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getNextFlowNodeUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

流程发起时获取下一节点

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/nextFlowNodeByStart
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getNextFlowNodeByStartUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

获取流程变量

  • 用途： 接口文档未提供用途说明。
  • 请求： GET /gd_dataserver/flowable/task/processVariables/{taskId}
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： processVariablesUsingGET

参数：

字段 位置 必填 类型 说明 示例
taskId path 是 string 流程任务Id -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

驳回任务

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/reject
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： taskRejectUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

任务归还

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/resolveTask
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： resolveTaskUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

退回任务

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/return
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： taskReturnUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

获取所有可回退的节点

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/returnList
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： findReturnTaskListUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

撤回流程

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/revokeProcess
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： revokeProcessUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

取消申请

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/stopProcess
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： stopProcessUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

获取待办列表

  • 用途： 接口文档未提供用途说明。
  • 请求： GET /gd_dataserver/flowable/task/todoList
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： todoListUsingGET

参数：

字段 位置 必填 类型 说明 示例
businessId query 否 string 业务id -
businessType query 否 string 业务类型 -
endTime query 否 string 结束时间 -
name query 否 string 流程名称 -
pageNum query 否 integer / int32 当前页码 -
pageSize query 否 integer / int32 每页条数 -
procInsId query 否 string 流程编码 -
startTime query 否 string 开始时间 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

取消认领/签收任务

  • 用途： 接口文档未提供用途说明。
  • 请求： POST /gd_dataserver/flowable/task/unClaim
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： unClaimUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：工作流任务相关--请求参数
  • 必填：文档未标记
字段 必填 类型 说明 示例
assignee 否 string 审批人 -
candidateGroups 否 array 审批组 -
candidateUsers 否 array 候选人 -
comment 否 string 任务意见 -
currentChildExecutionId 否 string 子执行流ID -
defId 否 string 流程环节定义ID -
deploymentId 否 string - -
flag 否 boolean 子执行流是否已执行 false
instanceId 否 string 流程实例Id -
result 否 string 任务审批结果 1-同意 2-退回 -
targetKey 否 string 节点 -
taskId 否 string 任务Id -
userId 否 string 用户Id -
variables 否 object 流程变量信息 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -