zhongyouweb/docs/api/modules/19-flow-instance.md

工作流流程实例管理

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

快速索引

接口名称	方法	路径	用途
删除流程实例	DELETE	/gd_dataserver/flowable/instance/delete/{instanceIds}	-
根据流程定义id启动流程实例	POST	/gd_dataserver/flowable/instance/startBy/{procDefId}	-
结束流程实例	POST	/gd_dataserver/flowable/instance/stopProcessInstance	-
激活或挂起流程实例	POST	/gd_dataserver/flowable/instance/updateState	-

接口详情

删除流程实例

• 用途： 接口文档未提供用途说明。
• 请求： DELETE /gd_dataserver/flowable/instance/delete/{instanceIds}
• 鉴权： X-Access-Token（以接口定义为准）
• operationId： deleteUsingDELETE_1

参数：

字段	位置	必填	类型	说明	示例
instanceIds	path	是	string	流程实例ID	-
deleteReason	query	否	string	删除原因	-

响应：

状态码	说明	响应模型
200	OK	/: object<string, object>
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

根据流程定义id启动流程实例

• 用途： 接口文档未提供用途说明。
• 请求： POST /gd_dataserver/flowable/instance/startBy/{procDefId}
• 鉴权： X-Access-Token（以接口定义为准）
• operationId： startByIdUsingPOST

参数：

字段	位置	必填	类型	说明	示例
procDefId	path	是	string	流程定义id	-

请求体：

• Content-Type：application/json
• 模型：object
• 必填：文档未标记

响应：

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

结束流程实例

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

参数：

无

请求体：

• 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/instance/updateState
• 鉴权： X-Access-Token（以接口定义为准）
• operationId： updateStateUsingPOST

参数：

字段	位置	必填	类型	说明	示例
state	query	是	integer / int32	1:激活,2:挂起	-
instanceId	query	是	string	流程实例ID	-

响应：

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