# 流程定义



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



## 快速索引



| 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- |
| 指定流程达式列表 | GET | `/gd_dataserver/gd_dataserver/flowable/definition/expList` | - |
| 导入流程文件 | POST | `/gd_dataserver/gd_dataserver/flowable/definition/import` | 上传bpmn20的xml文件 |
| 流程定义列表 | GET | `/gd_dataserver/gd_dataserver/flowable/definition/list` | - |
| 读取图片文件 | GET | `/gd_dataserver/gd_dataserver/flowable/definition/readImage/{deployId}` | - |
| 读取xml文件 | GET | `/gd_dataserver/gd_dataserver/flowable/definition/readXml/{deployId}` | - |
| 指定流程办理组列表 | GET | `/gd_dataserver/gd_dataserver/flowable/definition/roleList` | - |
| 保存流程设计器内的xml文件 | POST | `/gd_dataserver/gd_dataserver/flowable/definition/save` | - |
| 发起流程 | POST | `/gd_dataserver/gd_dataserver/flowable/definition/start/{procDefId}` | - |
| 激活或挂起流程定义 | PUT | `/gd_dataserver/gd_dataserver/flowable/definition/updateState` | - |
| 指定流程办理人员列表 | GET | `/gd_dataserver/gd_dataserver/flowable/definition/userList` | - |
| 删除流程 | DELETE | `/gd_dataserver/gd_dataserver/flowable/definition/{deployIds}` | - |


## 接口详情



### 指定流程达式列表

- **用途：** 接口文档未提供用途说明。
- **请求：** `GET /gd_dataserver/gd_dataserver/flowable/definition/expList`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `expListUsingGET`

参数：

| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| createBy | query | 否 | string | - | - |
| createByName | query | 否 | string | - | - |
| createTime | query | 否 | string / date-time | - | - |
| expression | query | 否 | string | - | - |
| id | query | 否 | integer / int64 | - | - |
| name | query | 否 | string | - | - |
| params | query | 否 | object | - | - |
| remark | query | 否 | string | - | - |
| searchValue | query | 否 | string | - | - |
| status | query | 否 | integer / int32 | - | - |
| updateBy | query | 否 | string | - | - |
| updateByName | query | 否 | string | - | - |
| updateTime | query | 否 | string / date-time | - | - |

响应：

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


### 导入流程文件

- **用途：** 上传bpmn20的xml文件
- **请求：** `POST /gd_dataserver/gd_dataserver/flowable/definition/import`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `importFileUsingPOST`

参数：

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

请求体：

- Content-Type：`application/json`
- 模型：`string / binary`
- 必填：文档未标记
- Content-Type：`application/octet-stream`
- 模型：`string / binary`
- 必填：文档未标记

响应：

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


### 流程定义列表

- **用途：** 接口文档未提供用途说明。
- **请求：** `GET /gd_dataserver/gd_dataserver/flowable/definition/list`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `listUsingGET`

参数：

| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| pageNum | query | 是 | integer / int32 | 当前页码 | - |
| pageSize | query | 是 | integer / int32 | 每页条数 | - |
| name | query | 否 | string | 流程名称 | - |

响应：

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


### 读取图片文件

- **用途：** 接口文档未提供用途说明。
- **请求：** `GET /gd_dataserver/gd_dataserver/flowable/definition/readImage/{deployId}`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `readImageUsingGET`

参数：

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

响应：

| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |


### 读取xml文件

- **用途：** 接口文档未提供用途说明。
- **请求：** `GET /gd_dataserver/gd_dataserver/flowable/definition/readXml/{deployId}`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `readXmlUsingGET`

参数：

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

响应：

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


### 指定流程办理组列表

- **用途：** 接口文档未提供用途说明。
- **请求：** `GET /gd_dataserver/gd_dataserver/flowable/definition/roleList`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `roleListUsingGET`

参数：

| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| admin | query | 否 | boolean | - | - |
| createBy | query | 否 | string | - | - |
| createByName | query | 否 | string | - | - |
| createTime | query | 否 | string / date-time | - | - |
| dataScope | query | 否 | string | - | - |
| delFlag | query | 否 | string | - | - |
| deptCheckStrictly | query | 否 | boolean | - | - |
| deptIds | query | 否 | array<integer / int64> | - | - |
| flag | query | 否 | boolean | - | - |
| menuCheckStrictly | query | 否 | boolean | - | - |
| menuIds | query | 否 | array<integer / int64> | - | - |
| params | query | 否 | object | - | - |
| permissions | query | 否 | array<string> | - | - |
| remark | query | 否 | string | - | - |
| roleId | query | 否 | string | - | - |
| roleKey | query | 是 | string | - | - |
| roleName | query | 是 | string | - | - |
| roleSort | query | 是 | integer / int32 | - | - |
| searchValue | query | 否 | string | - | - |
| status | query | 否 | string | - | - |
| updateBy | query | 否 | string | - | - |
| updateByName | query | 否 | string | - | - |
| updateTime | query | 否 | string / date-time | - | - |

响应：

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


### 保存流程设计器内的xml文件

- **用途：** 接口文档未提供用途说明。
- **请求：** `POST /gd_dataserver/gd_dataserver/flowable/definition/save`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `saveUsingPOST`

参数：

_无_

请求体：

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

| 字段 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| category | 否 | string | - | - |
| name | 否 | string | - | - |
| xml | 否 | string | - | - |


响应：

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


### 发起流程

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

参数：

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

请求体：

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

响应：

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


### 激活或挂起流程定义

- **用途：** 接口文档未提供用途说明。
- **请求：** `PUT /gd_dataserver/gd_dataserver/flowable/definition/updateState`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `updateStateUsingPUT`

参数：

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

响应：

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


### 指定流程办理人员列表

- **用途：** 接口文档未提供用途说明。
- **请求：** `GET /gd_dataserver/gd_dataserver/flowable/definition/userList`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `userListUsingGET`

参数：

| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| admin | query | 否 | boolean | - | - |
| avatar | query | 否 | string | - | - |
| createBy | query | 否 | string | - | - |
| createByName | query | 否 | string | - | - |
| createTime | query | 否 | string / date-time | - | - |
| delFlag | query | 否 | string | - | - |
| dept.ancestors | query | 否 | string | - | - |
| dept.createBy | query | 否 | string | - | - |
| dept.createByName | query | 否 | string | - | - |
| dept.createTime | query | 否 | string / date-time | - | - |
| dept.delFlag | query | 否 | string | - | - |
| dept.deptId | query | 否 | string | - | - |
| dept.deptName | query | 是 | string | - | - |
| dept.email | query | 否 | string | - | - |
| dept.leader | query | 否 | string | - | - |
| dept.orderNum | query | 是 | integer / int32 | - | - |
| dept.params | query | 否 | object | - | - |
| dept.parentId | query | 否 | string | - | - |
| dept.parentName | query | 否 | string | - | - |
| dept.phone | query | 否 | string | - | - |
| dept.searchValue | query | 否 | string | - | - |
| dept.status | query | 否 | string | - | - |
| dept.updateBy | query | 否 | string | - | - |
| dept.updateByName | query | 否 | string | - | - |
| dept.updateTime | query | 否 | string / date-time | - | - |
| deptId | query | 否 | string | - | - |
| email | query | 否 | string | - | - |
| loginDate | query | 否 | string / date-time | - | - |
| loginIp | query | 否 | string | - | - |
| nickName | query | 否 | string | - | - |
| params | query | 否 | object | - | - |
| password | query | 否 | string | - | - |
| phonenumber | query | 否 | string | - | - |
| postIds | query | 否 | array<integer / int64> | - | - |
| postNames | query | 否 | string | - | - |
| remark | query | 否 | string | - | - |
| roleId | query | 否 | integer / int64 | - | - |
| roleIds | query | 否 | array<string> | - | - |
| roles[0].admin | query | 否 | boolean | - | - |
| roles[0].createBy | query | 否 | string | - | - |
| roles[0].createByName | query | 否 | string | - | - |
| roles[0].createTime | query | 否 | string / date-time | - | - |
| roles[0].dataScope | query | 否 | string | - | - |
| roles[0].delFlag | query | 否 | string | - | - |
| roles[0].deptCheckStrictly | query | 否 | boolean | - | - |
| roles[0].deptIds | query | 否 | array<integer / int64> | - | - |
| roles[0].flag | query | 否 | boolean | - | - |
| roles[0].menuCheckStrictly | query | 否 | boolean | - | - |
| roles[0].menuIds | query | 否 | array<integer / int64> | - | - |
| roles[0].params | query | 否 | object | - | - |
| roles[0].permissions | query | 否 | array<string> | - | - |
| roles[0].remark | query | 否 | string | - | - |
| roles[0].roleId | query | 否 | string | - | - |
| roles[0].roleKey | query | 是 | string | - | - |
| roles[0].roleName | query | 是 | string | - | - |
| roles[0].roleSort | query | 是 | integer / int32 | - | - |
| roles[0].searchValue | query | 否 | string | - | - |
| roles[0].status | query | 否 | string | - | - |
| roles[0].updateBy | query | 否 | string | - | - |
| roles[0].updateByName | query | 否 | string | - | - |
| roles[0].updateTime | query | 否 | string / date-time | - | - |
| sapCode | query | 否 | string | - | - |
| searchValue | query | 否 | string | - | - |
| sex | query | 否 | string | - | - |
| status | query | 否 | string | - | - |
| updateBy | query | 否 | string | - | - |
| updateByName | query | 否 | string | - | - |
| updateTime | query | 否 | string / date-time | - | - |
| userId | query | 否 | string | - | - |
| userName | query | 是 | string | - | - |

响应：

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


### 删除流程

- **用途：** 接口文档未提供用途说明。
- **请求：** `DELETE /gd_dataserver/gd_dataserver/flowable/definition/{deployIds}`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `deleteUsingDELETE`

参数：

| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| deployIds | path | 是 | string | deployIds | - |

响应：

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