# lwc-cloud-workflow API 接口文档

- 文档标题：OpenAPI definition
- 版本：v0
- 描述：
- 数据来源：https://api.leadwaycloud.com/lwc-cloud-workflow/v3/api-docs
- 生成时间：2026-08-03T22:00:20.839Z
- 接口数量：42
- 分组数量：5
- 模型数量：38

## 服务地址

| 地址 | 说明 |
| --- | --- |
| http://172.18.85.151:11416/lwc-cloud-workflow | Generated server url |

## 接口目录

### 任务管理

- [POST /task/updateFile - 节点修改附件](#post-task-updatefile-updatefile)
- [POST /task/complete - 完成](#post-task-complete-completeusertask)
- [POST /task/backUserTask - 驳回（到前节点）](#post-task-backusertask-backusertask)

### 模型管理

- [POST /model/update - 编辑流程定义模型](#post-model-update-update)
- [POST /model/delete - 删除流程定义模型(仅能删除未部署状态)](#post-model-delete-delete)
- [POST /model/addUpdateLabel - 新增修改标签配置](#post-model-addupdatelabel-addupdatelabel)
- [POST /model/addOrCopy - 新增（升版） 流程定义模型](#post-model-addorcopy-addorcopy)
- [GET /model/pendingModel - 挂起/启用模型版本](#get-model-pendingmodel-pendingmodel)
- [GET /model/list - 流程定义模型列表](#get-model-list-getmodellist)
- [GET /model/getLabel - 获取标签配置](#get-model-getlabel-getlabel)
- [GET /model/getAvailableModelFlag - 获取流程模型是否存在](#get-model-getavailablemodelflag-getavailablemodelflag)
- [GET /model/deploy - 部署模型（modelId）](#get-model-deploy-deploymodel)

### 实例管理

- [POST /instance/wh/getIInitiateInstance - 获取 我发起的流程-wh](#post-instance-wh-getiinitiateinstance-getwhiinitiateinstance)
- [POST /instance/wh/getIApprovalInstance - 获取 我审批的流程-wh](#post-instance-wh-getiapprovalinstance-getwhiapprovalinstance)
- [POST /instance/updateResult - 修改审批结果](#post-instance-updateresult-updateresult)
- [POST /instance/updateParallelAssignee/{instanceId} - 修改并行节点审批人分组数据](#post-instance-updateparallelassignee-instanceid-updateparallelassignee)
- [POST /instance/updateInstanceData - 修改流程数据(全局变量)-仅审批中流程可修改](#post-instance-updateinstancedata-updateinstancedata)
- [POST /instance/testMq - mq消息队列](#post-instance-testmq-testmq)
- [POST /instance/termination - 终止流程实例](#post-instance-termination-termination)
- [POST /instance/start - 发起审批](#post-instance-start-start)
- [POST /instance/getParallelAssignee - 查看并行节点审批人分组数据](#post-instance-getparallelassignee-getparallelassignee)
- [POST /instance/getIInitiateInstance - 获取 我发起的流程](#post-instance-getiinitiateinstance-getiinitiateinstance)
- [POST /instance/getIApprovalInstance - 获取 我审批的流程](#post-instance-getiapprovalinstance-getiapprovalinstance)
- [POST /instance/details - 审批详情-批量](#post-instance-details-details)
- [GET /instance/task - 审批详情-节点](#get-instance-task-task)
- [GET /instance/list - 流程实例列表](#get-instance-list-list)
- [GET /instance/getResult - 获取审批结果](#get-instance-getresult-getresult)
- [GET /instance/detail - 审批详情](#get-instance-detail-detail)
- [GET /instance/deleteInstance - 删除 流程实例+流程数据](#get-instance-deleteinstance-deleteinstance)

### 流程相关信息查询

- [POST /info/feedbackUsRoDeOt - 回显审批用户](#post-info-feedbackusrodeot-feedbackusrodeot)
- [POST /info/buildUserTask - 获取台账导出用户任务数据](#post-info-buildusertask-buildusertask)
- [POST /info/buildUserTaskCommon - 获取审批节点数据-通用](#post-info-buildusertaskcommon-buildusertaskcommon)
- [GET /info/vagueUsRoDeOt - 模糊搜索流程用户角色部门其他](#get-info-vagueusrodeot-vagueusrodeot)
- [GET /info/getUserAndRole - 获取流程用户角色部门](#get-info-getuserandrole-getuserandrole)
- [GET /info/getRemark - 获取节点审批备注(最新的)](#get-info-getremark-getremark)
- [GET /info/getModelVersion - 获取版本号](#get-info-getmodelversion-getmodelversion)
- [GET /info/getAllUserByBusinessId - 获取节点选择的用户信息byBusinessId](#get-info-getalluserbybusinessid-getalluserbybusinessid)
- [GET /info/deleteCancelNcr - 删除当前已作废的ncr流程数据（保留ncr业务表数据）](#get-info-deletecancelncr-deletecancelncr)

### bpm业务类型

- [POST /businessType/update - 编辑业务类型](#post-businesstype-update-update-1)
- [POST /businessType/delete - 删除业务类型](#post-businesstype-delete-delete-1)
- [POST /businessType/add - 新增业务类型](#post-businesstype-add-add)
- [GET /businessType/list - bpm业务类型列表](#get-businesstype-list-getbusinesstypelist)


## 接口详情

<a id="post-task-updatefile-updatefile"></a>

### POST /task/updateFile

- 分组：任务管理
- 名称：节点修改附件
- OperationId：updateFile

#### 调用方法

`POST /task/updateFile`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：FileDto（FileDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| taskId | string | 否 | 任务id |  |
| fileUrlList | object[] | 否 | 文件List |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-task-complete-completeusertask"></a>

### POST /task/complete

- 分组：任务管理
- 名称：完成
- OperationId：completeUserTask

#### 调用方法

`POST /task/complete`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：CompleteTaskDto（CompleteTaskDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| taskId | string | 是 | 任务id |  |
| pass | boolean | 是 | 是否通过 |  |
| customTaskApproverList | TaskApproveDto[] | 否 | 后续节点审批人 |  |
| parallelAssigneeList | WkTaskInstanceRef[] | 否 | 并行节点审批人分组数据 |  |
| approveData | object | 否 | 审批数据 |  |
| reStartBusinessData | object | 否 | 重新审批选择的业务数据 |  |
| submitBy | string | 是 | 提交人 |  |
| callBackExec | boolean | 否 | 是否回调, 默认true |  |
| messageExec | boolean | 否 | 是否发送消息, 默认true |  |
| httpExec | boolean | 否 | 是否http请求, 默认true |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-task-backusertask-backusertask"></a>

### POST /task/backUserTask

- 分组：任务管理
- 名称：驳回（到前节点）
- OperationId：backUserTask

#### 调用方法

`POST /task/backUserTask`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：BackNodeDto（BackNodeDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| curTaskId | string | 是 | 当前节点id |  |
| targetTaskKey | string | 是 | 目标节点id |  |
| approveData | object | 否 | 审批数据 |  |
| submitBy | string | 是 | 提交人 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-model-update-update"></a>

### POST /model/update

- 分组：模型管理
- 名称：编辑流程定义模型
- OperationId：update

#### 调用方法

`POST /model/update`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：BpmModelDto（BpmModelDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | modelId |  |
| businessTypeId | integer(int64) | 是 | 业务类型id |  |
| modelXml | string | 否 | 流程定义XML |  |
| userId | string | 是 | 用户id |  |
| taskCustomName | string | 否 | 节点自定义名称 |  |
| wkTaskModelRefDtoList | WkTaskModelRefDto[] | 否 | 节点 <-> 用户 关系数据 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-model-delete-delete"></a>

### POST /model/delete

- 分组：模型管理
- 名称：删除流程定义模型(仅能删除未部署状态)
- OperationId：delete

#### 调用方法

`POST /model/delete`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：integer(int64)[]

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | integer(int64)[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-model-addupdatelabel-addupdatelabel"></a>

### POST /model/addUpdateLabel

- 分组：模型管理
- 名称：新增修改标签配置
- OperationId：addUpdateLabel

#### 调用方法

`POST /model/addUpdateLabel`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：WkLabel[]（WkLabel）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | WkLabel[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-model-addorcopy-addorcopy"></a>

### POST /model/addOrCopy

- 分组：模型管理
- 名称：新增（升版） 流程定义模型
- OperationId：addOrCopy

#### 调用方法

`POST /model/addOrCopy`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：BpmModelDto（BpmModelDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | modelId |  |
| businessTypeId | integer(int64) | 是 | 业务类型id |  |
| modelXml | string | 否 | 流程定义XML |  |
| userId | string | 是 | 用户id |  |
| taskCustomName | string | 否 | 节点自定义名称 |  |
| wkTaskModelRefDtoList | WkTaskModelRefDto[] | 否 | 节点 <-> 用户 关系数据 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="get-model-pendingmodel-pendingmodel"></a>

### GET /model/pendingModel

- 分组：模型管理
- 名称：挂起/启用模型版本
- OperationId：pendingModel

#### 调用方法

`GET /model/pendingModel`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer(int64) | 模型id |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="get-model-list-getmodellist"></a>

### GET /model/list

- 分组：模型管理
- 名称：流程定义模型列表
- OperationId：getModelList

#### 调用方法

`GET /model/list`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| businessTypeId | query | 否 | integer(int64) | 业务类型id |  |
| businessTypeKey | query | 否 | string | 业务类型key |  |
| modelVersion | query | 否 | integer(int32) | 模型版本 |  |
| newestVersion | query | 否 | boolean | 是否最新的版本 |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultListBpmModelVo（ResultListBpmModelVo）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | BpmModelVo[] | 否 | 响应数据 |  |

<a id="get-model-getlabel-getlabel"></a>

### GET /model/getLabel

- 分组：模型管理
- 名称：获取标签配置
- OperationId：getLabel

#### 调用方法

`GET /model/getLabel`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| label | query | 否 | string | 标签名 |  |
| merchantId | query | 是 | integer(int64) | 商户id |  |
| companyId | query | 否 | integer(int64) | 公司id |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="get-model-getavailablemodelflag-getavailablemodelflag"></a>

### GET /model/getAvailableModelFlag

- 分组：模型管理
- 名称：获取流程模型是否存在
- OperationId：getAvailableModelFlag

#### 调用方法

`GET /model/getAvailableModelFlag`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| businessTypeKey | query | 是 | string | 业务类型key |  |
| merchantId | query | 是 | integer(int64) | 商户id |  |
| companyId | query | 是 | integer(int64) | 公司id |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="get-model-deploy-deploymodel"></a>

### GET /model/deploy

- 分组：模型管理
- 名称：部署模型（modelId）
- OperationId：deployModel

#### 调用方法

`GET /model/deploy`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer(int64) | 模型id |  |
| userId | query | 是 | string | 操作用户id |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-instance-wh-getiinitiateinstance-getwhiinitiateinstance"></a>

### POST /instance/wh/getIInitiateInstance

- 分组：实例管理
- 名称：获取 我发起的流程-wh
- OperationId：getWhIInitiateInstance

#### 调用方法

`POST /instance/wh/getIInitiateInstance`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：VagueDto（VagueDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessTypeKey | string | 否 | 业务类型key |  |
| startTime | string(date-time) | 否 | 发起时间 |  |
| endTime | string(date-time) | 否 | 结束时间 |  |
| page | integer(int32) | 否 | 当前页 |  |
| pageSize | integer(int32) | 否 | 每页数量 |  |
| keywords | string | 否 | 关键字 |  |
| state | string | 否 | 状态 |  |
| userId | string | 是 | 当前操作用户id |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultPageVoIInitiateData（ResultPageVoIInitiateData）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | PageVoIInitiateData | 否 | 响应数据 |  |

<a id="post-instance-wh-getiapprovalinstance-getwhiapprovalinstance"></a>

### POST /instance/wh/getIApprovalInstance

- 分组：实例管理
- 名称：获取 我审批的流程-wh
- OperationId：getWhIApprovalInstance

#### 调用方法

`POST /instance/wh/getIApprovalInstance`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：VagueDto（VagueDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessTypeKey | string | 否 | 业务类型key |  |
| startTime | string(date-time) | 否 | 发起时间 |  |
| endTime | string(date-time) | 否 | 结束时间 |  |
| page | integer(int32) | 否 | 当前页 |  |
| pageSize | integer(int32) | 否 | 每页数量 |  |
| keywords | string | 否 | 关键字 |  |
| state | string | 否 | 状态 |  |
| userId | string | 是 | 当前操作用户id |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultPageVoIApprovalData（ResultPageVoIApprovalData）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | PageVoIApprovalData | 否 | 响应数据 |  |

<a id="post-instance-updateresult-updateresult"></a>

### POST /instance/updateResult

- 分组：实例管理
- 名称：修改审批结果
- OperationId：updateResult

#### 调用方法

`POST /instance/updateResult`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：DisposalResultsDto（DisposalResultsDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| instanceId | string | 否 | 实例id |  |
| disposalResultsJson | object | 否 | 结果json |  |
| newFlag | boolean | 否 | 是否是新流程 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-instance-updateparallelassignee-instanceid-updateparallelassignee"></a>

### POST /instance/updateParallelAssignee/{instanceId}

- 分组：实例管理
- 名称：修改并行节点审批人分组数据
- OperationId：updateParallelAssignee

#### 调用方法

`POST /instance/updateParallelAssignee/{instanceId}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| instanceId | path | 是 | string |  |  |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：WkTaskInstanceRef[]（WkTaskInstanceRef）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | WkTaskInstanceRef[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-instance-updateinstancedata-updateinstancedata"></a>

### POST /instance/updateInstanceData

- 分组：实例管理
- 名称：修改流程数据(全局变量)-仅审批中流程可修改
- OperationId：updateInstanceData

#### 调用方法

`POST /instance/updateInstanceData`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：UpdateInstanceDataDto（UpdateInstanceDataDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessTypeKey | string | 否 | 业务类型key |  |
| list | UpdateDto[] | 否 | 业务数据 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-instance-testmq-testmq"></a>

### POST /instance/testMq

- 分组：实例管理
- 名称：mq消息队列
- OperationId：testMq

#### 调用方法

`POST /instance/testMq`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：object

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-instance-termination-termination"></a>

### POST /instance/termination

- 分组：实例管理
- 名称：终止流程实例
- OperationId：termination

#### 调用方法

`POST /instance/termination`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：TerminationDto（TerminationDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessTypeKey | string | 否 | 业务类型key |  |
| businessId | string | 是 | 业务id |  |
| userId | string | 是 | 当前操作用户id |  |
| terminationRemark | string | 否 | 终止原因 |  |
| callBackExec | boolean | 否 | 是否回调, 默认true |  |
| messageExec | boolean | 否 | 是否发送消息, 默认true |  |
| httpExec | boolean | 否 | 是否http请求, 默认true |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-instance-start-start"></a>

### POST /instance/start

- 分组：实例管理
- 名称：发起审批
- OperationId：start

#### 调用方法

`POST /instance/start`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：InstanceDto（InstanceDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessTypeKey | string | 是 | 业务类型key |  |
| businessId | string | 是 | 业务id |  |
| customTaskApproverList | TaskApproveDto[] | 否 | 后续节点审批人 |  |
| parallelAssigneeList | WkTaskInstanceRef[] | 否 | 单节点并行审批人分组数据 |  |
| businessData | object | 否 | 审批业务数据 |  |
| merchantId | integer(int64) | 是 | 商户 |  |
| companyId | integer(int64) | 是 | 公司 |  |
| createBy | string | 是 | 创建人 |  |
| modelVersion | integer(int32) | 否 | 选择发起版本 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-instance-getparallelassignee-getparallelassignee"></a>

### POST /instance/getParallelAssignee

- 分组：实例管理
- 名称：查看并行节点审批人分组数据
- OperationId：getParallelAssignee

#### 调用方法

`POST /instance/getParallelAssignee`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| businessTypeKey | query | 是 | string |  |  |
| businessId | query | 否 | string |  |  |
| merchantId | query | 是 | integer(int64) |  |  |
| companyId | query | 否 | integer(int64) |  |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-instance-getiinitiateinstance-getiinitiateinstance"></a>

### POST /instance/getIInitiateInstance

- 分组：实例管理
- 名称：获取 我发起的流程
- OperationId：getIInitiateInstance

#### 调用方法

`POST /instance/getIInitiateInstance`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：VagueDto（VagueDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessTypeKey | string | 否 | 业务类型key |  |
| startTime | string(date-time) | 否 | 发起时间 |  |
| endTime | string(date-time) | 否 | 结束时间 |  |
| page | integer(int32) | 否 | 当前页 |  |
| pageSize | integer(int32) | 否 | 每页数量 |  |
| keywords | string | 否 | 关键字 |  |
| state | string | 否 | 状态 |  |
| userId | string | 是 | 当前操作用户id |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultPageVoIInitiateData（ResultPageVoIInitiateData）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | PageVoIInitiateData | 否 | 响应数据 |  |

<a id="post-instance-getiapprovalinstance-getiapprovalinstance"></a>

### POST /instance/getIApprovalInstance

- 分组：实例管理
- 名称：获取 我审批的流程
- OperationId：getIApprovalInstance

#### 调用方法

`POST /instance/getIApprovalInstance`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：VagueDto（VagueDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessTypeKey | string | 否 | 业务类型key |  |
| startTime | string(date-time) | 否 | 发起时间 |  |
| endTime | string(date-time) | 否 | 结束时间 |  |
| page | integer(int32) | 否 | 当前页 |  |
| pageSize | integer(int32) | 否 | 每页数量 |  |
| keywords | string | 否 | 关键字 |  |
| state | string | 否 | 状态 |  |
| userId | string | 是 | 当前操作用户id |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultPageVoIApprovalData（ResultPageVoIApprovalData）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | PageVoIApprovalData | 否 | 响应数据 |  |

<a id="post-instance-details-details"></a>

### POST /instance/details

- 分组：实例管理
- 名称：审批详情-批量
- OperationId：details

#### 调用方法

`POST /instance/details`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：DetailsDto[]（DetailsDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | DetailsDto[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="get-instance-task-task"></a>

### GET /instance/task

- 分组：实例管理
- 名称：审批详情-节点
- OperationId：task

#### 调用方法

`GET /instance/task`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| businessId | query | 是 | string | 业务id |  |
| businessTypeKey | query | 是 | string | 业务类型key |  |
| approveType | query | 是 | string | 查询节点审批状态 approving,done,all |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="get-instance-list-list"></a>

### GET /instance/list

- 分组：实例管理
- 名称：流程实例列表
- OperationId：list

#### 调用方法

`GET /instance/list`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| businessTypeKey | query | 是 | string | 业务流程key |  |
| checkMap | query | 否 | object | 模糊查询- 变量名+变量值Map |  |
| pageSize | query | 是 | integer(int32) |  |  |
| page | query | 是 | integer(int32) |  |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultPageVoBpmInstanceDataVo（ResultPageVoBpmInstanceDataVo）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | PageVoBpmInstanceDataVo | 否 | 响应数据 |  |

<a id="get-instance-getresult-getresult"></a>

### GET /instance/getResult

- 分组：实例管理
- 名称：获取审批结果
- OperationId：getResult

#### 调用方法

`GET /instance/getResult`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| instanceId | query | 是 | string |  |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="get-instance-detail-detail"></a>

### GET /instance/detail

- 分组：实例管理
- 名称：审批详情
- OperationId：detail

#### 调用方法

`GET /instance/detail`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| businessId | query | 是 | string | 业务id |  |
| businessTypeKey | query | 是 | string | 业务类型key |  |
| more | query | 否 | boolean | 是否查询更多, 默认false |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="get-instance-deleteinstance-deleteinstance"></a>

### GET /instance/deleteInstance

- 分组：实例管理
- 名称：删除 流程实例+流程数据
- OperationId：deleteInstance

#### 调用方法

`GET /instance/deleteInstance`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| instanceIdList | query | 是 | string[] |  |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-info-feedbackusrodeot-feedbackusrodeot"></a>

### POST /info/feedbackUsRoDeOt

- 分组：流程相关信息查询
- 名称：回显审批用户
- OperationId：feedbackUsRoDeOt

#### 调用方法

`POST /info/feedbackUsRoDeOt`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：UsRoDeOtDto（UsRoDeOtDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| loginUserId | integer(int64) | 是 | 当前登录用户id |  |
| userIdList | integer(int64)[] | 否 | 需要查询的用户id |  |
| roleIdList | integer(int64)[] | 否 | 需要查询的角色id |  |
| departmentIdList | integer(int64)[] | 否 | 需要查询的部门id |  |
| roleTemplateIdList | integer(int64)[] | 否 | 需要查询的角色模板id |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-info-buildusertask-buildusertask"></a>

### POST /info/buildUserTask

- 分组：流程相关信息查询
- 名称：获取台账导出用户任务数据
- OperationId：buildUserTask

#### 调用方法

`POST /info/buildUserTask`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：ProductNcrVoLedger[]（ProductNcrVoLedger）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | ProductNcrVoLedger[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-info-buildusertaskcommon-buildusertaskcommon"></a>

### POST /info/buildUserTaskCommon

- 分组：流程相关信息查询
- 名称：获取审批节点数据-通用
- OperationId：buildUserTaskCommon

#### 调用方法

`POST /info/buildUserTaskCommon`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| businessTypekey | query | 否 | string |  |  |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：string[]

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | string[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="get-info-vagueusrodeot-vagueusrodeot"></a>

### GET /info/vagueUsRoDeOt

- 分组：流程相关信息查询
- 名称：模糊搜索流程用户角色部门其他
- OperationId：vagueUsRoDeOt

#### 调用方法

`GET /info/vagueUsRoDeOt`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| loginUserId | query | 是 | integer(int64) |  |  |
| type | query | 是 | string |  |  |
| text | query | 否 | string |  |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="get-info-getuserandrole-getuserandrole"></a>

### GET /info/getUserAndRole

- 分组：流程相关信息查询
- 名称：获取流程用户角色部门
- OperationId：getUserAndRole

#### 调用方法

`GET /info/getUserAndRole`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| userId | query | 是 | integer(int64) |  |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="get-info-getremark-getremark"></a>

### GET /info/getRemark

- 分组：流程相关信息查询
- 名称：获取节点审批备注(最新的)
- OperationId：getRemark

#### 调用方法

`GET /info/getRemark`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| businessId | query | 是 | string |  |  |
| businessTypeKey | query | 是 | string |  |  |
| taskCustomName | query | 是 | string |  |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="get-info-getmodelversion-getmodelversion"></a>

### GET /info/getModelVersion

- 分组：流程相关信息查询
- 名称：获取版本号
- OperationId：getModelVersion

#### 调用方法

`GET /info/getModelVersion`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| businessId | query | 是 | string |  |  |
| instanceId | query | 否 | string |  |  |
| businessTypeKey | query | 是 | string |  |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="get-info-getalluserbybusinessid-getalluserbybusinessid"></a>

### GET /info/getAllUserByBusinessId

- 分组：流程相关信息查询
- 名称：获取节点选择的用户信息byBusinessId
- OperationId：getAllUserByBusinessId

#### 调用方法

`GET /info/getAllUserByBusinessId`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| businessId | query | 是 | string |  |  |
| businessTypeKey | query | 是 | string |  |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="get-info-deletecancelncr-deletecancelncr"></a>

### GET /info/deleteCancelNcr

- 分组：流程相关信息查询
- 名称：删除当前已作废的ncr流程数据（保留ncr业务表数据）
- OperationId：deleteCancelNcr

#### 调用方法

`GET /info/deleteCancelNcr`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| instanceId | query | 否 | string |  |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-businesstype-update-update-1"></a>

### POST /businessType/update

- 分组：bpm业务类型
- 名称：编辑业务类型
- OperationId：update_1

#### 调用方法

`POST /businessType/update`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：BpmBusinessTypeDto（BpmBusinessTypeDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | 业务类型id |  |
| businessTypeKey | string | 是 | 业务类型key |  |
| businessTypeName | string | 是 | 业务类型名称 |  |
| state | integer(int32) | 是 | 状态 1-正常,2-挂起 |  |
| merchantId | integer(int64) | 是 | 商户id |  |
| companyId | integer(int64) | 否 | 公司id |  |
| color | string | 否 | 颜色 |  |
| userId | string | 是 | 操作用户id |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-businesstype-delete-delete-1"></a>

### POST /businessType/delete

- 分组：bpm业务类型
- 名称：删除业务类型
- OperationId：delete_1

#### 调用方法

`POST /businessType/delete`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：integer(int64)[]

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | integer(int64)[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="post-businesstype-add-add"></a>

### POST /businessType/add

- 分组：bpm业务类型
- 名称：新增业务类型
- OperationId：add

#### 调用方法

`POST /businessType/add`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：BpmBusinessTypeDto（BpmBusinessTypeDto）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | 业务类型id |  |
| businessTypeKey | string | 是 | 业务类型key |  |
| businessTypeName | string | 是 | 业务类型名称 |  |
| state | integer(int32) | 是 | 状态 1-正常,2-挂起 |  |
| merchantId | integer(int64) | 是 | 商户id |  |
| companyId | integer(int64) | 否 | 公司id |  |
| color | string | 否 | 颜色 |  |
| userId | string | 是 | 操作用户id |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

<a id="get-businesstype-list-getbusinesstypelist"></a>

### GET /businessType/list

- 分组：bpm业务类型
- 名称：bpm业务类型列表
- OperationId：getBusinessTypeList

#### 调用方法

`GET /businessType/list`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| merchantId | query | 是 | integer(int64) | 商户id |  |
| companyId | query | 是 | integer(int64) | 公司id |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ResultObject（ResultObject）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |


## 模型定义

### FileDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| taskId | string | 否 | 任务id |  |
| fileUrlList | object[] | 否 | 文件List |  |

### ResultObject

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | object | 否 | 响应数据 |  |

### CompleteTaskDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| taskId | string | 是 | 任务id |  |
| pass | boolean | 是 | 是否通过 |  |
| customTaskApproverList | TaskApproveDto[] | 否 | 后续节点审批人 |  |
| parallelAssigneeList | WkTaskInstanceRef[] | 否 | 并行节点审批人分组数据 |  |
| approveData | object | 否 | 审批数据 |  |
| reStartBusinessData | object | 否 | 重新审批选择的业务数据 |  |
| submitBy | string | 是 | 提交人 |  |
| callBackExec | boolean | 否 | 是否回调, 默认true |  |
| messageExec | boolean | 否 | 是否发送消息, 默认true |  |
| httpExec | boolean | 否 | 是否http请求, 默认true |  |

### Other

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| initiator | boolean | 否 | 是否发起人 |  |
| roleTemplateIdList | integer(int64)[] | 否 | 角色模板id |  |

### ParallelAssigneeBo

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| buildFlag | boolean | 否 | 是否已构建 |  |
| name | string | 否 | 分组名称 |  |
| userIdList | string[] | 否 | 用户组 |  |
| roleIdList | string[] | 否 | 角色组 |  |
| departmentIdList | string[] | 否 | 部门组 |  |
| otherJson | Other | 否 | 其他标记组 |  |

### TaskApproveDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| taskCustomName | string | 否 | 节点自定义名称 |  |
| userIdList | string[] | 否 | 用户组 |  |
| roleIdList | string[] | 否 | 角色组 |  |
| departmentIdList | string[] | 否 | 部门组 |  |
| otherJson | Other | 否 | 其他标记组 |  |

### WkTaskInstanceRef

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 | id |  |
| wkInstanceId | integer(int64) | 否 | wkInstance表主键id |  |
| instanceId | string | 否 | 实例id |  |
| modelId | integer(int64) | 否 | model表主键id |  |
| definitionId | string | 否 | 流程定义id |  |
| taskKey | string | 否 | 节点key |  |
| taskCustomName | string | 否 | 节点自定义名称 |  |
| userIdList | string[] | 否 | 用户组 |  |
| roleIdList | string[] | 否 | 角色组 |  |
| departmentIdList | string[] | 否 | 部门组 |  |
| otherJson | Other | 否 | 其他标记组 |  |
| parallelAssignee | ParallelAssigneeBo[] | 否 | 单节点并行节点审批用户组 |  |
| refJson | object | 否 | 自定义数据关联字段 |  |

### BackNodeDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| curTaskId | string | 是 | 当前节点id |  |
| targetTaskKey | string | 是 | 目标节点id |  |
| approveData | object | 否 | 审批数据 |  |
| submitBy | string | 是 | 提交人 |  |

### BpmModelDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | modelId |  |
| businessTypeId | integer(int64) | 是 | 业务类型id |  |
| modelXml | string | 否 | 流程定义XML |  |
| userId | string | 是 | 用户id |  |
| taskCustomName | string | 否 | 节点自定义名称 |  |
| wkTaskModelRefDtoList | WkTaskModelRefDto[] | 否 | 节点 <-> 用户 关系数据 |  |

### WkTaskLabelRefDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| modelId | integer(int64) | 否 |  |  |
| definitionId | string | 否 |  |  |
| taskKey | string | 否 |  |  |
| label | string | 否 |  |  |
| labelConfig | object | 否 |  |  |
| sort | integer(int32) | 否 |  |  |
| listener | string | 否 |  |  |

### WkTaskModelRefDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| modelId | integer(int64) | 否 |  |  |
| definitionId | string | 否 |  |  |
| taskKey | string | 否 |  |  |
| taskCustomName | string | 否 |  |  |
| no | string | 否 |  |  |
| userIdList | string[] | 否 |  |  |
| roleIdList | string[] | 否 |  |  |
| departmentIdList | string[] | 否 |  |  |
| otherJson | Other | 否 |  |  |
| parallelAssignee | ParallelAssigneeBo[] | 否 |  |  |
| refJson | object | 否 |  |  |
| wkTaskLabelRefDtoList | WkTaskLabelRefDto[] | 否 | 节点 <-> 标签 关系数据 |  |

### WkLabel

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 | id |  |
| label | string | 否 | 标签名 |  |
| labelKey | string | 否 | 标签内容key |  |
| value | object | 否 | 标签内容key值 |  |
| merchantId | integer(int64) | 否 | 商户id |  |
| companyId | integer(int64) | 否 | 公司（门店）id |  |

### VagueDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessTypeKey | string | 否 | 业务类型key |  |
| startTime | string(date-time) | 否 | 发起时间 |  |
| endTime | string(date-time) | 否 | 结束时间 |  |
| page | integer(int32) | 否 | 当前页 |  |
| pageSize | integer(int32) | 否 | 每页数量 |  |
| keywords | string | 否 | 关键字 |  |
| state | string | 否 | 状态 |  |
| userId | string | 是 | 当前操作用户id |  |

### IInitiateData

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| startTime | string(date-time) | 否 |  |  |
| endTime | string(date-time) | 否 |  |  |
| state | string | 否 |  |  |
| terminationRemark | string | 否 |  |  |
| businessData | object | 否 |  |  |
| businessId | string | 否 |  |  |
| instanceId | string | 否 |  |  |
| businessTypeKey | string | 否 |  |  |
| businessTypeName | string | 否 |  |  |
| color | string | 否 |  |  |

### PageVoIInitiateData

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| list | IInitiateData[] | 否 | 查询数据列表 |  |
| page | integer(int64) | 否 | 当前页 |  |
| pageSize | integer(int64) | 否 | 每页显示条数 |  |
| totalNum | integer(int64) | 否 | 总数 |  |
| totalPage | integer(int64) | 否 | 总页数 |  |

### ResultPageVoIInitiateData

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | PageVoIInitiateData | 否 | 响应数据 |  |

### IApprovalData

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| taskId | string | 否 |  |  |
| taskKey | string | 否 |  |  |
| taskName | string | 否 |  |  |
| taskCustomName | string | 否 |  |  |
| state | string | 否 |  |  |
| businessId | string | 否 |  |  |
| businessTypeKey | string | 否 |  |  |
| businessTypeName | string | 否 |  |  |
| businessData | object | 否 |  |  |
| instanceId | string | 否 |  |  |
| definitionId | string | 否 |  |  |
| startTime | string(date-time) | 否 |  |  |
| endTime | string(date-time) | 否 |  |  |
| color | string | 否 |  |  |
| preTask | PreTask | 否 |  |  |

### PageVoIApprovalData

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| list | IApprovalData[] | 否 | 查询数据列表 |  |
| page | integer(int64) | 否 | 当前页 |  |
| pageSize | integer(int64) | 否 | 每页显示条数 |  |
| totalNum | integer(int64) | 否 | 总数 |  |
| totalPage | integer(int64) | 否 | 总页数 |  |

### PreTask

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| taskId | string | 否 |  |  |
| taskName | string | 否 |  |  |
| taskCustomName | string | 否 |  |  |
| userId | integer(int64) | 否 |  |  |
| userName | string | 否 |  |  |
| approveData | object | 否 |  |  |

### ResultPageVoIApprovalData

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | PageVoIApprovalData | 否 | 响应数据 |  |

### DisposalResultsDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| instanceId | string | 否 | 实例id |  |
| disposalResultsJson | object | 否 | 结果json |  |
| newFlag | boolean | 否 | 是否是新流程 |  |

### UpdateDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessId | string | 否 | 业务id |  |
| map | object | 否 | 业务数据 |  |

### UpdateInstanceDataDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessTypeKey | string | 否 | 业务类型key |  |
| list | UpdateDto[] | 否 | 业务数据 |  |

### TerminationDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessTypeKey | string | 否 | 业务类型key |  |
| businessId | string | 是 | 业务id |  |
| userId | string | 是 | 当前操作用户id |  |
| terminationRemark | string | 否 | 终止原因 |  |
| callBackExec | boolean | 否 | 是否回调, 默认true |  |
| messageExec | boolean | 否 | 是否发送消息, 默认true |  |
| httpExec | boolean | 否 | 是否http请求, 默认true |  |

### InstanceDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessTypeKey | string | 是 | 业务类型key |  |
| businessId | string | 是 | 业务id |  |
| customTaskApproverList | TaskApproveDto[] | 否 | 后续节点审批人 |  |
| parallelAssigneeList | WkTaskInstanceRef[] | 否 | 单节点并行审批人分组数据 |  |
| businessData | object | 否 | 审批业务数据 |  |
| merchantId | integer(int64) | 是 | 商户 |  |
| companyId | integer(int64) | 是 | 公司 |  |
| createBy | string | 是 | 创建人 |  |
| modelVersion | integer(int32) | 否 | 选择发起版本 |  |

### DetailsDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessTypeKey | string | 否 | 业务类型key |  |
| businessIdList | string[] | 否 | 业务id集合 |  |
| more | boolean | 否 | 是否查询更多, 默认false |  |

### UsRoDeOtDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| loginUserId | integer(int64) | 是 | 当前登录用户id |  |
| userIdList | integer(int64)[] | 否 | 需要查询的用户id |  |
| roleIdList | integer(int64)[] | 否 | 需要查询的角色id |  |
| departmentIdList | integer(int64)[] | 否 | 需要查询的部门id |  |
| roleTemplateIdList | integer(int64)[] | 否 | 需要查询的角色模板id |  |

### DefectType

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| defectType | string | 否 |  |  |
| defectProperty | string[] | 否 |  |  |

### ProductNcrSectionVo

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| lifecycleBatchId | integer(int64) | 否 |  |  |
| deliveryOrderInfoId | integer(int64) | 否 |  |  |
| deliveryOrderSectionId | integer(int64) | 否 |  |  |
| batchCode | string | 否 |  |  |
| subFurnace | string | 否 |  |  |
| lifecycleSectionId | integer(int64) | 否 |  |  |
| sectionCode | string | 否 |  |  |
| num | integer(int32) | 否 |  |  |
| defectList | DefectType[] | 否 |  |  |
| defectDescription | string | 否 |  |  |
| pid | integer(int64) | 否 |  |  |

### ProductNcrVoLedger

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| ncrNo | string | 否 |  |  |
| handleOrg | string | 否 |  |  |
| handleOrgId | integer(int64) | 否 |  |  |
| org | string | 否 |  |  |
| producePlanId | integer(int64) | 否 |  |  |
| produceCode | string | 否 |  |  |
| productId | integer(int64) | 否 |  |  |
| productCode | string | 否 |  |  |
| productName | string | 否 |  |  |
| drawingNo | string | 否 |  |  |
| batch | string | 否 |  |  |
| serialNumber | string | 否 |  |  |
| subFurnace | string | 否 |  |  |
| texture | string | 否 |  |  |
| productWeight | number(double) | 否 |  |  |
| productType | integer(int64) | 否 |  |  |
| productTypeName | string | 否 |  |  |
| processMajor | integer(int64) | 否 |  |  |
| processMajorName | string | 否 |  |  |
| productCategory | integer(int32) | 否 |  |  |
| inspectNum | integer(int32) | 否 |  |  |
| unqualifiedNum | integer(int32) | 否 |  |  |
| startLifecycleId | integer(int64) | 否 |  |  |
| startLifecycle | string | 否 |  |  |
| treatmentMeasure | integer(int32) | 否 |  |  |
| severity | integer(int32) | 否 |  |  |
| sectionFlag | boolean | 否 |  |  |
| tribunalFlag | boolean | 否 |  |  |
| representativeFlag | boolean | 否 |  |  |
| state | integer(int32) | 否 |  |  |
| orgId | integer(int64) | 否 |  |  |
| createUserName | string | 否 |  |  |
| startDate | string(date-time) | 否 |  |  |
| endDate | string(date-time) | 否 |  |  |
| sectionList | ProductNcrSectionVo[] | 否 |  |  |
| userTask | UserTaskDetail[] | 否 |  |  |
| modelId | integer(int64) | 否 |  |  |
| processDefinitionId | string | 否 |  |  |
| instanceId | string | 否 |  |  |
| modelVersion | integer(int32) | 否 |  |  |
| initiateRemark | string | 否 |  |  |
| approvalOverDate | string(date-time) | 否 |  |  |
| updateDate | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| createDate | string(date-time) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |

### UserTaskDetail

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| taskId | string | 否 |  |  |
| taskKey | string | 否 |  |  |
| taskName | string | 否 |  |  |
| startDate | string(date-time) | 否 |  |  |
| endDate | string(date-time) | 否 |  |  |
| userName | string | 否 |  |  |
| backNodeUserNameList | string[] | 否 |  |  |
| userId | integer(int64) | 否 |  |  |
| signatures | string | 否 |  |  |
| approvalData | object | 否 |  |  |
| parallelNode | boolean | 否 |  |  |

### BpmBusinessTypeDto

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | 业务类型id |  |
| businessTypeKey | string | 是 | 业务类型key |  |
| businessTypeName | string | 是 | 业务类型名称 |  |
| state | integer(int32) | 是 | 状态 1-正常,2-挂起 |  |
| merchantId | integer(int64) | 是 | 商户id |  |
| companyId | integer(int64) | 否 | 公司id |  |
| color | string | 否 | 颜色 |  |
| userId | string | 是 | 操作用户id |  |

### BpmModelVo

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 | 主键 |  |
| businessTypeId | integer(int64) | 否 | 业务类型id |  |
| businessTypeKey | string | 否 | 业务类型key |  |
| definitionId | string | 否 | 流程定义id |  |
| modelXml | string | 否 | 流程定义XML |  |
| modelVersion | integer(int32) | 否 | 流程定义版本 |  |
| state | integer(int32) | 否 | 流程定义状态 状态 0-未部署,1-已部署(激活),2-挂起 |  |
| createTime | string(date-time) | 否 | 流程定义创建时间 |  |
| wkTaskModelRefDtoList | WkTaskModelRefDto[] | 否 | 流程定义XML 节点用户关系数据 |  |

### ResultListBpmModelVo

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | BpmModelVo[] | 否 | 响应数据 |  |

### BpmInstanceDataVo

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| instanceId | string | 否 | 实例id |  |
| businessId | string | 否 | 业务id |  |
| state | string | 否 | 实例状态 |  |
| businessTypeKey | string | 否 | 业务类型key |  |
| businessTypeName | string | 否 | 业务类型名称 |  |
| businessData | object | 否 | 业务数据 |  |
| modelXml | string | 否 | 流程xml |  |
| modelVersion | integer(int32) | 否 | 流程版本 |  |
| definitionId | string | 否 | 流程定义id |  |
| userTask | UserTask | 否 | 用户任务数据 |  |
| backNodeNo | object | 否 | 驳回节点排序no |  |
| merchantId | integer(int64) | 否 | 商户id |  |
| companyId | integer(int64) | 否 | 公司id |  |
| terminationRemark | string | 否 | 终止备注 |  |
| createTime | string(date-time) | 否 | 创建时间 |  |
| endTime | string(date-time) | 否 | 结束时间 |  |

### PageVoBpmInstanceDataVo

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| list | BpmInstanceDataVo[] | 否 | 查询数据列表 |  |
| page | integer(int64) | 否 | 当前页 |  |
| pageSize | integer(int64) | 否 | 每页显示条数 |  |
| totalNum | integer(int64) | 否 | 总数 |  |
| totalPage | integer(int64) | 否 | 总页数 |  |

### ResultPageVoBpmInstanceDataVo

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 否 | 响应状态 | 200 |
| message | string | 否 | 状态信息 | "操作成功" |
| data | PageVoBpmInstanceDataVo | 否 | 响应数据 |  |

### UserTask

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| approvedList | UserTaskDetail[] | 否 |  |  |
| approvingList | UserTaskDetail[] | 否 |  |  |