Files
obsidian_note/各种项目/咪咕/api接口文档/运营平台.md

35389 lines
735 KiB
Markdown
Raw Normal View History

2025-12-04 09:12:56 +08:00
# 认证模块文档
**简介**:
**HOST**: xxxxx.xxxx.xxx
**联系人**:
**Version**:
**接口路径**:/auth/v2/api-docs
[TOC]
# marketing-controller
## login
**接口地址**:`/auth/marketing/login`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"nickName": "",
"password": "",
"username": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|form|form|body|true|LoginBody|LoginBody|
|  nickName|||false|string||
|  password|||true|string||
|  username|||true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
## logout
**接口地址**:`/auth/marketing/logout`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
## refresh
**接口地址**:`/auth/marketing/refresh`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
## register
**接口地址**:`/auth/marketing/register`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"companyName": "",
"confirmPassword": "",
"email": "",
"nickName": "",
"password": "",
"phone": "",
"smsCode": "",
"userType": "",
"username": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|registerBody|registerBody|body|true|注册|注册|
|  companyName|企业名称||false|string||
|  confirmPassword|确认密码||false|string||
|  email|邮箱||false|string||
|  nickName|||false|string||
|  password|||true|string||
|  phone|手机号||false|string||
|  smsCode|短信验证码||false|string||
|  userType|用户类型||false|string||
|  username|||true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
# test
## findPassword
**接口地址**:`/auth/pre/checkSmsCode`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"phone": "",
"smsCode": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|findPasswordDto|findPasswordDto|body|true|找回密码|找回密码|
|  phone|手机号||false|string||
|  smsCode|手机验证码||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
## login
**接口地址**:`/auth/pre/login`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"nickName": "",
"password": "",
"username": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|form|form|body|true|LoginBody|LoginBody|
|  nickName|||false|string||
|  password|||true|string||
|  username|||true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
## logout
**接口地址**:`/auth/pre/logout`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
## phone
**接口地址**:`/auth/pre/phone`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"phone": "",
"smsCode": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|form|form|body|true|手机验证码登录|手机验证码登录|
|  phone|手机号||false|string||
|  smsCode|手机验证码||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
## refresh
**接口地址**:`/auth/pre/refresh`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
## register
**接口地址**:`/auth/pre/register`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"companyName": "",
"confirmPassword": "",
"email": "",
"nickName": "",
"password": "",
"phone": "",
"smsCode": "",
"userType": "",
"username": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|registerBody|registerBody|body|true|注册|注册|
|  companyName|企业名称||false|string||
|  confirmPassword|确认密码||false|string||
|  email|邮箱||false|string||
|  nickName|||false|string||
|  password|||true|string||
|  phone|手机号||false|string||
|  smsCode|短信验证码||false|string||
|  userType|用户类型||false|string||
|  username|||true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
## resetUserPwd
**接口地址**:`/auth/pre/resetUserPwd`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"confirmPassword": "",
"password": "",
"uuid": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|resetPasswordDto|resetPasswordDto|body|true|重置密码|重置密码|
|  confirmPassword|确认密码||false|string||
|  password|密码||false|string||
|  uuid|uuid||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
## smsCode
**接口地址**:`/auth/pre/smsCode`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"code": "",
"phone": "",
"uuid": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|smsCodeDto|smsCodeDto|body|true|发送短信验证码|发送短信验证码|
|  code|验证码||false|string||
|  phone|手机号||false|string||
|  uuid|随机串||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
# token-controller
## login
**接口地址**:`/auth/login`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"nickName": "",
"password": "",
"username": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|form|form|body|true|LoginBody|LoginBody|
|  nickName|||false|string||
|  password|||true|string||
|  username|||true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
## logout
**接口地址**:`/auth/logout`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
## refresh
**接口地址**:`/auth/refresh`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
## register
**接口地址**:`/auth/register`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"companyName": "",
"confirmPassword": "",
"email": "",
"nickName": "",
"password": "",
"phone": "",
"smsCode": "",
"userType": "",
"username": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|registerBody|registerBody|body|true|注册|注册|
|  companyName|企业名称||false|string||
|  confirmPassword|确认密码||false|string||
|  email|邮箱||false|string||
|  nickName|||false|string||
|  password|||true|string||
|  phone|手机号||false|string||
|  smsCode|短信验证码||false|string||
|  userType|用户类型||false|string||
|  username|||true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
# 文件处理模块接口文档
**简介**:
**HOST**:xxxx.xxxx.xxxx
**联系人**:
**Version**:
**接口路径**:/file/v2/api-docs
[TOC]
# sys-file-controller
## preUpload
**接口地址**:`/file/pre/upload`
**请求方式**:`POST`
**请求数据类型**:`multipart/form-data`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|file|file|body|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«SysFile»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||SysFile|SysFile|
|  name||string||
|  originalFilename||string||
|  url||string||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {
"name": "",
"originalFilename": "",
"url": ""
},
"msg": ""
}
```
## upload
**接口地址**:`/file/upload`
**请求方式**:`POST`
**请求数据类型**:`multipart/form-data`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|file|file|body|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«SysFile»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||SysFile|SysFile|
|  name||string||
|  originalFilename||string||
|  url||string||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {
"name": "",
"originalFilename": "",
"url": ""
},
"msg": ""
}
```
# 系统模块接口文档
**简介**:系统模块接口文档
**HOST**:xxxx.xxxx.xxxx
**联系人**:
**Version**:
**接口路径**:/system/v2/api-docs
[TOC]
# pre-sys-dict-data-controller
## dictType
**接口地址**:`/system/pre/dict/data/type/{dictType}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dictType|dictType|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# pre-sys-profile-controller
## avatar
**接口地址**:`/system/pre/user/profile/avatar`
**请求方式**:`POST`
**请求数据类型**:`multipart/form-data`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|avatarfile|avatarfile|body|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# sys-config-controller
## add
**接口地址**:`/system/config`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"configId": 0,
"configKey": "",
"configName": "",
"configType": "",
"configValue": "",
"createBy": "",
"createTime": "",
"params": {},
"remark": "",
"searchValue": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|config|config|body|true|SysConfig|SysConfig|
|  configId|||false|integer(int64)||
|  configKey|||true|string||
|  configName|||true|string||
|  configType|||false|string||
|  configValue|||true|string||
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  params|||false|object||
|  remark|||false|string||
|  searchValue|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## edit
**接口地址**:`/system/config`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"configId": 0,
"configKey": "",
"configName": "",
"configType": "",
"configValue": "",
"createBy": "",
"createTime": "",
"params": {},
"remark": "",
"searchValue": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|config|config|body|true|SysConfig|SysConfig|
|  configId|||false|integer(int64)||
|  configKey|||true|string||
|  configName|||true|string||
|  configType|||false|string||
|  configValue|||true|string||
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  params|||false|object||
|  remark|||false|string||
|  searchValue|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## getConfigKey
**接口地址**:`/system/config/configKey/{configKey}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|configKey|configKey|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## export
**接口地址**:`/system/config/export`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|configKey||query|true|string||
|configName||query|true|string||
|configValue||query|true|string||
|configId||query|false|integer(int64)||
|configType||query|false|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|params||query|false|object||
|remark||query|false|string||
|searchValue||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## list
**接口地址**:`/system/config/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|configKey||query|true|string||
|configName||query|true|string||
|configValue||query|true|string||
|configId||query|false|integer(int64)||
|configType||query|false|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|params||query|false|object||
|remark||query|false|string||
|searchValue||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## refreshCache
**接口地址**:`/system/config/refreshCache`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## remove
**接口地址**:`/system/config/{configIds}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|configIds|configIds|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## getInfo
**接口地址**:`/system/config/{configId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|configId|configId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# sys-dept-controller
## add
**接口地址**:`/system/dept`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"ancestors": "",
"children": [
{
"ancestors": "",
"children": [],
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"deptName": "",
"email": "",
"leader": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"phone": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
],
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"deptName": "",
"email": "",
"leader": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"phone": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dept|dept|body|true|SysDept|SysDept|
|  ancestors|||false|string||
|  children|||false|array|SysDept|
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  delFlag|||false|string||
|  deptId|||false|integer(int64)||
|  deptName|||true|string||
|  email|||false|string||
|  leader|||false|string||
|  orderNum|||true|string||
|  params|||false|object||
|  parentId|||false|integer(int64)||
|  parentName|||false|string||
|  phone|||false|string||
|  remark|||false|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## edit
**接口地址**:`/system/dept`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"ancestors": "",
"children": [
{
"ancestors": "",
"children": [],
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"deptName": "",
"email": "",
"leader": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"phone": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
],
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"deptName": "",
"email": "",
"leader": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"phone": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dept|dept|body|true|SysDept|SysDept|
|  ancestors|||false|string||
|  children|||false|array|SysDept|
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  delFlag|||false|string||
|  deptId|||false|integer(int64)||
|  deptName|||true|string||
|  email|||false|string||
|  leader|||false|string||
|  orderNum|||true|string||
|  params|||false|object||
|  parentId|||false|integer(int64)||
|  parentName|||false|string||
|  phone|||false|string||
|  remark|||false|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## list
**接口地址**:`/system/dept/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|deptName||query|true|string||
|orderNum||query|true|string||
|ancestors||query|false|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|delFlag||query|false|string||
|deptId||query|false|integer(int64)||
|email||query|false|string||
|leader||query|false|string||
|params||query|false|object||
|parentId||query|false|integer(int64)||
|parentName||query|false|string||
|phone||query|false|string||
|remark||query|false|string||
|searchValue||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## excludeChild
**接口地址**:`/system/dept/list/exclude/{deptId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|deptId|deptId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## roleDeptTreeselect
**接口地址**:`/system/dept/roleDeptTreeselect/{roleId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|roleId|roleId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## treeselect
**接口地址**:`/system/dept/treeselect`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|deptName||query|true|string||
|orderNum||query|true|string||
|ancestors||query|false|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|delFlag||query|false|string||
|deptId||query|false|integer(int64)||
|email||query|false|string||
|leader||query|false|string||
|params||query|false|object||
|parentId||query|false|integer(int64)||
|parentName||query|false|string||
|phone||query|false|string||
|remark||query|false|string||
|searchValue||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## getInfo
**接口地址**:`/system/dept/{deptId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|deptId|deptId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## remove
**接口地址**:`/system/dept/{deptId}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|deptId|deptId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# sys-dict-data-controller
## add
**接口地址**:`/system/dict/data`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": "",
"createTime": "",
"cssClass": "",
"dictCode": 0,
"dictLabel": "",
"dictSort": 0,
"dictType": "",
"dictValue": "",
"isDefault": "",
"listClass": "",
"params": {},
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dict|dict|body|true|SysDictData|SysDictData|
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  cssClass|||false|string||
|  dictCode|||false|integer(int64)||
|  dictLabel|||true|string||
|  dictSort|||false|integer(int64)||
|  dictType|||true|string||
|  dictValue|||true|string||
|  isDefault|||false|string||
|  listClass|||false|string||
|  params|||false|object||
|  remark|||false|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## edit
**接口地址**:`/system/dict/data`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": "",
"createTime": "",
"cssClass": "",
"dictCode": 0,
"dictLabel": "",
"dictSort": 0,
"dictType": "",
"dictValue": "",
"isDefault": "",
"listClass": "",
"params": {},
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dict|dict|body|true|SysDictData|SysDictData|
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  cssClass|||false|string||
|  dictCode|||false|integer(int64)||
|  dictLabel|||true|string||
|  dictSort|||false|integer(int64)||
|  dictType|||true|string||
|  dictValue|||true|string||
|  isDefault|||false|string||
|  listClass|||false|string||
|  params|||false|object||
|  remark|||false|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## export
**接口地址**:`/system/dict/data/export`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dictLabel||query|true|string||
|dictType||query|true|string||
|dictValue||query|true|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|cssClass||query|false|string||
|default||query|false|boolean||
|dictCode||query|false|integer(int64)||
|dictSort||query|false|integer(int64)||
|isDefault||query|false|string||
|listClass||query|false|string||
|params||query|false|object||
|remark||query|false|string||
|searchValue||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## list
**接口地址**:`/system/dict/data/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dictLabel||query|true|string||
|dictType||query|true|string||
|dictValue||query|true|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|cssClass||query|false|string||
|default||query|false|boolean||
|dictCode||query|false|integer(int64)||
|dictSort||query|false|integer(int64)||
|isDefault||query|false|string||
|listClass||query|false|string||
|params||query|false|object||
|remark||query|false|string||
|searchValue||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## dictType
**接口地址**:`/system/dict/data/type/{dictType}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dictType|dictType|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## remove
**接口地址**:`/system/dict/data/{dictCodes}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dictCodes|dictCodes|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## getInfo
**接口地址**:`/system/dict/data/{dictCode}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dictCode|dictCode|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# sys-dict-type-controller
## add
**接口地址**:`/system/dict/type`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": "",
"createTime": "",
"dictId": 0,
"dictName": "",
"dictType": "",
"params": {},
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dict|dict|body|true|SysDictType|SysDictType|
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  dictId|||false|integer(int64)||
|  dictName|||true|string||
|  dictType|||true|string||
|  params|||false|object||
|  remark|||false|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## edit
**接口地址**:`/system/dict/type`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": "",
"createTime": "",
"dictId": 0,
"dictName": "",
"dictType": "",
"params": {},
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dict|dict|body|true|SysDictType|SysDictType|
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  dictId|||false|integer(int64)||
|  dictName|||true|string||
|  dictType|||true|string||
|  params|||false|object||
|  remark|||false|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## export
**接口地址**:`/system/dict/type/export`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dictName||query|true|string||
|dictType||query|true|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|dictId||query|false|integer(int64)||
|params||query|false|object||
|remark||query|false|string||
|searchValue||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## list
**接口地址**:`/system/dict/type/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dictName||query|true|string||
|dictType||query|true|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|dictId||query|false|integer(int64)||
|params||query|false|object||
|remark||query|false|string||
|searchValue||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## optionselect
**接口地址**:`/system/dict/type/optionselect`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## refreshCache
**接口地址**:`/system/dict/type/refreshCache`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## remove
**接口地址**:`/system/dict/type/{dictIds}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dictIds|dictIds|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## getInfo
**接口地址**:`/system/dict/type/{dictId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dictId|dictId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# sys-logininfor-controller
## add
**接口地址**:`/system/logininfor`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"accessTime": "",
"createBy": "",
"createTime": "",
"infoId": 0,
"ipaddr": "",
"msg": "",
"params": {},
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userName": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|logininfor|logininfor|body|true|SysLogininfor|SysLogininfor|
|  accessTime|||false|string(date-time)||
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  infoId|||false|integer(int64)||
|  ipaddr|||false|string||
|  msg|||false|string||
|  params|||false|object||
|  remark|||false|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
|  userName|||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## clean
**接口地址**:`/system/logininfor/clean`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## export
**接口地址**:`/system/logininfor/export`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|accessTime||query|false|string(date-time)||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|infoId||query|false|integer(int64)||
|ipaddr||query|false|string||
|msg||query|false|string||
|params||query|false|object||
|remark||query|false|string||
|searchValue||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
|userName||query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## list
**接口地址**:`/system/logininfor/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|accessTime||query|false|string(date-time)||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|infoId||query|false|integer(int64)||
|ipaddr||query|false|string||
|msg||query|false|string||
|params||query|false|object||
|remark||query|false|string||
|searchValue||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
|userName||query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## remove
**接口地址**:`/system/logininfor/{infoIds}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|infoIds|infoIds|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# sys-menu-controller
## add
**接口地址**:`/system/menu`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"children": [
{
"children": [],
"component": "",
"createBy": "",
"createTime": "",
"icon": "",
"isCache": "",
"isFrame": "",
"menuId": 0,
"menuName": "",
"menuType": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"path": "",
"perms": "",
"query": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": "",
"visible": ""
}
],
"component": "",
"createBy": "",
"createTime": "",
"icon": "",
"isCache": "",
"isFrame": "",
"menuId": 0,
"menuName": "",
"menuType": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"path": "",
"perms": "",
"query": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": "",
"visible": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|menu|menu|body|true|SysMenu|SysMenu|
|  children|||false|array|SysMenu|
|  component|||false|string||
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  icon|||false|string||
|  isCache|||false|string||
|  isFrame|||false|string||
|  menuId|||false|integer(int64)||
|  menuName|||true|string||
|  menuType|||true|string||
|  orderNum|||true|string||
|  params|||false|object||
|  parentId|||false|integer(int64)||
|  parentName|||false|string||
|  path|||false|string||
|  perms|||false|string||
|  query|||false|string||
|  remark|||false|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
|  visible|||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## edit
**接口地址**:`/system/menu`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"children": [
{
"children": [],
"component": "",
"createBy": "",
"createTime": "",
"icon": "",
"isCache": "",
"isFrame": "",
"menuId": 0,
"menuName": "",
"menuType": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"path": "",
"perms": "",
"query": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": "",
"visible": ""
}
],
"component": "",
"createBy": "",
"createTime": "",
"icon": "",
"isCache": "",
"isFrame": "",
"menuId": 0,
"menuName": "",
"menuType": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"path": "",
"perms": "",
"query": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": "",
"visible": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|menu|menu|body|true|SysMenu|SysMenu|
|  children|||false|array|SysMenu|
|  component|||false|string||
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  icon|||false|string||
|  isCache|||false|string||
|  isFrame|||false|string||
|  menuId|||false|integer(int64)||
|  menuName|||true|string||
|  menuType|||true|string||
|  orderNum|||true|string||
|  params|||false|object||
|  parentId|||false|integer(int64)||
|  parentName|||false|string||
|  path|||false|string||
|  perms|||false|string||
|  query|||false|string||
|  remark|||false|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
|  visible|||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## getRouters
**接口地址**:`/system/menu/getRouters`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## list
**接口地址**:`/system/menu/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|menuName||query|true|string||
|menuType||query|true|string||
|orderNum||query|true|string||
|component||query|false|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|icon||query|false|string||
|isCache||query|false|string||
|isFrame||query|false|string||
|menuId||query|false|integer(int64)||
|params||query|false|object||
|parentId||query|false|integer(int64)||
|parentName||query|false|string||
|path||query|false|string||
|perms||query|false|string||
|query||query|false|string||
|remark||query|false|string||
|searchValue||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
|visible||query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## roleMenuTreeselect
**接口地址**:`/system/menu/roleMenuTreeselect/{roleId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|roleId|roleId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## treeselect
**接口地址**:`/system/menu/treeselect`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|menuName||query|true|string||
|menuType||query|true|string||
|orderNum||query|true|string||
|component||query|false|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|icon||query|false|string||
|isCache||query|false|string||
|isFrame||query|false|string||
|menuId||query|false|integer(int64)||
|params||query|false|object||
|parentId||query|false|integer(int64)||
|parentName||query|false|string||
|path||query|false|string||
|perms||query|false|string||
|query||query|false|string||
|remark||query|false|string||
|searchValue||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
|visible||query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## getInfo
**接口地址**:`/system/menu/{menuId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|menuId|menuId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## remove
**接口地址**:`/system/menu/{menuId}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|menuId|menuId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# sys-notice-controller
## add
**接口地址**:`/system/notice`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": "",
"createTime": "",
"noticeContent": "",
"noticeId": 0,
"noticeTitle": "",
"noticeType": "",
"params": {},
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|notice|notice|body|true|SysNotice|SysNotice|
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  noticeContent|||false|string||
|  noticeId|||false|integer(int64)||
|  noticeTitle|||true|string||
|  noticeType|||false|string||
|  params|||false|object||
|  remark|||false|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## edit
**接口地址**:`/system/notice`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": "",
"createTime": "",
"noticeContent": "",
"noticeId": 0,
"noticeTitle": "",
"noticeType": "",
"params": {},
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|notice|notice|body|true|SysNotice|SysNotice|
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  noticeContent|||false|string||
|  noticeId|||false|integer(int64)||
|  noticeTitle|||true|string||
|  noticeType|||false|string||
|  params|||false|object||
|  remark|||false|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## list
**接口地址**:`/system/notice/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|noticeTitle||query|true|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|noticeContent||query|false|string||
|noticeId||query|false|integer(int64)||
|noticeType||query|false|string||
|params||query|false|object||
|remark||query|false|string||
|searchValue||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## remove
**接口地址**:`/system/notice/{noticeIds}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|noticeIds|noticeIds|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## getInfo
**接口地址**:`/system/notice/{noticeId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|noticeId|noticeId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# sys-operlog-controller
## add
**接口地址**:`/system/operlog`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"businessType": 0,
"businessTypes": [],
"createBy": "",
"createTime": "",
"deptName": "",
"errorMsg": "",
"jsonResult": "",
"method": "",
"operId": 0,
"operIp": "",
"operName": "",
"operParam": "",
"operTime": "",
"operUrl": "",
"operatorType": 0,
"params": {},
"remark": "",
"requestMethod": "",
"searchValue": "",
"status": 0,
"title": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|operLog|operLog|body|true|SysOperLog|SysOperLog|
|  businessType|||false|integer(int32)||
|  businessTypes|||false|array|integer|
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  deptName|||false|string||
|  errorMsg|||false|string||
|  jsonResult|||false|string||
|  method|||false|string||
|  operId|||false|integer(int64)||
|  operIp|||false|string||
|  operName|||false|string||
|  operParam|||false|string||
|  operTime|||false|string(date-time)||
|  operUrl|||false|string||
|  operatorType|||false|integer(int32)||
|  params|||false|object||
|  remark|||false|string||
|  requestMethod|||false|string||
|  searchValue|||false|string||
|  status|||false|integer(int32)||
|  title|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## clean
**接口地址**:`/system/operlog/clean`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## export
**接口地址**:`/system/operlog/export`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|businessType||query|false|integer(int32)||
|businessTypes||query|false|array|integer|
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|deptName||query|false|string||
|errorMsg||query|false|string||
|jsonResult||query|false|string||
|method||query|false|string||
|operatorType||query|false|integer(int32)||
|operId||query|false|integer(int64)||
|operIp||query|false|string||
|operName||query|false|string||
|operParam||query|false|string||
|operTime||query|false|string(date-time)||
|operUrl||query|false|string||
|params||query|false|object||
|remark||query|false|string||
|requestMethod||query|false|string||
|searchValue||query|false|string||
|status||query|false|integer(int32)||
|title||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## list
**接口地址**:`/system/operlog/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|businessType||query|false|integer(int32)||
|businessTypes||query|false|array|integer|
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|deptName||query|false|string||
|errorMsg||query|false|string||
|jsonResult||query|false|string||
|method||query|false|string||
|operatorType||query|false|integer(int32)||
|operId||query|false|integer(int64)||
|operIp||query|false|string||
|operName||query|false|string||
|operParam||query|false|string||
|operTime||query|false|string(date-time)||
|operUrl||query|false|string||
|params||query|false|object||
|remark||query|false|string||
|requestMethod||query|false|string||
|searchValue||query|false|string||
|status||query|false|integer(int32)||
|title||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## remove
**接口地址**:`/system/operlog/{operIds}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|operIds|operIds|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# sys-post-controller
## add
**接口地址**:`/system/post`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": "",
"createTime": "",
"flag": true,
"params": {},
"postCode": "",
"postId": 0,
"postName": "",
"postSort": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|post|post|body|true|SysPost|SysPost|
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  flag|||false|boolean||
|  params|||false|object||
|  postCode|||true|string||
|  postId|||false|integer(int64)||
|  postName|||true|string||
|  postSort|||true|string||
|  remark|||false|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## edit
**接口地址**:`/system/post`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": "",
"createTime": "",
"flag": true,
"params": {},
"postCode": "",
"postId": 0,
"postName": "",
"postSort": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|post|post|body|true|SysPost|SysPost|
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  flag|||false|boolean||
|  params|||false|object||
|  postCode|||true|string||
|  postId|||false|integer(int64)||
|  postName|||true|string||
|  postSort|||true|string||
|  remark|||false|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## export
**接口地址**:`/system/post/export`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|postCode||query|true|string||
|postName||query|true|string||
|postSort||query|true|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|flag||query|false|boolean||
|params||query|false|object||
|postId||query|false|integer(int64)||
|remark||query|false|string||
|searchValue||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## list
**接口地址**:`/system/post/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|postCode||query|true|string||
|postName||query|true|string||
|postSort||query|true|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|flag||query|false|boolean||
|params||query|false|object||
|postId||query|false|integer(int64)||
|remark||query|false|string||
|searchValue||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## optionselect
**接口地址**:`/system/post/optionselect`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## remove
**接口地址**:`/system/post/{postIds}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|postIds|postIds|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## getInfo
**接口地址**:`/system/post/{postId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|postId|postId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# sys-profile-controller
## profile
**接口地址**:`/system/user/profile`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## updateProfile
**接口地址**:`/system/user/profile`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"avatar": "",
"createBy": "",
"createTime": "",
"delFlag": "",
"dept": {
"ancestors": "",
"children": [],
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"deptName": "",
"email": "",
"leader": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"phone": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
},
"deptId": 0,
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"loginIp": "",
"nickName": "",
"params": {},
"password": "",
"phonenumber": "",
"postIds": [],
"remark": "",
"roleId": 0,
"roleIds": [],
"roles": [
{
"createBy": "",
"createTime": "",
"dataScope": "",
"delFlag": "",
"deptCheckStrictly": true,
"deptIds": [],
"flag": true,
"menuCheckStrictly": true,
"menuIds": [],
"params": {},
"remark": "",
"roleId": 0,
"roleKey": "",
"roleName": "",
"roleSort": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
],
"searchValue": "",
"serviceProviderId": "",
"sex": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userId": 0,
"userName": "",
"userType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|user|user|body|true|SysUser|SysUser|
|  avatar|||false|string||
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  delFlag|||false|string||
|  dept|||false|SysDept|SysDept|
|    ancestors|||false|string||
|    children|||false|array|SysDept|
|    createBy|||false|string||
|    createTime|||false|string||
|    delFlag|||false|string||
|    deptId|||false|integer||
|    deptName|||true|string||
|    email|||false|string||
|    leader|||false|string||
|    orderNum|||true|string||
|    params|||false|object||
|    parentId|||false|integer||
|    parentName|||false|string||
|    phone|||false|string||
|    remark|||false|string||
|    searchValue|||false|string||
|    status|||false|string||
|    updateBy|||false|string||
|    updateTime|||false|string||
|  deptId|||false|integer(int64)||
|  email|||false|string||
|  enterpriseId|||false|string||
|  enterpriseName|||false|string||
|  loginDate|||false|string(date-time)||
|  loginIp|||false|string||
|  nickName|||false|string||
|  params|||false|object||
|  password|||false|string||
|  phonenumber|||false|string||
|  postIds|||false|array|integer|
|  remark|||false|string||
|  roleId|||false|integer(int64)||
|  roleIds|||false|array|integer|
|  roles|||false|array|SysRole|
|    createBy|||false|string||
|    createTime|||false|string||
|    dataScope|||false|string||
|    delFlag|||false|string||
|    deptCheckStrictly|||false|boolean||
|    deptIds|||false|array|integer|
|    flag|||false|boolean||
|    menuCheckStrictly|||false|boolean||
|    menuIds|||false|array|integer|
|    params|||false|object||
|    remark|||false|string||
|    roleId|||false|integer||
|    roleKey|||true|string||
|    roleName|||true|string||
|    roleSort|||true|string||
|    searchValue|||false|string||
|    status|||false|string||
|    updateBy|||false|string||
|    updateTime|||false|string||
|  searchValue|||false|string||
|  serviceProviderId|||false|string||
|  sex|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
|  userId|||false|integer(int64)||
|  userName|||true|string||
|  userType|||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## avatar
**接口地址**:`/system/user/profile/avatar`
**请求方式**:`POST`
**请求数据类型**:`multipart/form-data`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|avatarfile|avatarfile|body|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## updatePwd
**接口地址**:`/system/user/profile/updatePwd`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|newPassword|newPassword|query|false|string||
|oldPassword|oldPassword|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# sys-role-controller
## add
**接口地址**:`/system/role`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": "",
"createTime": "",
"dataScope": "",
"delFlag": "",
"deptCheckStrictly": true,
"deptIds": [],
"flag": true,
"menuCheckStrictly": true,
"menuIds": [],
"params": {},
"remark": "",
"roleId": 0,
"roleKey": "",
"roleName": "",
"roleSort": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|role|role|body|true|SysRole|SysRole|
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  dataScope|||false|string||
|  delFlag|||false|string||
|  deptCheckStrictly|||false|boolean||
|  deptIds|||false|array|integer|
|  flag|||false|boolean||
|  menuCheckStrictly|||false|boolean||
|  menuIds|||false|array|integer|
|  params|||false|object||
|  remark|||false|string||
|  roleId|||false|integer(int64)||
|  roleKey|||true|string||
|  roleName|||true|string||
|  roleSort|||true|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## edit
**接口地址**:`/system/role`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": "",
"createTime": "",
"dataScope": "",
"delFlag": "",
"deptCheckStrictly": true,
"deptIds": [],
"flag": true,
"menuCheckStrictly": true,
"menuIds": [],
"params": {},
"remark": "",
"roleId": 0,
"roleKey": "",
"roleName": "",
"roleSort": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|role|role|body|true|SysRole|SysRole|
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  dataScope|||false|string||
|  delFlag|||false|string||
|  deptCheckStrictly|||false|boolean||
|  deptIds|||false|array|integer|
|  flag|||false|boolean||
|  menuCheckStrictly|||false|boolean||
|  menuIds|||false|array|integer|
|  params|||false|object||
|  remark|||false|string||
|  roleId|||false|integer(int64)||
|  roleKey|||true|string||
|  roleName|||true|string||
|  roleSort|||true|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## allocatedList
**接口地址**:`/system/role/authUser/allocatedList`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dept.deptName||query|true|string||
|dept.orderNum||query|true|string||
|roles[0].roleKey||query|true|string||
|roles[0].roleName||query|true|string||
|roles[0].roleSort||query|true|string||
|userName||query|true|string||
|admin||query|false|boolean||
|avatar||query|false|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|delFlag||query|false|string||
|dept.ancestors||query|false|string||
|dept.createBy||query|false|string||
|dept.createTime||query|false|string(date-time)||
|dept.delFlag||query|false|string||
|dept.deptId||query|false|integer(int64)||
|dept.email||query|false|string||
|dept.leader||query|false|string||
|dept.params||query|false|object||
|dept.parentId||query|false|integer(int64)||
|dept.parentName||query|false|string||
|dept.phone||query|false|string||
|dept.remark||query|false|string||
|dept.searchValue||query|false|string||
|dept.status||query|false|string||
|dept.updateBy||query|false|string||
|dept.updateTime||query|false|string(date-time)||
|deptId||query|false|integer(int64)||
|email||query|false|string||
|enterpriseId||query|false|string||
|enterpriseName||query|false|string||
|loginDate||query|false|string(date-time)||
|loginIp||query|false|string||
|nickName||query|false|string||
|params||query|false|object||
|password||query|false|string||
|phonenumber||query|false|string||
|postIds||query|false|array|integer|
|remark||query|false|string||
|roleId||query|false|integer(int64)||
|roleIds||query|false|array|integer|
|roles[0].admin||query|false|boolean||
|roles[0].createBy||query|false|string||
|roles[0].createTime||query|false|string(date-time)||
|roles[0].dataScope||query|false|string||
|roles[0].delFlag||query|false|string||
|roles[0].deptCheckStrictly||query|false|boolean||
|roles[0].deptIds||query|false|array|integer|
|roles[0].flag||query|false|boolean||
|roles[0].menuCheckStrictly||query|false|boolean||
|roles[0].menuIds||query|false|array|integer|
|roles[0].params||query|false|object||
|roles[0].remark||query|false|string||
|roles[0].roleId||query|false|integer(int64)||
|roles[0].searchValue||query|false|string||
|roles[0].status||query|false|string||
|roles[0].updateBy||query|false|string||
|roles[0].updateTime||query|false|string(date-time)||
|searchValue||query|false|string||
|serviceProviderId||query|false|string||
|sex||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
|userId||query|false|integer(int64)||
|userType||query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## cancelAuthUser
**接口地址**:`/system/role/authUser/cancel`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"roleId": 0,
"userId": 0
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|userRole|userRole|body|true|SysUserRole|SysUserRole|
|  roleId|||false|integer(int64)||
|  userId|||false|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## cancelAuthUserAll
**接口地址**:`/system/role/authUser/cancelAll`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|roleId|roleId|query|false|integer(int64)||
|userIds|userIds|query|false|array|integer|
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## selectAuthUserAll
**接口地址**:`/system/role/authUser/selectAll`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|roleId|roleId|query|false|integer(int64)||
|userIds|userIds|query|false|array|integer|
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## unallocatedList
**接口地址**:`/system/role/authUser/unallocatedList`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dept.deptName||query|true|string||
|dept.orderNum||query|true|string||
|roles[0].roleKey||query|true|string||
|roles[0].roleName||query|true|string||
|roles[0].roleSort||query|true|string||
|userName||query|true|string||
|admin||query|false|boolean||
|avatar||query|false|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|delFlag||query|false|string||
|dept.ancestors||query|false|string||
|dept.createBy||query|false|string||
|dept.createTime||query|false|string(date-time)||
|dept.delFlag||query|false|string||
|dept.deptId||query|false|integer(int64)||
|dept.email||query|false|string||
|dept.leader||query|false|string||
|dept.params||query|false|object||
|dept.parentId||query|false|integer(int64)||
|dept.parentName||query|false|string||
|dept.phone||query|false|string||
|dept.remark||query|false|string||
|dept.searchValue||query|false|string||
|dept.status||query|false|string||
|dept.updateBy||query|false|string||
|dept.updateTime||query|false|string(date-time)||
|deptId||query|false|integer(int64)||
|email||query|false|string||
|enterpriseId||query|false|string||
|enterpriseName||query|false|string||
|loginDate||query|false|string(date-time)||
|loginIp||query|false|string||
|nickName||query|false|string||
|params||query|false|object||
|password||query|false|string||
|phonenumber||query|false|string||
|postIds||query|false|array|integer|
|remark||query|false|string||
|roleId||query|false|integer(int64)||
|roleIds||query|false|array|integer|
|roles[0].admin||query|false|boolean||
|roles[0].createBy||query|false|string||
|roles[0].createTime||query|false|string(date-time)||
|roles[0].dataScope||query|false|string||
|roles[0].delFlag||query|false|string||
|roles[0].deptCheckStrictly||query|false|boolean||
|roles[0].deptIds||query|false|array|integer|
|roles[0].flag||query|false|boolean||
|roles[0].menuCheckStrictly||query|false|boolean||
|roles[0].menuIds||query|false|array|integer|
|roles[0].params||query|false|object||
|roles[0].remark||query|false|string||
|roles[0].roleId||query|false|integer(int64)||
|roles[0].searchValue||query|false|string||
|roles[0].status||query|false|string||
|roles[0].updateBy||query|false|string||
|roles[0].updateTime||query|false|string(date-time)||
|searchValue||query|false|string||
|serviceProviderId||query|false|string||
|sex||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
|userId||query|false|integer(int64)||
|userType||query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## changeStatus
**接口地址**:`/system/role/changeStatus`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": "",
"createTime": "",
"dataScope": "",
"delFlag": "",
"deptCheckStrictly": true,
"deptIds": [],
"flag": true,
"menuCheckStrictly": true,
"menuIds": [],
"params": {},
"remark": "",
"roleId": 0,
"roleKey": "",
"roleName": "",
"roleSort": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|role|role|body|true|SysRole|SysRole|
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  dataScope|||false|string||
|  delFlag|||false|string||
|  deptCheckStrictly|||false|boolean||
|  deptIds|||false|array|integer|
|  flag|||false|boolean||
|  menuCheckStrictly|||false|boolean||
|  menuIds|||false|array|integer|
|  params|||false|object||
|  remark|||false|string||
|  roleId|||false|integer(int64)||
|  roleKey|||true|string||
|  roleName|||true|string||
|  roleSort|||true|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## dataScope
**接口地址**:`/system/role/dataScope`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": "",
"createTime": "",
"dataScope": "",
"delFlag": "",
"deptCheckStrictly": true,
"deptIds": [],
"flag": true,
"menuCheckStrictly": true,
"menuIds": [],
"params": {},
"remark": "",
"roleId": 0,
"roleKey": "",
"roleName": "",
"roleSort": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|role|role|body|true|SysRole|SysRole|
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  dataScope|||false|string||
|  delFlag|||false|string||
|  deptCheckStrictly|||false|boolean||
|  deptIds|||false|array|integer|
|  flag|||false|boolean||
|  menuCheckStrictly|||false|boolean||
|  menuIds|||false|array|integer|
|  params|||false|object||
|  remark|||false|string||
|  roleId|||false|integer(int64)||
|  roleKey|||true|string||
|  roleName|||true|string||
|  roleSort|||true|string||
|  searchValue|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## export
**接口地址**:`/system/role/export`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|roleKey||query|true|string||
|roleName||query|true|string||
|roleSort||query|true|string||
|admin||query|false|boolean||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|dataScope||query|false|string||
|delFlag||query|false|string||
|deptCheckStrictly||query|false|boolean||
|deptIds||query|false|array|integer|
|flag||query|false|boolean||
|menuCheckStrictly||query|false|boolean||
|menuIds||query|false|array|integer|
|params||query|false|object||
|remark||query|false|string||
|roleId||query|false|integer(int64)||
|searchValue||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## list
**接口地址**:`/system/role/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|roleKey||query|true|string||
|roleName||query|true|string||
|roleSort||query|true|string||
|admin||query|false|boolean||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|dataScope||query|false|string||
|delFlag||query|false|string||
|deptCheckStrictly||query|false|boolean||
|deptIds||query|false|array|integer|
|flag||query|false|boolean||
|menuCheckStrictly||query|false|boolean||
|menuIds||query|false|array|integer|
|params||query|false|object||
|remark||query|false|string||
|roleId||query|false|integer(int64)||
|searchValue||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## optionselect
**接口地址**:`/system/role/optionselect`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## remove
**接口地址**:`/system/role/{roleIds}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|roleIds|roleIds|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## getInfo
**接口地址**:`/system/role/{roleId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|roleId|roleId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# sys-user-controller
## add
**接口地址**:`/system/user`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"avatar": "",
"createBy": "",
"createTime": "",
"delFlag": "",
"dept": {
"ancestors": "",
"children": [],
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"deptName": "",
"email": "",
"leader": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"phone": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
},
"deptId": 0,
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"loginIp": "",
"nickName": "",
"params": {},
"password": "",
"phonenumber": "",
"postIds": [],
"remark": "",
"roleId": 0,
"roleIds": [],
"roles": [
{
"createBy": "",
"createTime": "",
"dataScope": "",
"delFlag": "",
"deptCheckStrictly": true,
"deptIds": [],
"flag": true,
"menuCheckStrictly": true,
"menuIds": [],
"params": {},
"remark": "",
"roleId": 0,
"roleKey": "",
"roleName": "",
"roleSort": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
],
"searchValue": "",
"serviceProviderId": "",
"sex": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userId": 0,
"userName": "",
"userType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|user|user|body|true|SysUserReq|SysUserReq|
|  avatar|||false|string||
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  delFlag|||false|string||
|  dept|||false|SysDept|SysDept|
|    ancestors|||false|string||
|    children|||false|array|SysDept|
|    createBy|||false|string||
|    createTime|||false|string||
|    delFlag|||false|string||
|    deptId|||false|integer||
|    deptName|||true|string||
|    email|||false|string||
|    leader|||false|string||
|    orderNum|||true|string||
|    params|||false|object||
|    parentId|||false|integer||
|    parentName|||false|string||
|    phone|||false|string||
|    remark|||false|string||
|    searchValue|||false|string||
|    status|||false|string||
|    updateBy|||false|string||
|    updateTime|||false|string||
|  deptId|||false|integer(int64)||
|  email|||false|string||
|  enterpriseId|||false|string||
|  enterpriseName|||false|string||
|  loginDate|||false|string(date-time)||
|  loginIp|||false|string||
|  nickName|||false|string||
|  params|||false|object||
|  password|||false|string||
|  phonenumber|||false|string||
|  postIds|||false|array|integer|
|  remark|||false|string||
|  roleId|||false|integer(int64)||
|  roleIds|||false|array|integer|
|  roles|||false|array|SysRoleReq|
|    createBy|||false|string||
|    createTime|||false|string||
|    dataScope|||false|string||
|    delFlag|||false|string||
|    deptCheckStrictly|||false|boolean||
|    deptIds|||false|array|integer|
|    flag|||false|boolean||
|    menuCheckStrictly|||false|boolean||
|    menuIds|||false|array|integer|
|    params|||false|object||
|    remark|||false|string||
|    roleId|||false|integer||
|    roleKey|||true|string||
|    roleName|||true|string||
|    roleSort|||true|string||
|    searchValue|||false|string||
|    status|||false|string||
|    updateBy|||false|string||
|    updateTime|||false|string||
|  searchValue|||false|string||
|  serviceProviderId|||false|string||
|  sex|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
|  userId|||false|integer(int64)||
|  userName|||true|string||
|  userType|||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## edit
**接口地址**:`/system/user`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"avatar": "",
"createBy": "",
"createTime": "",
"delFlag": "",
"dept": {
"ancestors": "",
"children": [],
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"deptName": "",
"email": "",
"leader": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"phone": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
},
"deptId": 0,
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"loginIp": "",
"nickName": "",
"params": {},
"password": "",
"phonenumber": "",
"postIds": [],
"remark": "",
"roleId": 0,
"roleIds": [],
"roles": [
{
"createBy": "",
"createTime": "",
"dataScope": "",
"delFlag": "",
"deptCheckStrictly": true,
"deptIds": [],
"flag": true,
"menuCheckStrictly": true,
"menuIds": [],
"params": {},
"remark": "",
"roleId": 0,
"roleKey": "",
"roleName": "",
"roleSort": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
],
"searchValue": "",
"serviceProviderId": "",
"sex": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userId": 0,
"userName": "",
"userType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|user|user|body|true|SysUserReq|SysUserReq|
|  avatar|||false|string||
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  delFlag|||false|string||
|  dept|||false|SysDept|SysDept|
|    ancestors|||false|string||
|    children|||false|array|SysDept|
|    createBy|||false|string||
|    createTime|||false|string||
|    delFlag|||false|string||
|    deptId|||false|integer||
|    deptName|||true|string||
|    email|||false|string||
|    leader|||false|string||
|    orderNum|||true|string||
|    params|||false|object||
|    parentId|||false|integer||
|    parentName|||false|string||
|    phone|||false|string||
|    remark|||false|string||
|    searchValue|||false|string||
|    status|||false|string||
|    updateBy|||false|string||
|    updateTime|||false|string||
|  deptId|||false|integer(int64)||
|  email|||false|string||
|  enterpriseId|||false|string||
|  enterpriseName|||false|string||
|  loginDate|||false|string(date-time)||
|  loginIp|||false|string||
|  nickName|||false|string||
|  params|||false|object||
|  password|||false|string||
|  phonenumber|||false|string||
|  postIds|||false|array|integer|
|  remark|||false|string||
|  roleId|||false|integer(int64)||
|  roleIds|||false|array|integer|
|  roles|||false|array|SysRoleReq|
|    createBy|||false|string||
|    createTime|||false|string||
|    dataScope|||false|string||
|    delFlag|||false|string||
|    deptCheckStrictly|||false|boolean||
|    deptIds|||false|array|integer|
|    flag|||false|boolean||
|    menuCheckStrictly|||false|boolean||
|    menuIds|||false|array|integer|
|    params|||false|object||
|    remark|||false|string||
|    roleId|||false|integer||
|    roleKey|||true|string||
|    roleName|||true|string||
|    roleSort|||true|string||
|    searchValue|||false|string||
|    status|||false|string||
|    updateBy|||false|string||
|    updateTime|||false|string||
|  searchValue|||false|string||
|  serviceProviderId|||false|string||
|  sex|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
|  userId|||false|integer(int64)||
|  userName|||true|string||
|  userType|||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## getInfo
**接口地址**:`/system/user/`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|userId|userId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## insertAuthRole
**接口地址**:`/system/user/authRole`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|roleIds|roleIds|query|false|array|integer|
|userId|userId|query|false|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## authRole
**接口地址**:`/system/user/authRole/{userId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|userId|userId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## changeStatus
**接口地址**:`/system/user/changeStatus`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"avatar": "",
"createBy": "",
"createTime": "",
"delFlag": "",
"dept": {
"ancestors": "",
"children": [],
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"deptName": "",
"email": "",
"leader": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"phone": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
},
"deptId": 0,
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"loginIp": "",
"nickName": "",
"params": {},
"password": "",
"phonenumber": "",
"postIds": [],
"remark": "",
"roleId": 0,
"roleIds": [],
"roles": [
{
"createBy": "",
"createTime": "",
"dataScope": "",
"delFlag": "",
"deptCheckStrictly": true,
"deptIds": [],
"flag": true,
"menuCheckStrictly": true,
"menuIds": [],
"params": {},
"remark": "",
"roleId": 0,
"roleKey": "",
"roleName": "",
"roleSort": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
],
"searchValue": "",
"serviceProviderId": "",
"sex": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userId": 0,
"userName": "",
"userType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|user|user|body|true|SysUserReq|SysUserReq|
|  avatar|||false|string||
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  delFlag|||false|string||
|  dept|||false|SysDept|SysDept|
|    ancestors|||false|string||
|    children|||false|array|SysDept|
|    createBy|||false|string||
|    createTime|||false|string||
|    delFlag|||false|string||
|    deptId|||false|integer||
|    deptName|||true|string||
|    email|||false|string||
|    leader|||false|string||
|    orderNum|||true|string||
|    params|||false|object||
|    parentId|||false|integer||
|    parentName|||false|string||
|    phone|||false|string||
|    remark|||false|string||
|    searchValue|||false|string||
|    status|||false|string||
|    updateBy|||false|string||
|    updateTime|||false|string||
|  deptId|||false|integer(int64)||
|  email|||false|string||
|  enterpriseId|||false|string||
|  enterpriseName|||false|string||
|  loginDate|||false|string(date-time)||
|  loginIp|||false|string||
|  nickName|||false|string||
|  params|||false|object||
|  password|||false|string||
|  phonenumber|||false|string||
|  postIds|||false|array|integer|
|  remark|||false|string||
|  roleId|||false|integer(int64)||
|  roleIds|||false|array|integer|
|  roles|||false|array|SysRoleReq|
|    createBy|||false|string||
|    createTime|||false|string||
|    dataScope|||false|string||
|    delFlag|||false|string||
|    deptCheckStrictly|||false|boolean||
|    deptIds|||false|array|integer|
|    flag|||false|boolean||
|    menuCheckStrictly|||false|boolean||
|    menuIds|||false|array|integer|
|    params|||false|object||
|    remark|||false|string||
|    roleId|||false|integer||
|    roleKey|||true|string||
|    roleName|||true|string||
|    roleSort|||true|string||
|    searchValue|||false|string||
|    status|||false|string||
|    updateBy|||false|string||
|    updateTime|||false|string||
|  searchValue|||false|string||
|  serviceProviderId|||false|string||
|  sex|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
|  userId|||false|integer(int64)||
|  userName|||true|string||
|  userType|||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## editUser
**接口地址**:`/system/user/editUser`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"avatar": "",
"createBy": "",
"createTime": "",
"delFlag": "",
"dept": {
"ancestors": "",
"children": [],
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"deptName": "",
"email": "",
"leader": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"phone": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
},
"deptId": 0,
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"loginIp": "",
"nickName": "",
"params": {},
"password": "",
"phonenumber": "",
"postIds": [],
"remark": "",
"roleId": 0,
"roleIds": [],
"roles": [
{
"createBy": "",
"createTime": "",
"dataScope": "",
"delFlag": "",
"deptCheckStrictly": true,
"deptIds": [],
"flag": true,
"menuCheckStrictly": true,
"menuIds": [],
"params": {},
"remark": "",
"roleId": 0,
"roleKey": "",
"roleName": "",
"roleSort": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
],
"searchValue": "",
"serviceProviderId": "",
"sex": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userId": 0,
"userName": "",
"userType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|sysUser|sysUser|body|true|SysUserReq|SysUserReq|
|  avatar|||false|string||
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  delFlag|||false|string||
|  dept|||false|SysDept|SysDept|
|    ancestors|||false|string||
|    children|||false|array|SysDept|
|    createBy|||false|string||
|    createTime|||false|string||
|    delFlag|||false|string||
|    deptId|||false|integer||
|    deptName|||true|string||
|    email|||false|string||
|    leader|||false|string||
|    orderNum|||true|string||
|    params|||false|object||
|    parentId|||false|integer||
|    parentName|||false|string||
|    phone|||false|string||
|    remark|||false|string||
|    searchValue|||false|string||
|    status|||false|string||
|    updateBy|||false|string||
|    updateTime|||false|string||
|  deptId|||false|integer(int64)||
|  email|||false|string||
|  enterpriseId|||false|string||
|  enterpriseName|||false|string||
|  loginDate|||false|string(date-time)||
|  loginIp|||false|string||
|  nickName|||false|string||
|  params|||false|object||
|  password|||false|string||
|  phonenumber|||false|string||
|  postIds|||false|array|integer|
|  remark|||false|string||
|  roleId|||false|integer(int64)||
|  roleIds|||false|array|integer|
|  roles|||false|array|SysRoleReq|
|    createBy|||false|string||
|    createTime|||false|string||
|    dataScope|||false|string||
|    delFlag|||false|string||
|    deptCheckStrictly|||false|boolean||
|    deptIds|||false|array|integer|
|    flag|||false|boolean||
|    menuCheckStrictly|||false|boolean||
|    menuIds|||false|array|integer|
|    params|||false|object||
|    remark|||false|string||
|    roleId|||false|integer||
|    roleKey|||true|string||
|    roleName|||true|string||
|    roleSort|||true|string||
|    searchValue|||false|string||
|    status|||false|string||
|    updateBy|||false|string||
|    updateTime|||false|string||
|  searchValue|||false|string||
|  serviceProviderId|||false|string||
|  sex|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
|  userId|||false|integer(int64)||
|  userName|||true|string||
|  userType|||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## export
**接口地址**:`/system/user/export`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dept.deptName||query|true|string||
|dept.orderNum||query|true|string||
|roles[0].roleKey||query|true|string||
|roles[0].roleName||query|true|string||
|roles[0].roleSort||query|true|string||
|userName||query|true|string||
|admin||query|false|boolean||
|avatar||query|false|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|delFlag||query|false|string||
|dept.ancestors||query|false|string||
|dept.createBy||query|false|string||
|dept.createTime||query|false|string(date-time)||
|dept.delFlag||query|false|string||
|dept.deptId||query|false|integer(int64)||
|dept.email||query|false|string||
|dept.leader||query|false|string||
|dept.params||query|false|object||
|dept.parentId||query|false|integer(int64)||
|dept.parentName||query|false|string||
|dept.phone||query|false|string||
|dept.remark||query|false|string||
|dept.searchValue||query|false|string||
|dept.status||query|false|string||
|dept.updateBy||query|false|string||
|dept.updateTime||query|false|string(date-time)||
|deptId||query|false|integer(int64)||
|email||query|false|string||
|enterpriseId||query|false|string||
|enterpriseName||query|false|string||
|loginDate||query|false|string(date-time)||
|loginIp||query|false|string||
|nickName||query|false|string||
|params||query|false|object||
|password||query|false|string||
|phonenumber||query|false|string||
|postIds||query|false|array|integer|
|remark||query|false|string||
|roleId||query|false|integer(int64)||
|roleIds||query|false|array|integer|
|roles[0].admin||query|false|boolean||
|roles[0].createBy||query|false|string||
|roles[0].createTime||query|false|string(date-time)||
|roles[0].dataScope||query|false|string||
|roles[0].delFlag||query|false|string||
|roles[0].deptCheckStrictly||query|false|boolean||
|roles[0].deptIds||query|false|array|integer|
|roles[0].flag||query|false|boolean||
|roles[0].menuCheckStrictly||query|false|boolean||
|roles[0].menuIds||query|false|array|integer|
|roles[0].params||query|false|object||
|roles[0].remark||query|false|string||
|roles[0].roleId||query|false|integer(int64)||
|roles[0].searchValue||query|false|string||
|roles[0].status||query|false|string||
|roles[0].updateBy||query|false|string||
|roles[0].updateTime||query|false|string(date-time)||
|searchValue||query|false|string||
|serviceProviderId||query|false|string||
|sex||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
|userId||query|false|integer(int64)||
|userType||query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## getInfo
**接口地址**:`/system/user/getInfo`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## importData
**接口地址**:`/system/user/importData`
**请求方式**:`POST`
**请求数据类型**:`multipart/form-data`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|file|file|body|false|string||
|updateSupport|updateSupport|query|false|boolean||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## importTemplate
**接口地址**:`/system/user/importTemplate`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## info
**接口地址**:`/system/user/info/{accountType}/{account}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|account|account|path|true|string||
|accountType|accountType|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«LoginUser»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||LoginUser|LoginUser|
|  expireTime||integer(int64)||
|  ipaddr||string||
|  loginTime||integer(int64)||
|  permissions||array|string|
|  roles||array|string|
|  sysUser||SysUserRes|SysUserRes|
|    admin||boolean||
|    avatar||string||
|    createBy||string||
|    createTime||string||
|    delFlag||string||
|    dept||SysDept|SysDept|
|      ancestors||string||
|      children||array|SysDept|
|      createBy||string||
|      createTime||string||
|      delFlag||string||
|      deptId||integer||
|      deptName||string||
|      email||string||
|      leader||string||
|      orderNum||string||
|      params||object||
|      parentId||integer||
|      parentName||string||
|      phone||string||
|      remark||string||
|      searchValue||string||
|      status||string||
|      updateBy||string||
|      updateTime||string||
|    deptId||integer||
|    email||string||
|    enterpriseId||string||
|    enterpriseName||string||
|    loginDate||string||
|    loginIp||string||
|    nickName||string||
|    params||object||
|    password||string||
|    phonenumber||string||
|    postIds||array|integer|
|    remark||string||
|    roleId||integer||
|    roleIds||array|integer|
|    roles||array|SysRoleRes|
|      admin||boolean||
|      createBy||string||
|      createTime||string||
|      dataScope||string||
|      delFlag||string||
|      deptCheckStrictly||boolean||
|      deptIds||array|integer|
|      flag||boolean||
|      menuCheckStrictly||boolean||
|      menuIds||array|integer|
|      params||object||
|      remark||string||
|      roleId||integer||
|      roleKey||string||
|      roleName||string||
|      roleSort||string||
|      searchValue||string||
|      status||string||
|      updateBy||string||
|      updateTime||string||
|    searchValue||string||
|    serviceProviderId||string||
|    sex||string||
|    status||string||
|    updateBy||string||
|    updateTime||string||
|    userId||integer||
|    userName||string||
|    userType||string||
|  token||string||
|  userid||integer(int64)||
|  username||string||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {
"expireTime": 0,
"ipaddr": "",
"loginTime": 0,
"permissions": [],
"roles": [],
"sysUser": {
"admin": true,
"avatar": "",
"createBy": "",
"createTime": "",
"delFlag": "",
"dept": {
"ancestors": "",
"children": [],
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"deptName": "",
"email": "",
"leader": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"phone": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
},
"deptId": 0,
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"loginIp": "",
"nickName": "",
"params": {},
"password": "",
"phonenumber": "",
"postIds": [],
"remark": "",
"roleId": 0,
"roleIds": [],
"roles": [
{
"admin": true,
"createBy": "",
"createTime": "",
"dataScope": "",
"delFlag": "",
"deptCheckStrictly": true,
"deptIds": [],
"flag": true,
"menuCheckStrictly": true,
"menuIds": [],
"params": {},
"remark": "",
"roleId": 0,
"roleKey": "",
"roleName": "",
"roleSort": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
],
"searchValue": "",
"serviceProviderId": "",
"sex": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userId": 0,
"userName": "",
"userType": ""
},
"token": "",
"userid": 0,
"username": ""
},
"msg": ""
}
```
## list
**接口地址**:`/system/user/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dept.deptName||query|true|string||
|dept.orderNum||query|true|string||
|roles[0].roleKey||query|true|string||
|roles[0].roleName||query|true|string||
|roles[0].roleSort||query|true|string||
|userName||query|true|string||
|admin||query|false|boolean||
|avatar||query|false|string||
|createBy||query|false|string||
|createTime||query|false|string(date-time)||
|delFlag||query|false|string||
|dept.ancestors||query|false|string||
|dept.createBy||query|false|string||
|dept.createTime||query|false|string(date-time)||
|dept.delFlag||query|false|string||
|dept.deptId||query|false|integer(int64)||
|dept.email||query|false|string||
|dept.leader||query|false|string||
|dept.params||query|false|object||
|dept.parentId||query|false|integer(int64)||
|dept.parentName||query|false|string||
|dept.phone||query|false|string||
|dept.remark||query|false|string||
|dept.searchValue||query|false|string||
|dept.status||query|false|string||
|dept.updateBy||query|false|string||
|dept.updateTime||query|false|string(date-time)||
|deptId||query|false|integer(int64)||
|email||query|false|string||
|enterpriseId||query|false|string||
|enterpriseName||query|false|string||
|loginDate||query|false|string(date-time)||
|loginIp||query|false|string||
|nickName||query|false|string||
|params||query|false|object||
|password||query|false|string||
|phonenumber||query|false|string||
|postIds||query|false|array|integer|
|remark||query|false|string||
|roleId||query|false|integer(int64)||
|roleIds||query|false|array|integer|
|roles[0].admin||query|false|boolean||
|roles[0].createBy||query|false|string||
|roles[0].createTime||query|false|string(date-time)||
|roles[0].dataScope||query|false|string||
|roles[0].delFlag||query|false|string||
|roles[0].deptCheckStrictly||query|false|boolean||
|roles[0].deptIds||query|false|array|integer|
|roles[0].flag||query|false|boolean||
|roles[0].menuCheckStrictly||query|false|boolean||
|roles[0].menuIds||query|false|array|integer|
|roles[0].params||query|false|object||
|roles[0].remark||query|false|string||
|roles[0].roleId||query|false|integer(int64)||
|roles[0].searchValue||query|false|string||
|roles[0].status||query|false|string||
|roles[0].updateBy||query|false|string||
|roles[0].updateTime||query|false|string(date-time)||
|searchValue||query|false|string||
|serviceProviderId||query|false|string||
|sex||query|false|string||
|status||query|false|string||
|updateBy||query|false|string||
|updateTime||query|false|string(date-time)||
|userId||query|false|integer(int64)||
|userType||query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## 客户经理列表
**接口地址**:`/system/user/list/{roleKay}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|roleKay|roleKay|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## register
**接口地址**:`/system/user/register`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"avatar": "",
"createBy": "",
"createTime": "",
"delFlag": "",
"dept": {
"ancestors": "",
"children": [],
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"deptName": "",
"email": "",
"leader": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"phone": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
},
"deptId": 0,
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"loginIp": "",
"nickName": "",
"params": {},
"password": "",
"phonenumber": "",
"postIds": [],
"remark": "",
"roleId": 0,
"roleIds": [],
"roles": [
{
"createBy": "",
"createTime": "",
"dataScope": "",
"delFlag": "",
"deptCheckStrictly": true,
"deptIds": [],
"flag": true,
"menuCheckStrictly": true,
"menuIds": [],
"params": {},
"remark": "",
"roleId": 0,
"roleKey": "",
"roleName": "",
"roleSort": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
],
"searchValue": "",
"serviceProviderId": "",
"sex": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userId": 0,
"userName": "",
"userType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|sysUser|sysUser|body|true|SysUserReq|SysUserReq|
|  avatar|||false|string||
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  delFlag|||false|string||
|  dept|||false|SysDept|SysDept|
|    ancestors|||false|string||
|    children|||false|array|SysDept|
|    createBy|||false|string||
|    createTime|||false|string||
|    delFlag|||false|string||
|    deptId|||false|integer||
|    deptName|||true|string||
|    email|||false|string||
|    leader|||false|string||
|    orderNum|||true|string||
|    params|||false|object||
|    parentId|||false|integer||
|    parentName|||false|string||
|    phone|||false|string||
|    remark|||false|string||
|    searchValue|||false|string||
|    status|||false|string||
|    updateBy|||false|string||
|    updateTime|||false|string||
|  deptId|||false|integer(int64)||
|  email|||false|string||
|  enterpriseId|||false|string||
|  enterpriseName|||false|string||
|  loginDate|||false|string(date-time)||
|  loginIp|||false|string||
|  nickName|||false|string||
|  params|||false|object||
|  password|||false|string||
|  phonenumber|||false|string||
|  postIds|||false|array|integer|
|  remark|||false|string||
|  roleId|||false|integer(int64)||
|  roleIds|||false|array|integer|
|  roles|||false|array|SysRoleReq|
|    createBy|||false|string||
|    createTime|||false|string||
|    dataScope|||false|string||
|    delFlag|||false|string||
|    deptCheckStrictly|||false|boolean||
|    deptIds|||false|array|integer|
|    flag|||false|boolean||
|    menuCheckStrictly|||false|boolean||
|    menuIds|||false|array|integer|
|    params|||false|object||
|    remark|||false|string||
|    roleId|||false|integer||
|    roleKey|||true|string||
|    roleName|||true|string||
|    roleSort|||true|string||
|    searchValue|||false|string||
|    status|||false|string||
|    updateBy|||false|string||
|    updateTime|||false|string||
|  searchValue|||false|string||
|  serviceProviderId|||false|string||
|  sex|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
|  userId|||false|integer(int64)||
|  userName|||true|string||
|  userType|||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«boolean»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||boolean||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": true,
"msg": ""
}
```
## resetPwd
**接口地址**:`/system/user/resetPwd`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"avatar": "",
"createBy": "",
"createTime": "",
"delFlag": "",
"dept": {
"ancestors": "",
"children": [],
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"deptName": "",
"email": "",
"leader": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"phone": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
},
"deptId": 0,
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"loginIp": "",
"nickName": "",
"params": {},
"password": "",
"phonenumber": "",
"postIds": [],
"remark": "",
"roleId": 0,
"roleIds": [],
"roles": [
{
"createBy": "",
"createTime": "",
"dataScope": "",
"delFlag": "",
"deptCheckStrictly": true,
"deptIds": [],
"flag": true,
"menuCheckStrictly": true,
"menuIds": [],
"params": {},
"remark": "",
"roleId": 0,
"roleKey": "",
"roleName": "",
"roleSort": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
],
"searchValue": "",
"serviceProviderId": "",
"sex": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userId": 0,
"userName": "",
"userType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|user|user|body|true|SysUserReq|SysUserReq|
|  avatar|||false|string||
|  createBy|||false|string||
|  createTime|||false|string(date-time)||
|  delFlag|||false|string||
|  dept|||false|SysDept|SysDept|
|    ancestors|||false|string||
|    children|||false|array|SysDept|
|    createBy|||false|string||
|    createTime|||false|string||
|    delFlag|||false|string||
|    deptId|||false|integer||
|    deptName|||true|string||
|    email|||false|string||
|    leader|||false|string||
|    orderNum|||true|string||
|    params|||false|object||
|    parentId|||false|integer||
|    parentName|||false|string||
|    phone|||false|string||
|    remark|||false|string||
|    searchValue|||false|string||
|    status|||false|string||
|    updateBy|||false|string||
|    updateTime|||false|string||
|  deptId|||false|integer(int64)||
|  email|||false|string||
|  enterpriseId|||false|string||
|  enterpriseName|||false|string||
|  loginDate|||false|string(date-time)||
|  loginIp|||false|string||
|  nickName|||false|string||
|  params|||false|object||
|  password|||false|string||
|  phonenumber|||false|string||
|  postIds|||false|array|integer|
|  remark|||false|string||
|  roleId|||false|integer(int64)||
|  roleIds|||false|array|integer|
|  roles|||false|array|SysRoleReq|
|    createBy|||false|string||
|    createTime|||false|string||
|    dataScope|||false|string||
|    delFlag|||false|string||
|    deptCheckStrictly|||false|boolean||
|    deptIds|||false|array|integer|
|    flag|||false|boolean||
|    menuCheckStrictly|||false|boolean||
|    menuIds|||false|array|integer|
|    params|||false|object||
|    remark|||false|string||
|    roleId|||false|integer||
|    roleKey|||true|string||
|    roleName|||true|string||
|    roleSort|||true|string||
|    searchValue|||false|string||
|    status|||false|string||
|    updateBy|||false|string||
|    updateTime|||false|string||
|  searchValue|||false|string||
|  serviceProviderId|||false|string||
|  sex|||false|string||
|  status|||false|string||
|  updateBy|||false|string||
|  updateTime|||false|string(date-time)||
|  userId|||false|integer(int64)||
|  userName|||true|string||
|  userType|||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## resetUserPwd
**接口地址**:`/system/user/resetUserPwd`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|password|password|query|true|string||
|userName|userName|query|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«object»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||object||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {},
"msg": ""
}
```
## userInfo
**接口地址**:`/system/user/userInfo/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«SysUser»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||SysUserRes|SysUserRes|
|  admin||boolean||
|  avatar||string||
|  createBy||string||
|  createTime||string(date-time)||
|  delFlag||string||
|  dept||SysDept|SysDept|
|    ancestors||string||
|    children||array|SysDept|
|    createBy||string||
|    createTime||string||
|    delFlag||string||
|    deptId||integer||
|    deptName||string||
|    email||string||
|    leader||string||
|    orderNum||string||
|    params||object||
|    parentId||integer||
|    parentName||string||
|    phone||string||
|    remark||string||
|    searchValue||string||
|    status||string||
|    updateBy||string||
|    updateTime||string||
|  deptId||integer(int64)||
|  email||string||
|  enterpriseId||string||
|  enterpriseName||string||
|  loginDate||string(date-time)||
|  loginIp||string||
|  nickName||string||
|  params||object||
|  password||string||
|  phonenumber||string||
|  postIds||array|integer|
|  remark||string||
|  roleId||integer(int64)||
|  roleIds||array|integer|
|  roles||array|SysRoleRes|
|    admin||boolean||
|    createBy||string||
|    createTime||string||
|    dataScope||string||
|    delFlag||string||
|    deptCheckStrictly||boolean||
|    deptIds||array|integer|
|    flag||boolean||
|    menuCheckStrictly||boolean||
|    menuIds||array|integer|
|    params||object||
|    remark||string||
|    roleId||integer||
|    roleKey||string||
|    roleName||string||
|    roleSort||string||
|    searchValue||string||
|    status||string||
|    updateBy||string||
|    updateTime||string||
|  searchValue||string||
|  serviceProviderId||string||
|  sex||string||
|  status||string||
|  updateBy||string||
|  updateTime||string(date-time)||
|  userId||integer(int64)||
|  userName||string||
|  userType||string||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {
"admin": true,
"avatar": "",
"createBy": "",
"createTime": "",
"delFlag": "",
"dept": {
"ancestors": "",
"children": [],
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"deptName": "",
"email": "",
"leader": "",
"orderNum": "",
"params": {},
"parentId": 0,
"parentName": "",
"phone": "",
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
},
"deptId": 0,
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"loginIp": "",
"nickName": "",
"params": {},
"password": "",
"phonenumber": "",
"postIds": [],
"remark": "",
"roleId": 0,
"roleIds": [],
"roles": [
{
"admin": true,
"createBy": "",
"createTime": "",
"dataScope": "",
"delFlag": "",
"deptCheckStrictly": true,
"deptIds": [],
"flag": true,
"menuCheckStrictly": true,
"menuIds": [],
"params": {},
"remark": "",
"roleId": 0,
"roleKey": "",
"roleName": "",
"roleSort": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
],
"searchValue": "",
"serviceProviderId": "",
"sex": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userId": 0,
"userName": "",
"userType": ""
},
"msg": ""
}
```
## remove
**接口地址**:`/system/user/{userIds}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|userIds|userIds|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## getInfo
**接口地址**:`/system/user/{userId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|userId|userId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# sys-user-online-controller
## list
**接口地址**:`/system/online/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ipaddr|ipaddr|query|false|string||
|userName|userName|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## forceLogout
**接口地址**:`/system/online/{tokenId}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|tokenId|tokenId|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 服务商类型相关接口
## 新增服务商类型
**接口地址**:`/system/provider/type/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"dictLabel": "",
"dictType": "",
"remark": "",
"status": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dictDataDto|dictDataDto|body|true|服务商类型标签|服务商类型标签|
|  dictLabel|类型名称||false|string||
|  dictType|固定值 service_provider_type||false|string||
|  remark|备注||false|string||
|  status|状态||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查看服务商类型详情
**接口地址**:`/system/provider/type/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|SysDictData|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|createBy||string||
|createTime||string(date-time)|string(date-time)|
|cssClass||string||
|dictCode||integer(int64)|integer(int64)|
|dictLabel||string||
|dictSort||integer(int64)|integer(int64)|
|dictType||string||
|dictValue||string||
|isDefault||string||
|listClass||string||
|params||object||
|remark||string||
|searchValue||string||
|status||string||
|updateBy||string||
|updateTime||string(date-time)|string(date-time)|
**响应示例**:
```javascript
{
"createBy": "",
"createTime": "",
"cssClass": "",
"dictCode": 0,
"dictLabel": "",
"dictSort": 0,
"dictType": "",
"dictValue": "",
"isDefault": "",
"listClass": "",
"params": {},
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
```
## 服务商类型列表
**接口地址**:`/system/provider/type/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 服务商类型分页列表
**接口地址**:`/system/provider/type/pagelist`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dictLabel|类型名称|query|false|string||
|dictType|固定值 service_provider_type|query|false|string||
|remark|备注|query|false|string||
|status|状态|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«SysDictData»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|SysDictData|
|  createBy||string||
|  createTime||string(date-time)||
|  cssClass||string||
|  dictCode||integer(int64)||
|  dictLabel||string||
|  dictSort||integer(int64)||
|  dictType||string||
|  dictValue||string||
|  isDefault||string||
|  listClass||string||
|  params||object||
|  remark||string||
|  searchValue||string||
|  status||string||
|  updateBy||string||
|  updateTime||string(date-time)||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"createBy": "",
"createTime": "",
"cssClass": "",
"dictCode": 0,
"dictLabel": "",
"dictSort": 0,
"dictType": "",
"dictValue": "",
"isDefault": "",
"listClass": "",
"params": {},
"remark": "",
"searchValue": "",
"status": "",
"updateBy": "",
"updateTime": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 修改服务商类型状态
**接口地址**:`/system/provider/type/status/{code}/{status}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|code|code|path|true|integer(int64)||
|status|status|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 修改服务商类型
**接口地址**:`/system/provider/type/update`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"dictCode": 0,
"dictLabel": "",
"dictType": "",
"remark": "",
"status": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dictDataDto|dictDataDto|body|true|服务商类型标签修改|服务商类型标签修改|
|  dictCode|字典主键||false|integer(int64)||
|  dictLabel|字典标签||false|string||
|  dictType|固定值 service_provider_type||false|string||
|  remark|备注||false|string||
|  status|状态||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 营销门户用户接口
## 营销门户获取用户信息
**接口地址**:`/system/pre/user/getInfo`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 营销门户修改密码
**接口地址**:`/system/pre/user/updatePwd`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"confirmPassword": "",
"newPassword": "",
"oldPassword": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|updatePwdDto|updatePwdDto|body|true|UpdatePwdDto|UpdatePwdDto|
|  confirmPassword|||false|string||
|  newPassword|||false|string||
|  oldPassword|||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 业务模块接口文档
**简介**:系统模块接口文档
**HOST**:xxxx.xxxx.xxxx
**联系人**:
**Version**:
**接口路径**:/business/v2/api-docs
[TOC]
# config-controller
## 营销配置新增
**接口地址**:`/business/config/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|bannerBackImgLink|背景链接 500|query|false|string||
|bannerButtonArray|按钮jsonarray 1000|query|false|string||
|bannerVedioLink|视频链接 500|query|false|string||
|configDesc|营销产品介绍 500|query|false|string||
|configName|营销产品名称 32|query|false|string||
|configType|营销配置类型0产品1解决方案|query|false|string||
|id|主键|query|false|string||
|isMould|是否模板|query|false|string||
|navigationConfigs[0].configId|配置id|query|false|string||
|navigationConfigs[0].elementImg|组件图 200|query|false|string||
|navigationConfigs[0].elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}|query|false|string||
|navigationConfigs[0].elementVos[0].childElementType|子组件类型0二维码1按钮|query|false|string||
|navigationConfigs[0].elementVos[0].createBy|创建者|query|false|integer(int64)||
|navigationConfigs[0].elementVos[0].createTime|创建时间|query|false|string(date-time)||
|navigationConfigs[0].elementVos[0].delStatus|是否删除0-正常1-已删除)|query|false|string||
|navigationConfigs[0].elementVos[0].elementButtonLink|子组件按钮链接 200|query|false|string||
|navigationConfigs[0].elementVos[0].elementButtonName|子组件组件按钮名称 64|query|false|string||
|navigationConfigs[0].elementVos[0].elementDesc|组件描述 500|query|false|string||
|navigationConfigs[0].elementVos[0].elementImg|组件图片 200|query|false|string||
|navigationConfigs[0].elementVos[0].elementName|组件名称 32|query|false|string||
|navigationConfigs[0].elementVos[0].id|id|query|false|string||
|navigationConfigs[0].elementVos[0].navigationId|导航id|query|false|string||
|navigationConfigs[0].elementVos[0].qrCode|子组件二维码字符串 250|query|false|string||
|navigationConfigs[0].elementVos[0].updateBy|更新者|query|false|integer(int64)||
|navigationConfigs[0].elementVos[0].updateTime|更新时间|query|false|string(date-time)||
|navigationConfigs[0].id|主键|query|false|string||
|navigationConfigs[0].navigationdDesc|导航描述 1000|query|false|string||
|navigationConfigs[0].navigationlink|导航链接|query|false|string||
|navigationConfigs[0].navigationName|导航名称 30|query|false|string||
|navigationConfigs[0].navigationSort|次序|query|false|string||
|navigationConfigs[0].navigationType|导航类型0链接跳转1组件|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 营销配置详情
**接口地址**:`/business/config/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|ConfigVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|bannerBackImgLink|背景链接|string||
|bannerButtonArray|按钮jsonarray|string||
|bannerVedioLink|视频链接|string||
|configDesc|营销产品介绍|string||
|configName|营销产品名称|string||
|configType|营销配置类型0产品1解决方案|string||
|createBy|创建者|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|id|主键|string||
|navigationConfigs|组件list|array|产品营销导航配置新增、修改请求体|
|  configId|配置id|string||
|  elementImg|组件图 200|string||
|  elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}|string||
|  elementVos|导航组件list|array|营销配置导航组件表|
|    childElementType|子组件类型0二维码1按钮|string||
|    createBy|创建者|integer||
|    createTime|创建时间|string||
|    delStatus|是否删除0-正常1-已删除)|string||
|    elementButtonLink|子组件按钮链接 200|string||
|    elementButtonName|子组件组件按钮名称 64|string||
|    elementDesc|组件描述 500|string||
|    elementImg|组件图片 200|string||
|    elementName|组件名称 32|string||
|    id|id|string||
|    navigationId|导航id|string||
|    qrCode|子组件二维码字符串 250|string||
|    updateBy|更新者|integer||
|    updateTime|更新时间|string||
|  id|主键|string||
|  navigationName|导航名称 30|string||
|  navigationSort|次序|string||
|  navigationType|导航类型0链接跳转1组件|string||
|  navigationdDesc|导航描述 1000|string||
|  navigationlink|导航链接|string||
|updateBy|更新者|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
**响应示例**:
```javascript
{
"bannerBackImgLink": "",
"bannerButtonArray": "",
"bannerVedioLink": "",
"configDesc": "",
"configName": "",
"configType": "",
"createBy": 0,
"createTime": "",
"id": "",
"navigationConfigs": [
{
"configId": "",
"elementImg": "",
"elementType": "",
"elementVos": [
{
"childElementType": "",
"createBy": 0,
"createTime": "",
"delStatus": "",
"elementButtonLink": "",
"elementButtonName": "",
"elementDesc": "",
"elementImg": "",
"elementName": "",
"id": "",
"navigationId": "",
"qrCode": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"navigationName": "",
"navigationSort": "",
"navigationType": "",
"navigationdDesc": "",
"navigationlink": ""
}
],
"updateBy": 0,
"updateTime": ""
}
```
## 营销配置详情
**接口地址**:`/business/config/home`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|ConfigVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|bannerBackImgLink|背景链接|string||
|bannerButtonArray|按钮jsonarray|string||
|bannerVedioLink|视频链接|string||
|configDesc|营销产品介绍|string||
|configName|营销产品名称|string||
|configType|营销配置类型0产品1解决方案|string||
|createBy|创建者|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|id|主键|string||
|navigationConfigs|组件list|array|产品营销导航配置新增、修改请求体|
|  configId|配置id|string||
|  elementImg|组件图 200|string||
|  elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}|string||
|  elementVos|导航组件list|array|营销配置导航组件表|
|    childElementType|子组件类型0二维码1按钮|string||
|    createBy|创建者|integer||
|    createTime|创建时间|string||
|    delStatus|是否删除0-正常1-已删除)|string||
|    elementButtonLink|子组件按钮链接 200|string||
|    elementButtonName|子组件组件按钮名称 64|string||
|    elementDesc|组件描述 500|string||
|    elementImg|组件图片 200|string||
|    elementName|组件名称 32|string||
|    id|id|string||
|    navigationId|导航id|string||
|    qrCode|子组件二维码字符串 250|string||
|    updateBy|更新者|integer||
|    updateTime|更新时间|string||
|  id|主键|string||
|  navigationName|导航名称 30|string||
|  navigationSort|次序|string||
|  navigationType|导航类型0链接跳转1组件|string||
|  navigationdDesc|导航描述 1000|string||
|  navigationlink|导航链接|string||
|updateBy|更新者|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
**响应示例**:
```javascript
{
"bannerBackImgLink": "",
"bannerButtonArray": "",
"bannerVedioLink": "",
"configDesc": "",
"configName": "",
"configType": "",
"createBy": 0,
"createTime": "",
"id": "",
"navigationConfigs": [
{
"configId": "",
"elementImg": "",
"elementType": "",
"elementVos": [
{
"childElementType": "",
"createBy": 0,
"createTime": "",
"delStatus": "",
"elementButtonLink": "",
"elementButtonName": "",
"elementDesc": "",
"elementImg": "",
"elementName": "",
"id": "",
"navigationId": "",
"qrCode": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"navigationName": "",
"navigationSort": "",
"navigationType": "",
"navigationdDesc": "",
"navigationlink": ""
}
],
"updateBy": 0,
"updateTime": ""
}
```
## 营销配置
**接口地址**:`/business/config/pageList`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«ConfigVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|ConfigVo|
|  bannerBackImgLink|背景链接|string||
|  bannerButtonArray|按钮jsonarray|string||
|  bannerVedioLink|视频链接|string||
|  configDesc|营销产品介绍|string||
|  configName|营销产品名称|string||
|  configType|营销配置类型0产品1解决方案|string||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  id|主键|string||
|  navigationConfigs|组件list|array|产品营销导航配置新增、修改请求体|
|    configId|配置id|string||
|    elementImg|组件图 200|string||
|    elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}|string||
|    elementVos|导航组件list|array|营销配置导航组件表|
|      childElementType|子组件类型0二维码1按钮|string||
|      createBy|创建者|integer||
|      createTime|创建时间|string||
|      delStatus|是否删除0-正常1-已删除)|string||
|      elementButtonLink|子组件按钮链接 200|string||
|      elementButtonName|子组件组件按钮名称 64|string||
|      elementDesc|组件描述 500|string||
|      elementImg|组件图片 200|string||
|      elementName|组件名称 32|string||
|      id|id|string||
|      navigationId|导航id|string||
|      qrCode|子组件二维码字符串 250|string||
|      updateBy|更新者|integer||
|      updateTime|更新时间|string||
|    id|主键|string||
|    navigationName|导航名称 30|string||
|    navigationSort|次序|string||
|    navigationType|导航类型0链接跳转1组件|string||
|    navigationdDesc|导航描述 1000|string||
|    navigationlink|导航链接|string||
|  updateBy|更新者|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"bannerBackImgLink": "",
"bannerButtonArray": "",
"bannerVedioLink": "",
"configDesc": "",
"configName": "",
"configType": "",
"createBy": 0,
"createTime": "",
"id": "",
"navigationConfigs": [
{
"configId": "",
"elementImg": "",
"elementType": "",
"elementVos": [
{
"childElementType": "",
"createBy": 0,
"createTime": "",
"delStatus": "",
"elementButtonLink": "",
"elementButtonName": "",
"elementDesc": "",
"elementImg": "",
"elementName": "",
"id": "",
"navigationId": "",
"qrCode": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"navigationName": "",
"navigationSort": "",
"navigationType": "",
"navigationdDesc": "",
"navigationlink": ""
}
],
"updateBy": 0,
"updateTime": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 营销配置编辑
**接口地址**:`/business/config/update`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|bannerBackImgLink|背景链接 500|query|false|string||
|bannerButtonArray|按钮jsonarray 1000|query|false|string||
|bannerVedioLink|视频链接 500|query|false|string||
|configDesc|营销产品介绍 500|query|false|string||
|configName|营销产品名称 32|query|false|string||
|configType|营销配置类型0产品1解决方案|query|false|string||
|id|主键|query|false|string||
|isMould|是否模板|query|false|string||
|navigationConfigs[0].configId|配置id|query|false|string||
|navigationConfigs[0].elementImg|组件图 200|query|false|string||
|navigationConfigs[0].elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}|query|false|string||
|navigationConfigs[0].elementVos[0].childElementType|子组件类型0二维码1按钮|query|false|string||
|navigationConfigs[0].elementVos[0].createBy|创建者|query|false|integer(int64)||
|navigationConfigs[0].elementVos[0].createTime|创建时间|query|false|string(date-time)||
|navigationConfigs[0].elementVos[0].delStatus|是否删除0-正常1-已删除)|query|false|string||
|navigationConfigs[0].elementVos[0].elementButtonLink|子组件按钮链接 200|query|false|string||
|navigationConfigs[0].elementVos[0].elementButtonName|子组件组件按钮名称 64|query|false|string||
|navigationConfigs[0].elementVos[0].elementDesc|组件描述 500|query|false|string||
|navigationConfigs[0].elementVos[0].elementImg|组件图片 200|query|false|string||
|navigationConfigs[0].elementVos[0].elementName|组件名称 32|query|false|string||
|navigationConfigs[0].elementVos[0].id|id|query|false|string||
|navigationConfigs[0].elementVos[0].navigationId|导航id|query|false|string||
|navigationConfigs[0].elementVos[0].qrCode|子组件二维码字符串 250|query|false|string||
|navigationConfigs[0].elementVos[0].updateBy|更新者|query|false|integer(int64)||
|navigationConfigs[0].elementVos[0].updateTime|更新时间|query|false|string(date-time)||
|navigationConfigs[0].id|主键|query|false|string||
|navigationConfigs[0].navigationdDesc|导航描述 1000|query|false|string||
|navigationConfigs[0].navigationlink|导航链接|query|false|string||
|navigationConfigs[0].navigationName|导航名称 30|query|false|string||
|navigationConfigs[0].navigationSort|次序|query|false|string||
|navigationConfigs[0].navigationType|导航类型0链接跳转1组件|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# saas服务管理及租户管理
## 新增saas服务
**接口地址**:`/business/saas/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"belongTo": "",
"belongToId": "",
"belongToName": "",
"effectTime": "",
"remark": "",
"saasCode": "",
"saasName": "",
"uneffectTime": "",
"visitUrl": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|addDto|addDto|body|true|SaasAddDTO|SaasAddDTO|
|  belongTo|0咪咕自有1合作伙伴||false|string||
|  belongToId|合作伙伴id||false|string||
|  belongToName|合作伙伴名称||false|string||
|  effectTime|生效时间||false|string(date-time)||
|  remark|服务介绍-500||false|string||
|  saasCode|服务标识-16||false|string||
|  saasName|服务名称-16||false|string||
|  uneffectTime|失效时间||false|string(date-time)||
|  visitUrl|访问地址-100||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 通过saas服务id查询已开通租户
**接口地址**:`/business/saas/getSaasUser/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«SaasTenant»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|SaasTenant|
|  createBy|创建人id|integer(int64)||
|  createByTime|创建时间|string(date-time)||
|  createTime|开通时间|string(date)||
|  enterpriseId|企业id|string||
|  enterpriseName|企业名称(租户名称)|string||
|  id||string||
|  saasServiceId|saas服务id|string||
|  saasServiceName|saas服务名称|string||
|  status|状态:{0启用1停用}|string||
|  stopTime|停用时间|string(date)||
|  tenantId|租户id|integer(int64)||
|  tenantUserId|用户id|integer(int64)||
|  tenantUserName|用户名|string||
|  tenantUserPassword|用户密码|string||
|  updateBy|修改人id|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"createBy": 0,
"createByTime": "",
"createTime": "",
"enterpriseId": "",
"enterpriseName": "",
"id": "",
"saasServiceId": "",
"saasServiceName": "",
"status": "",
"stopTime": "",
"tenantId": 0,
"tenantUserId": 0,
"tenantUserName": "",
"tenantUserPassword": "",
"updateBy": 0,
"updateTime": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 查询所有saas服务
**接口地址**:`/business/saas/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|belongTo|0咪咕自有1合作伙伴|query|false|string||
|belongToName|合作伙伴名称|query|false|string||
|saasName|服务名称|query|false|string||
|state|状态|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«SaasVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|SaasVo|
|  belongTo|0咪咕自有1合作伙伴|string||
|  belongToId|合作伙伴id|string||
|  belongToName|合作伙伴名称|string||
|  createBy|创建人id|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  deleteStatus||string||
|  effectTime|生效时间|string(date-time)||
|  id||string||
|  remark|服务介绍|string||
|  saasCode|服务标识|string||
|  saasName|服务名称|string||
|  state|状态 0失效1未失效|string||
|  uneffectTime|失效时间|string(date-time)||
|  updateBy|修改人id|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|  visitUrl|访问地址|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"belongTo": "",
"belongToId": "",
"belongToName": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"effectTime": "",
"id": "",
"remark": "",
"saasCode": "",
"saasName": "",
"state": "",
"uneffectTime": "",
"updateBy": 0,
"updateTime": "",
"visitUrl": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 查询所有saas服务无条件不分页
**接口地址**:`/business/saas/listEmpty`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|SaasVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|belongTo|0咪咕自有1合作伙伴|string||
|belongToId|合作伙伴id|string||
|belongToName|合作伙伴名称|string||
|createBy|创建人id|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|deleteStatus||string||
|effectTime|生效时间|string(date-time)|string(date-time)|
|id||string||
|remark|服务介绍|string||
|saasCode|服务标识|string||
|saasName|服务名称|string||
|state|状态 0失效1未失效|string||
|uneffectTime|失效时间|string(date-time)|string(date-time)|
|updateBy|修改人id|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
|visitUrl|访问地址|string||
**响应示例**:
```javascript
[
{
"belongTo": "",
"belongToId": "",
"belongToName": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"effectTime": "",
"id": "",
"remark": "",
"saasCode": "",
"saasName": "",
"state": "",
"uneffectTime": "",
"updateBy": 0,
"updateTime": "",
"visitUrl": ""
}
]
```
## 租户的详情
**接口地址**:`/business/saas/tenant/details/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|SaasTenant|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|createBy|创建人id|integer(int64)|integer(int64)|
|createByTime|创建时间|string(date-time)|string(date-time)|
|createTime|开通时间|string(date)|string(date)|
|enterpriseId|企业id|string||
|enterpriseName|企业名称(租户名称)|string||
|id||string||
|saasServiceId|saas服务id|string||
|saasServiceName|saas服务名称|string||
|status|状态:{0启用1停用}|string||
|stopTime|停用时间|string(date)|string(date)|
|tenantId|租户id|integer(int64)|integer(int64)|
|tenantUserId|用户id|integer(int64)|integer(int64)|
|tenantUserName|用户名|string||
|tenantUserPassword|用户密码|string||
|updateBy|修改人id|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
**响应示例**:
```javascript
{
"createBy": 0,
"createByTime": "",
"createTime": "",
"enterpriseId": "",
"enterpriseName": "",
"id": "",
"saasServiceId": "",
"saasServiceName": "",
"status": "",
"stopTime": "",
"tenantId": 0,
"tenantUserId": 0,
"tenantUserName": "",
"tenantUserPassword": "",
"updateBy": 0,
"updateTime": ""
}
```
## 租户管理查询所有租户
**接口地址**:`/business/saas/tenant/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|enterpriseName|企业名称|query|false|string||
|saasNameId|服务名称ID|query|false|string||
|tenantUserName|用户名|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«SaasTenant»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|SaasTenant|
|  createBy|创建人id|integer(int64)||
|  createByTime|创建时间|string(date-time)||
|  createTime|开通时间|string(date)||
|  enterpriseId|企业id|string||
|  enterpriseName|企业名称(租户名称)|string||
|  id||string||
|  saasServiceId|saas服务id|string||
|  saasServiceName|saas服务名称|string||
|  status|状态:{0启用1停用}|string||
|  stopTime|停用时间|string(date)||
|  tenantId|租户id|integer(int64)||
|  tenantUserId|用户id|integer(int64)||
|  tenantUserName|用户名|string||
|  tenantUserPassword|用户密码|string||
|  updateBy|修改人id|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"createBy": 0,
"createByTime": "",
"createTime": "",
"enterpriseId": "",
"enterpriseName": "",
"id": "",
"saasServiceId": "",
"saasServiceName": "",
"status": "",
"stopTime": "",
"tenantId": 0,
"tenantUserId": 0,
"tenantUserName": "",
"tenantUserPassword": "",
"updateBy": 0,
"updateTime": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 对租户的启用停用
**接口地址**:`/business/saas/tenant/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
|status|status|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 租户的状态验证
**接口地址**:`/business/saas/tenantStatus/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 修改saas服务
**接口地址**:`/business/saas/update/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"belongTo": "",
"belongToId": "",
"belongToName": "",
"effectTime": "",
"remark": "",
"saasName": "",
"uneffectTime": "",
"visitUrl": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
|updateDTO|updateDTO|body|true|SaasUpdateDTO|SaasUpdateDTO|
|  belongTo|0咪咕自有1合作伙伴||false|string||
|  belongToId|合作伙伴id||false|string||
|  belongToName|合作伙伴名称||false|string||
|  effectTime|生效时间||false|string(date-time)||
|  remark|服务介绍-500||false|string||
|  saasName|服务名称-16||false|string||
|  uneffectTime|失效时间||false|string(date-time)||
|  visitUrl|访问地址-100||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 通过id查询saas服务详细信息
**接口地址**:`/business/saas/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|SaasVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|belongTo|0咪咕自有1合作伙伴|string||
|belongToId|合作伙伴id|string||
|belongToName|合作伙伴名称|string||
|createBy|创建人id|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|deleteStatus||string||
|effectTime|生效时间|string(date-time)|string(date-time)|
|id||string||
|remark|服务介绍|string||
|saasCode|服务标识|string||
|saasName|服务名称|string||
|state|状态 0失效1未失效|string||
|uneffectTime|失效时间|string(date-time)|string(date-time)|
|updateBy|修改人id|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
|visitUrl|访问地址|string||
**响应示例**:
```javascript
{
"belongTo": "",
"belongToId": "",
"belongToName": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"effectTime": "",
"id": "",
"remark": "",
"saasCode": "",
"saasName": "",
"state": "",
"uneffectTime": "",
"updateBy": 0,
"updateTime": "",
"visitUrl": ""
}
```
## 删除saas服务
**接口地址**:`/business/saas/{id}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# sdk注册管理
## 新增sdk服务
**接口地址**:`/business/sdk/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"belongToId": "",
"belongToName": "",
"effectTime": "",
"sdkBelongTo": "",
"sdkIntroduce": "",
"sdkName": "",
"sdkUrl": "",
"sdkVersion": "",
"state": "",
"uneffectTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|addDto|addDto|body|true|SdkAddDTO|SdkAddDTO|
|  belongToId|合作伙伴id||false|string||
|  belongToName|合作伙伴名字||false|string||
|  effectTime|生效时间||false|string(date-time)||
|  sdkBelongTo|0咪咕自有1合作伙伴生态成员||false|string||
|  sdkIntroduce|sdk介绍||false|string||
|  sdkName|SDK名称||false|string||
|  sdkUrl|sdk下载地址||false|string||
|  sdkVersion|版本||false|string||
|  state|状态 0失效1有效||false|string||
|  uneffectTime|失效时间||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查询所有sdk服务
**接口地址**:`/business/sdk/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|belongToName|归属公司名称查询|query|false|string||
|sdkBelongTo|0咪咕自有1合作伙伴|query|false|string||
|sdkName|SDK名称|query|false|string||
|state|状态 0失效1有效|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«SdkVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|SdkVo|
|  belongToId||string||
|  belongToName||string||
|  createBy||integer(int64)||
|  createTime||string(date-time)||
|  effectTime|生效时间|string(date-time)||
|  id|主键|string||
|  sdkBelongTo||string||
|  sdkIntroduce||string||
|  sdkName||string||
|  sdkUrl||string||
|  sdkVersion||string||
|  state||string||
|  uneffectTime|失效时间|string(date-time)||
|  updateBy||integer(int64)||
|  updateTime||string(date-time)||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"belongToId": "",
"belongToName": "",
"createBy": 0,
"createTime": "",
"effectTime": "",
"id": "",
"sdkBelongTo": "",
"sdkIntroduce": "",
"sdkName": "",
"sdkUrl": "",
"sdkVersion": "",
"state": "",
"uneffectTime": "",
"updateBy": 0,
"updateTime": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 修改sdk服务
**接口地址**:`/business/sdk/update/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"belongToId": "",
"belongToName": "",
"sdkBelongTo": "",
"sdkIntroduce": "",
"sdkName": "",
"sdkUrl": "",
"sdkVersion": "",
"state": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
|updateDTO|updateDTO|body|true|SdkUpdateDTO|SdkUpdateDTO|
|  belongToId|合作伙伴id||false|string||
|  belongToName|合作伙伴名字||false|string||
|  sdkBelongTo|0咪咕自有1合作伙伴生态成员||false|string||
|  sdkIntroduce|sdk介绍||false|string||
|  sdkName|SDK名称||false|string||
|  sdkUrl|sdk下载地址||false|string||
|  sdkVersion|版本||false|string||
|  state|状态 0失效1有效||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 通过id查询sdk服务详细信息
**接口地址**:`/business/sdk/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|SdkVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|belongToId||string||
|belongToName||string||
|createBy||integer(int64)|integer(int64)|
|createTime||string(date-time)|string(date-time)|
|effectTime|生效时间|string(date-time)|string(date-time)|
|id|主键|string||
|sdkBelongTo||string||
|sdkIntroduce||string||
|sdkName||string||
|sdkUrl||string||
|sdkVersion||string||
|state||string||
|uneffectTime|失效时间|string(date-time)|string(date-time)|
|updateBy||integer(int64)|integer(int64)|
|updateTime||string(date-time)|string(date-time)|
**响应示例**:
```javascript
{
"belongToId": "",
"belongToName": "",
"createBy": 0,
"createTime": "",
"effectTime": "",
"id": "",
"sdkBelongTo": "",
"sdkIntroduce": "",
"sdkName": "",
"sdkUrl": "",
"sdkVersion": "",
"state": "",
"uneffectTime": "",
"updateBy": 0,
"updateTime": ""
}
```
# topic-aif-gw-controller
## countApiCodeByAppCode
**接口地址**:`/business/aifGw/countApiCodeByAppCode`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|apiCode|apiCode|query|true|string||
|appCode|appCode|query|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## countByApiCode
**接口地址**:`/business/aifGw/countByApiCode`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|apiCode|apiCode|query|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|ApiCountVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|apiCode||string||
|count||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"apiCode": "",
"count": 0
}
```
## countByAppCode
**接口地址**:`/business/aifGw/countByAppCode`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|appCode|appCode|query|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## countByTopic
**接口地址**:`/business/aifGw/countByTopic`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|apiCode||query|false|string||
|apiName||query|false|string||
|apiVersion||query|false|string||
|appCode||query|false|string||
|appName||query|false|string||
|filepath||query|false|string||
|id||query|false|string||
|logType||query|false|string||
|resCode||query|false|string||
|timeGwReq||query|false|string||
|timeGwRes||query|false|string||
|timeThirdDuration||query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## create
**接口地址**:`/business/aifGw/create`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|indexName|indexName|query|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## delete
**接口地址**:`/business/aifGw/delete`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|indexName|indexName|query|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## findAll
**接口地址**:`/business/aifGw/findAll`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## findByTopic
**接口地址**:`/business/aifGw/findByTopic`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"apiCode": "",
"apiName": "",
"apiVersion": "",
"appCode": "",
"appName": "",
"filepath": "",
"id": "",
"logType": "",
"resCode": "",
"timeGwReq": "yyyy-MM-dd HH:mm:ss:SSS",
"timeGwRes": "yyyy-MM-dd HH:mm:ss:SSS",
"timeThirdDuration": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|topicAifGw|topicAifGw|body|true|TopicAifGw|TopicAifGw|
|  apiCode|||false|string||
|  apiName|||false|string||
|  apiVersion|||false|string||
|  appCode|||false|string||
|  appName|||false|string||
|  filepath|||false|string||
|  id|||false|string||
|  logType|||false|string||
|  resCode|||false|string||
|  timeGwReq|||false|string||
|  timeGwRes|||false|string||
|  timeThirdDuration|||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 专业领域
## 新增
**接口地址**:`/business/professionalField/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"fieldLevel": "",
"fieldName": "",
"parentId": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|专业领域新增dto|专业领域新增dto|
|  fieldLevel|层级||false|string||
|  fieldName|专业领域名称||false|string||
|  parentId|父级id||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## allTreeselect
**接口地址**:`/business/professionalField/allTreeselect`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取列表
**接口地址**:`/business/professionalField/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|fieldLevel|层级|query|false|string||
|fieldName|专业领域名称|query|false|string||
|parentId|父级id|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«专业领域表»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|专业领域表|
|  children||array|专业领域表|
|  createBy||integer(int64)||
|  createTime||string(date-time)||
|  fieldLevel|层级|string||
|  fieldName|专业领域名称|string||
|  id||string||
|  parentId|父级id|string||
|  updateBy||integer(int64)||
|  updateTime||string(date-time)||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"children": [
{
"children": [
{}
],
"createBy": 0,
"createTime": "",
"fieldLevel": "",
"fieldName": "",
"id": "",
"parentId": "",
"updateBy": 0,
"updateTime": ""
}
],
"createBy": 0,
"createTime": "",
"fieldLevel": "",
"fieldName": "",
"id": "",
"parentId": "",
"updateBy": 0,
"updateTime": ""
}
],
"msg": "",
"total": 0
}
```
## treeselect
**接口地址**:`/business/professionalField/treeselect`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|fieldLevel|层级|query|false|string||
|fieldName|专业领域名称|query|false|string||
|parentId|父级id|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 修改
**接口地址**:`/business/professionalField/update/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"fieldLevel": "",
"fieldName": "",
"parentId": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|专业领域修改dto|专业领域修改dto|
|  fieldLevel|层级||false|string||
|  fieldName|专业领域名称||false|string||
|  parentId|父级id||false|string||
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 删除
**接口地址**:`/business/professionalField/{id}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 专家
## 新增
**接口地址**:`/business/expert`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"certificateNumber": "",
"certificateType": "",
"city": "",
"educationList": [
{
"educationCode": "",
"expertId": "",
"graduateSchool": "",
"graduateTime": "",
"id": "",
"major": ""
}
],
"expertCode": "",
"fileDtos": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"name": "",
"pfList": [
{
"expertId": "",
"id": "",
"professionalFieldId": ""
}
],
"phoneNumber": "",
"status": "",
"titleList": [
{
"createBy": 0,
"createTime": "",
"evaluationTime": "",
"expertId": "",
"expiryTime": "",
"id": "",
"speciality": "",
"title": "",
"updateBy": 0,
"updateTime": ""
}
],
"workUnit": "",
"workYear": 0
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|专家新增对象Dto|专家新增对象Dto|
|  certificateNumber|证件号码||false|string||
|  certificateType|证件类型0工号1身份证2护照||false|string||
|  city|所在城市||false|string||
|  educationList|学历||false|array|学历表|
|    educationCode|学历0专科 1本科 2硕士 3博士 4其他 5高中 6初中 7小学)||false|string||
|    expertId|专家id||false|string||
|    graduateSchool|毕业院校||false|string||
|    graduateTime|毕业时间||false|string||
|    id|||false|string||
|    major|专业||false|string||
|  expertCode|专家编号||false|string||
|  fileDtos|附件||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  name|专家姓名||false|string||
|  pfList|专业领域IDs||false|array|ProfessionalFieldExpertDto|
|    expertId|专家id||false|string||
|    id|id||false|string||
|    professionalFieldId|专业领域id||false|string||
|  phoneNumber|手机号||false|string||
|  status|状态0已入库 1已失效||false|string||
|  titleList|职称列表||false|array|职称表|
|    createBy|||false|integer||
|    createTime|||false|string||
|    evaluationTime|评定时间||false|string||
|    expertId|专家id||false|string||
|    expiryTime|有效期||false|string||
|    id|||false|string||
|    speciality|专业||false|string||
|    title|职称||false|string||
|    updateBy|||false|integer||
|    updateTime|||false|string||
|  workUnit|工作单位||false|string||
|  workYear|行业工作年限||false|integer(int32)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取列表
**接口地址**:`/business/expert/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|name|专家姓名|query|false|string||
|professionalFieldId||query|false|string||
|status|状态0已入库 1已失效|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«专家Vo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|专家Vo|
|  certificateNumber|证件号码|string||
|  certificateType|证件类型0工号1身份证2护照|string||
|  city|所在城市|string||
|  createBy||integer(int64)||
|  createTime||string(date-time)||
|  expertCode|专家编号|string||
|  id||string||
|  name|专家姓名|string||
|  phoneNumber|手机号|string||
|  professionalFieldNames|专业领域名称|array|string|
|  status|状态0已入库 1已失效|string||
|  updateBy||integer(int64)||
|  updateTime||string(date-time)||
|  workUnit|工作单位|string||
|  workYear|行业工作年限|integer(int32)||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"certificateNumber": "",
"certificateType": "",
"city": "",
"createBy": 0,
"createTime": "",
"expertCode": "",
"id": "",
"name": "",
"phoneNumber": "",
"professionalFieldNames": [],
"status": "",
"updateBy": 0,
"updateTime": "",
"workUnit": "",
"workYear": 0
}
],
"msg": "",
"total": 0
}
```
## selectById
**接口地址**:`/business/expert/selectById`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 修改
**接口地址**:`/business/expert/update/{id}`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"certificateNumber": "",
"certificateType": "",
"city": "",
"educationList": [
{
"educationCode": "",
"expertId": "",
"graduateSchool": "",
"graduateTime": "",
"id": "",
"major": ""
}
],
"expertCode": "",
"fileDtos": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"name": "",
"pfList": [
{
"expertId": "",
"id": "",
"professionalFieldId": ""
}
],
"phoneNumber": "",
"status": "",
"titleList": [
{
"createBy": 0,
"createTime": "",
"evaluationTime": "",
"expertId": "",
"expiryTime": "",
"id": "",
"speciality": "",
"title": "",
"updateBy": 0,
"updateTime": ""
}
],
"workUnit": "",
"workYear": 0
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|专家修改对象Dto|专家修改对象Dto|
|  certificateNumber|证件号码||false|string||
|  certificateType|证件类型0工号1身份证2护照||false|string||
|  city|所在城市||false|string||
|  educationList|学历||false|array|学历表|
|    educationCode|学历0专科 1本科 2硕士 3博士 4其他 5高中 6初中 7小学)||false|string||
|    expertId|专家id||false|string||
|    graduateSchool|毕业院校||false|string||
|    graduateTime|毕业时间||false|string||
|    id|||false|string||
|    major|专业||false|string||
|  expertCode|专家编号||false|string||
|  fileDtos|附件||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  name|专家姓名||false|string||
|  pfList|专业领域IDs||false|array|ProfessionalFieldExpertDto|
|    expertId|专家id||false|string||
|    id|id||false|string||
|    professionalFieldId|专业领域id||false|string||
|  phoneNumber|手机号||false|string||
|  status|状态0已入库 1已失效||false|string||
|  titleList|职称列表||false|array|职称表|
|    createBy|||false|integer||
|    createTime|||false|string||
|    evaluationTime|评定时间||false|string||
|    expertId|专家id||false|string||
|    expiryTime|有效期||false|string||
|    id|||false|string||
|    speciality|专业||false|string||
|    title|职称||false|string||
|    updateBy|||false|integer||
|    updateTime|||false|string||
|  workUnit|工作单位||false|string||
|  workYear|行业工作年限||false|integer(int32)||
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 产品相关接口
## 新增
**接口地址**:`/business/product/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"abilities": [
{
"abilityId": "",
"billingRule": "",
"billingType": "",
"billingUnit": "",
"costing": 0,
"cycleUnit": "",
"id": "",
"ladderArray": "",
"productId": "",
"selling": 0
}
],
"changeConfig": true,
"configId": "",
"consoleUrl": "",
"id": "",
"productCatalogId": "",
"productCatalogName": "",
"productConfigDto": {
"bannerBackImgLink": "",
"bannerButtonArray": "",
"bannerVedioLink": "",
"configDesc": "",
"configName": "",
"configType": "",
"id": "",
"isMould": "",
"navigationConfigs": [
{
"configId": "",
"elementImg": "",
"elementType": "",
"elementVos": [
{
"childElementType": "",
"createBy": 0,
"createTime": "",
"delStatus": "",
"elementButtonLink": "",
"elementButtonName": "",
"elementDesc": "",
"elementImg": "",
"elementName": "",
"id": "",
"navigationId": "",
"qrCode": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"navigationName": "",
"navigationSort": "",
"navigationType": "",
"navigationdDesc": "",
"navigationlink": ""
}
]
},
"productDesc": "",
"productEnglishName": "",
"productName": "",
"productStatus": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|productAddDto|productAddDto|body|true|产品新增、修改请求体|产品新增、修改请求体|
|  abilities|能力ids||false|array|产品配置能力新增、修改请求体|
|    abilityId|能力id||false|string||
|    billingRule|计费规则类型0-标准价格1-阶梯价格||false|string||
|    billingType|计费方式类型0按使用量1一次性收费2周期收费||false|string||
|    billingUnit|计价单位0次1流量2容量3时长4人||false|string||
|    costing|成本价格||false|number||
|    cycleUnit|周期单位0年1月2季3日||false|string||
|    id|主键||false|string||
|    ladderArray|阶梯计费价格||false|string||
|    productId|产品id||false|string||
|    selling|销售价格||false|number||
|  changeConfig|营销配置是否修改||false|boolean||
|  configId|营销配置id||false|string||
|  consoleUrl|管理控制台链接 200||false|string||
|  id|主键||false|string||
|  productCatalogId|产品目录id||false|string||
|  productCatalogName|产品目录名称 60||false|string||
|  productConfigDto|营销配置||false|产品配置营销新增、修改请求体|产品配置营销新增、修改请求体|
|    bannerBackImgLink|背景链接 500||false|string||
|    bannerButtonArray|按钮jsonarray 1000||false|string||
|    bannerVedioLink|视频链接 500||false|string||
|    configDesc|营销产品介绍 500||false|string||
|    configName|营销产品名称 32||false|string||
|    configType|营销配置类型0产品1解决方案||false|string||
|    id|主键||false|string||
|    isMould|是否模板||false|string||
|    navigationConfigs|组件list||false|array|产品营销导航配置新增、修改请求体|
|      configId|配置id||false|string||
|      elementImg|组件图 200||false|string||
|      elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}||false|string||
|      elementVos|导航组件list||false|array|营销配置导航组件表|
|        childElementType|子组件类型0二维码1按钮||false|string||
|        createBy|创建者||false|integer||
|        createTime|创建时间||false|string||
|        delStatus|是否删除0-正常1-已删除)||false|string||
|        elementButtonLink|子组件按钮链接 200||false|string||
|        elementButtonName|子组件组件按钮名称 64||false|string||
|        elementDesc|组件描述 500||false|string||
|        elementImg|组件图片 200||false|string||
|        elementName|组件名称 32||false|string||
|        id|id||false|string||
|        navigationId|导航id||false|string||
|        qrCode|子组件二维码字符串 250||false|string||
|        updateBy|更新者||false|integer||
|        updateTime|更新时间||false|string||
|      id|主键||false|string||
|      navigationName|导航名称 30||false|string||
|      navigationSort|次序||false|string||
|      navigationType|导航类型0链接跳转1组件||false|string||
|      navigationdDesc|导航描述 1000||false|string||
|      navigationlink|导航链接||false|string||
|  productDesc|产品介绍 2000||false|string||
|  productEnglishName|产品英文名 200||false|string||
|  productName|产品名称 60||false|string||
|  productStatus|产品状态0未提交、3已创建4已上架5已下架6已失效||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查看详情
**接口地址**:`/business/product/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|ProductVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|approvalId|审批id|string||
|approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|configId|营销配置id|string||
|configVo|营销配置|ConfigVo|ConfigVo|
|  bannerBackImgLink|背景链接|string||
|  bannerButtonArray|按钮jsonarray|string||
|  bannerVedioLink|视频链接|string||
|  configDesc|营销产品介绍|string||
|  configName|营销产品名称|string||
|  configType|营销配置类型0产品1解决方案|string||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  id|主键|string||
|  navigationConfigs|组件list|array|产品营销导航配置新增、修改请求体|
|    configId|配置id|string||
|    elementImg|组件图 200|string||
|    elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}|string||
|    elementVos|导航组件list|array|营销配置导航组件表|
|      childElementType|子组件类型0二维码1按钮|string||
|      createBy|创建者|integer||
|      createTime|创建时间|string||
|      delStatus|是否删除0-正常1-已删除)|string||
|      elementButtonLink|子组件按钮链接 200|string||
|      elementButtonName|子组件组件按钮名称 64|string||
|      elementDesc|组件描述 500|string||
|      elementImg|组件图片 200|string||
|      elementName|组件名称 32|string||
|      id|id|string||
|      navigationId|导航id|string||
|      qrCode|子组件二维码字符串 250|string||
|      updateBy|更新者|integer||
|      updateTime|更新时间|string||
|    id|主键|string||
|    navigationName|导航名称 30|string||
|    navigationSort|次序|string||
|    navigationType|导航类型0链接跳转1组件|string||
|    navigationdDesc|导航描述 1000|string||
|    navigationlink|导航链接|string||
|  updateBy|更新者|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|consoleUrl|管理控制台链接|string||
|createBy|创建者|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|id|主键|string||
|productAbilityVos|能力配置|array|ProductAbilityVo|
|  abilityBelongTo|能力归属0咪咕自有1合作伙伴|string||
|  abilityDownAddress|下载地址|string||
|  abilityId|能力id|string||
|  abilityInvokeAddress|调用地址|string||
|  abilityName|能力名称|string||
|  abilityPlatformId|能力平台id|string||
|  abilityPlatformName|能力平台名称|string||
|  abilityType|能力类型{0API,1SDK2SaaS服务3其他}|string||
|  belongId|能力所属生态成员id|string||
|  belongName|能力所属生态成员或自营名称|string||
|  billingRule|计费规则类型0-标准价格1-阶梯价格)|string||
|  billingType|计费方式类型0按使用量1一次性收费2周期收费|string||
|  billingUnit|计价单位0次1流量2容量3时长4人|string||
|  costing|成本价格|number||
|  cycleUnit|周期单位0年1月2季3日|string||
|  gatewayAbilityId|网关能力id|string||
|  gatewayAbilityName|网关能力名称|string||
|  id|主键|string||
|  ladderArray|阶梯计费价格|string||
|  openMode|能力开通方式|string||
|  productId|产品id|string||
|  selling|销售价格|number||
|  validDate|能力有效期结束时间|string(date-time)||
|  validDateBegin|能力有效期开始时间|string(date-time)||
|  validStatus|能力状态0失效1有效|string||
|productCatalogId|产品目录id|string||
|productCatalogName|产品目录名称|string||
|productDesc|产品介绍|string||
|productEnglishName|产品英文名|string||
|productName|产品名称|string||
|productStatus|产品状态0未提交、1审核中2审核不通过3已创建4已上架5已下架6已失效|string||
|updateBy|更新者|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
|userName|提交人名称|string||
**响应示例**:
```javascript
{
"approvalId": "",
"approvalStatus": "",
"configId": "",
"configVo": {
"bannerBackImgLink": "",
"bannerButtonArray": "",
"bannerVedioLink": "",
"configDesc": "",
"configName": "",
"configType": "",
"createBy": 0,
"createTime": "",
"id": "",
"navigationConfigs": [
{
"configId": "",
"elementImg": "",
"elementType": "",
"elementVos": [
{
"childElementType": "",
"createBy": 0,
"createTime": "",
"delStatus": "",
"elementButtonLink": "",
"elementButtonName": "",
"elementDesc": "",
"elementImg": "",
"elementName": "",
"id": "",
"navigationId": "",
"qrCode": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"navigationName": "",
"navigationSort": "",
"navigationType": "",
"navigationdDesc": "",
"navigationlink": ""
}
],
"updateBy": 0,
"updateTime": ""
},
"consoleUrl": "",
"createBy": 0,
"createTime": "",
"id": "",
"productAbilityVos": [
{
"abilityBelongTo": "",
"abilityDownAddress": "",
"abilityId": "",
"abilityInvokeAddress": "",
"abilityName": "",
"abilityPlatformId": "",
"abilityPlatformName": "",
"abilityType": "",
"belongId": "",
"belongName": "",
"billingRule": "",
"billingType": "",
"billingUnit": "",
"costing": 0,
"cycleUnit": "",
"gatewayAbilityId": "",
"gatewayAbilityName": "",
"id": "",
"ladderArray": "",
"openMode": "",
"productId": "",
"selling": 0,
"validDate": "",
"validDateBegin": "",
"validStatus": ""
}
],
"productCatalogId": "",
"productCatalogName": "",
"productDesc": "",
"productEnglishName": "",
"productName": "",
"productStatus": "",
"updateBy": 0,
"updateTime": "",
"userName": ""
}
```
## 上架
**接口地址**:`/business/product/onShelve/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 产品查询订单
**接口地址**:`/business/product/pageListForOrder`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|approvalCode|审批产品列表查询 1 - 创建审批 2 - 上架审批 3 - 下架审批|query|false|string||
|approvalStatus|产品状态0审核中、1审核通过2审核不通过|query|false|string||
|forShelve|是否上下架操作0是1否|query|false|string||
|productCatalogId|产品目录id|query|false|string||
|productName|产品名称|query|false|string||
|productStatus|产品状态0未提交1上架审核中3已创建4上架审核中6已上架7下架审核中9已下架10已失效|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«ProductVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|ProductVo|
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  configId|营销配置id|string||
|  configVo|营销配置|ConfigVo|ConfigVo|
|    bannerBackImgLink|背景链接|string||
|    bannerButtonArray|按钮jsonarray|string||
|    bannerVedioLink|视频链接|string||
|    configDesc|营销产品介绍|string||
|    configName|营销产品名称|string||
|    configType|营销配置类型0产品1解决方案|string||
|    createBy|创建者|integer||
|    createTime|创建时间|string||
|    id|主键|string||
|    navigationConfigs|组件list|array|产品营销导航配置新增、修改请求体|
|      configId|配置id|string||
|      elementImg|组件图 200|string||
|      elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}|string||
|      elementVos|导航组件list|array|营销配置导航组件表|
|        childElementType|子组件类型0二维码1按钮|string||
|        createBy|创建者|integer||
|        createTime|创建时间|string||
|        delStatus|是否删除0-正常1-已删除)|string||
|        elementButtonLink|子组件按钮链接 200|string||
|        elementButtonName|子组件组件按钮名称 64|string||
|        elementDesc|组件描述 500|string||
|        elementImg|组件图片 200|string||
|        elementName|组件名称 32|string||
|        id|id|string||
|        navigationId|导航id|string||
|        qrCode|子组件二维码字符串 250|string||
|        updateBy|更新者|integer||
|        updateTime|更新时间|string||
|      id|主键|string||
|      navigationName|导航名称 30|string||
|      navigationSort|次序|string||
|      navigationType|导航类型0链接跳转1组件|string||
|      navigationdDesc|导航描述 1000|string||
|      navigationlink|导航链接|string||
|    updateBy|更新者|integer||
|    updateTime|更新时间|string||
|  consoleUrl|管理控制台链接|string||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  id|主键|string||
|  productAbilityVos|能力配置|array|ProductAbilityVo|
|    abilityBelongTo|能力归属0咪咕自有1合作伙伴|string||
|    abilityDownAddress|下载地址|string||
|    abilityId|能力id|string||
|    abilityInvokeAddress|调用地址|string||
|    abilityName|能力名称|string||
|    abilityPlatformId|能力平台id|string||
|    abilityPlatformName|能力平台名称|string||
|    abilityType|能力类型{0API,1SDK2SaaS服务3其他}|string||
|    belongId|能力所属生态成员id|string||
|    belongName|能力所属生态成员或自营名称|string||
|    billingRule|计费规则类型0-标准价格1-阶梯价格)|string||
|    billingType|计费方式类型0按使用量1一次性收费2周期收费|string||
|    billingUnit|计价单位0次1流量2容量3时长4人|string||
|    costing|成本价格|number||
|    cycleUnit|周期单位0年1月2季3日|string||
|    gatewayAbilityId|网关能力id|string||
|    gatewayAbilityName|网关能力名称|string||
|    id|主键|string||
|    ladderArray|阶梯计费价格|string||
|    openMode|能力开通方式|string||
|    productId|产品id|string||
|    selling|销售价格|number||
|    validDate|能力有效期结束时间|string||
|    validDateBegin|能力有效期开始时间|string||
|    validStatus|能力状态0失效1有效|string||
|  productCatalogId|产品目录id|string||
|  productCatalogName|产品目录名称|string||
|  productDesc|产品介绍|string||
|  productEnglishName|产品英文名|string||
|  productName|产品名称|string||
|  productStatus|产品状态0未提交、1审核中2审核不通过3已创建4已上架5已下架6已失效|string||
|  updateBy|更新者|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|  userName|提交人名称|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"approvalId": "",
"approvalStatus": "",
"configId": "",
"configVo": {
"bannerBackImgLink": "",
"bannerButtonArray": "",
"bannerVedioLink": "",
"configDesc": "",
"configName": "",
"configType": "",
"createBy": 0,
"createTime": "",
"id": "",
"navigationConfigs": [
{
"configId": "",
"elementImg": "",
"elementType": "",
"elementVos": [
{
"childElementType": "",
"createBy": 0,
"createTime": "",
"delStatus": "",
"elementButtonLink": "",
"elementButtonName": "",
"elementDesc": "",
"elementImg": "",
"elementName": "",
"id": "",
"navigationId": "",
"qrCode": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"navigationName": "",
"navigationSort": "",
"navigationType": "",
"navigationdDesc": "",
"navigationlink": ""
}
],
"updateBy": 0,
"updateTime": ""
},
"consoleUrl": "",
"createBy": 0,
"createTime": "",
"id": "",
"productAbilityVos": [
{
"abilityBelongTo": "",
"abilityDownAddress": "",
"abilityId": "",
"abilityInvokeAddress": "",
"abilityName": "",
"abilityPlatformId": "",
"abilityPlatformName": "",
"abilityType": "",
"belongId": "",
"belongName": "",
"billingRule": "",
"billingType": "",
"billingUnit": "",
"costing": 0,
"cycleUnit": "",
"gatewayAbilityId": "",
"gatewayAbilityName": "",
"id": "",
"ladderArray": "",
"openMode": "",
"productId": "",
"selling": 0,
"validDate": "",
"validDateBegin": "",
"validStatus": ""
}
],
"productCatalogId": "",
"productCatalogName": "",
"productDesc": "",
"productEnglishName": "",
"productName": "",
"productStatus": "",
"updateBy": 0,
"updateTime": "",
"userName": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 产品查询
**接口地址**:`/business/product/pagelist`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|approvalCode|审批产品列表查询 1 - 创建审批 2 - 上架审批 3 - 下架审批|query|false|string||
|approvalStatus|产品状态0审核中、1审核通过2审核不通过|query|false|string||
|forShelve|是否上下架操作0是1否|query|false|string||
|productCatalogId|产品目录id|query|false|string||
|productName|产品名称|query|false|string||
|productStatus|产品状态0未提交1上架审核中3已创建4上架审核中6已上架7下架审核中9已下架10已失效|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«ProductVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|ProductVo|
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  configId|营销配置id|string||
|  configVo|营销配置|ConfigVo|ConfigVo|
|    bannerBackImgLink|背景链接|string||
|    bannerButtonArray|按钮jsonarray|string||
|    bannerVedioLink|视频链接|string||
|    configDesc|营销产品介绍|string||
|    configName|营销产品名称|string||
|    configType|营销配置类型0产品1解决方案|string||
|    createBy|创建者|integer||
|    createTime|创建时间|string||
|    id|主键|string||
|    navigationConfigs|组件list|array|产品营销导航配置新增、修改请求体|
|      configId|配置id|string||
|      elementImg|组件图 200|string||
|      elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}|string||
|      elementVos|导航组件list|array|营销配置导航组件表|
|        childElementType|子组件类型0二维码1按钮|string||
|        createBy|创建者|integer||
|        createTime|创建时间|string||
|        delStatus|是否删除0-正常1-已删除)|string||
|        elementButtonLink|子组件按钮链接 200|string||
|        elementButtonName|子组件组件按钮名称 64|string||
|        elementDesc|组件描述 500|string||
|        elementImg|组件图片 200|string||
|        elementName|组件名称 32|string||
|        id|id|string||
|        navigationId|导航id|string||
|        qrCode|子组件二维码字符串 250|string||
|        updateBy|更新者|integer||
|        updateTime|更新时间|string||
|      id|主键|string||
|      navigationName|导航名称 30|string||
|      navigationSort|次序|string||
|      navigationType|导航类型0链接跳转1组件|string||
|      navigationdDesc|导航描述 1000|string||
|      navigationlink|导航链接|string||
|    updateBy|更新者|integer||
|    updateTime|更新时间|string||
|  consoleUrl|管理控制台链接|string||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  id|主键|string||
|  productAbilityVos|能力配置|array|ProductAbilityVo|
|    abilityBelongTo|能力归属0咪咕自有1合作伙伴|string||
|    abilityDownAddress|下载地址|string||
|    abilityId|能力id|string||
|    abilityInvokeAddress|调用地址|string||
|    abilityName|能力名称|string||
|    abilityPlatformId|能力平台id|string||
|    abilityPlatformName|能力平台名称|string||
|    abilityType|能力类型{0API,1SDK2SaaS服务3其他}|string||
|    belongId|能力所属生态成员id|string||
|    belongName|能力所属生态成员或自营名称|string||
|    billingRule|计费规则类型0-标准价格1-阶梯价格)|string||
|    billingType|计费方式类型0按使用量1一次性收费2周期收费|string||
|    billingUnit|计价单位0次1流量2容量3时长4人|string||
|    costing|成本价格|number||
|    cycleUnit|周期单位0年1月2季3日|string||
|    gatewayAbilityId|网关能力id|string||
|    gatewayAbilityName|网关能力名称|string||
|    id|主键|string||
|    ladderArray|阶梯计费价格|string||
|    openMode|能力开通方式|string||
|    productId|产品id|string||
|    selling|销售价格|number||
|    validDate|能力有效期结束时间|string||
|    validDateBegin|能力有效期开始时间|string||
|    validStatus|能力状态0失效1有效|string||
|  productCatalogId|产品目录id|string||
|  productCatalogName|产品目录名称|string||
|  productDesc|产品介绍|string||
|  productEnglishName|产品英文名|string||
|  productName|产品名称|string||
|  productStatus|产品状态0未提交、1审核中2审核不通过3已创建4已上架5已下架6已失效|string||
|  updateBy|更新者|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|  userName|提交人名称|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"approvalId": "",
"approvalStatus": "",
"configId": "",
"configVo": {
"bannerBackImgLink": "",
"bannerButtonArray": "",
"bannerVedioLink": "",
"configDesc": "",
"configName": "",
"configType": "",
"createBy": 0,
"createTime": "",
"id": "",
"navigationConfigs": [
{
"configId": "",
"elementImg": "",
"elementType": "",
"elementVos": [
{
"childElementType": "",
"createBy": 0,
"createTime": "",
"delStatus": "",
"elementButtonLink": "",
"elementButtonName": "",
"elementDesc": "",
"elementImg": "",
"elementName": "",
"id": "",
"navigationId": "",
"qrCode": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"navigationName": "",
"navigationSort": "",
"navigationType": "",
"navigationdDesc": "",
"navigationlink": ""
}
],
"updateBy": 0,
"updateTime": ""
},
"consoleUrl": "",
"createBy": 0,
"createTime": "",
"id": "",
"productAbilityVos": [
{
"abilityBelongTo": "",
"abilityDownAddress": "",
"abilityId": "",
"abilityInvokeAddress": "",
"abilityName": "",
"abilityPlatformId": "",
"abilityPlatformName": "",
"abilityType": "",
"belongId": "",
"belongName": "",
"billingRule": "",
"billingType": "",
"billingUnit": "",
"costing": 0,
"cycleUnit": "",
"gatewayAbilityId": "",
"gatewayAbilityName": "",
"id": "",
"ladderArray": "",
"openMode": "",
"productId": "",
"selling": 0,
"validDate": "",
"validDateBegin": "",
"validStatus": ""
}
],
"productCatalogId": "",
"productCatalogName": "",
"productDesc": "",
"productEnglishName": "",
"productName": "",
"productStatus": "",
"updateBy": 0,
"updateTime": "",
"userName": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 撤回
**接口地址**:`/business/product/recall/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 下架
**接口地址**:`/business/product/unShelve/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 修改
**接口地址**:`/business/product/update`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"abilities": [
{
"abilityId": "",
"billingRule": "",
"billingType": "",
"billingUnit": "",
"costing": 0,
"cycleUnit": "",
"id": "",
"ladderArray": "",
"productId": "",
"selling": 0
}
],
"changeConfig": true,
"configId": "",
"consoleUrl": "",
"id": "",
"productCatalogId": "",
"productCatalogName": "",
"productConfigDto": {
"bannerBackImgLink": "",
"bannerButtonArray": "",
"bannerVedioLink": "",
"configDesc": "",
"configName": "",
"configType": "",
"id": "",
"isMould": "",
"navigationConfigs": [
{
"configId": "",
"elementImg": "",
"elementType": "",
"elementVos": [
{
"childElementType": "",
"createBy": 0,
"createTime": "",
"delStatus": "",
"elementButtonLink": "",
"elementButtonName": "",
"elementDesc": "",
"elementImg": "",
"elementName": "",
"id": "",
"navigationId": "",
"qrCode": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"navigationName": "",
"navigationSort": "",
"navigationType": "",
"navigationdDesc": "",
"navigationlink": ""
}
]
},
"productDesc": "",
"productEnglishName": "",
"productName": "",
"productStatus": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|productAddDto|productAddDto|body|true|产品新增、修改请求体|产品新增、修改请求体|
|  abilities|能力ids||false|array|产品配置能力新增、修改请求体|
|    abilityId|能力id||false|string||
|    billingRule|计费规则类型0-标准价格1-阶梯价格||false|string||
|    billingType|计费方式类型0按使用量1一次性收费2周期收费||false|string||
|    billingUnit|计价单位0次1流量2容量3时长4人||false|string||
|    costing|成本价格||false|number||
|    cycleUnit|周期单位0年1月2季3日||false|string||
|    id|主键||false|string||
|    ladderArray|阶梯计费价格||false|string||
|    productId|产品id||false|string||
|    selling|销售价格||false|number||
|  changeConfig|营销配置是否修改||false|boolean||
|  configId|营销配置id||false|string||
|  consoleUrl|管理控制台链接 200||false|string||
|  id|主键||false|string||
|  productCatalogId|产品目录id||false|string||
|  productCatalogName|产品目录名称 60||false|string||
|  productConfigDto|营销配置||false|产品配置营销新增、修改请求体|产品配置营销新增、修改请求体|
|    bannerBackImgLink|背景链接 500||false|string||
|    bannerButtonArray|按钮jsonarray 1000||false|string||
|    bannerVedioLink|视频链接 500||false|string||
|    configDesc|营销产品介绍 500||false|string||
|    configName|营销产品名称 32||false|string||
|    configType|营销配置类型0产品1解决方案||false|string||
|    id|主键||false|string||
|    isMould|是否模板||false|string||
|    navigationConfigs|组件list||false|array|产品营销导航配置新增、修改请求体|
|      configId|配置id||false|string||
|      elementImg|组件图 200||false|string||
|      elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}||false|string||
|      elementVos|导航组件list||false|array|营销配置导航组件表|
|        childElementType|子组件类型0二维码1按钮||false|string||
|        createBy|创建者||false|integer||
|        createTime|创建时间||false|string||
|        delStatus|是否删除0-正常1-已删除)||false|string||
|        elementButtonLink|子组件按钮链接 200||false|string||
|        elementButtonName|子组件组件按钮名称 64||false|string||
|        elementDesc|组件描述 500||false|string||
|        elementImg|组件图片 200||false|string||
|        elementName|组件名称 32||false|string||
|        id|id||false|string||
|        navigationId|导航id||false|string||
|        qrCode|子组件二维码字符串 250||false|string||
|        updateBy|更新者||false|integer||
|        updateTime|更新时间||false|string||
|      id|主键||false|string||
|      navigationName|导航名称 30||false|string||
|      navigationSort|次序||false|string||
|      navigationType|导航类型0链接跳转1组件||false|string||
|      navigationdDesc|导航描述 1000||false|string||
|      navigationlink|导航链接||false|string||
|  productDesc|产品介绍 2000||false|string||
|  productEnglishName|产品英文名 200||false|string||
|  productName|产品名称 60||false|string||
|  productStatus|产品状态0未提交、3已创建4已上架5已下架6已失效||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 企业相关接口
## 认证
**接口地址**:`/business/enterprise/auth`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"address": "",
"approvalId": "",
"approvalStatus": "",
"businessLicense": "",
"businessLicenseName": "",
"businessScope": "",
"contactNum": "",
"createBy": 0,
"createTime": "",
"delFlag": "",
"enterpriseName": "",
"enterpriseType": "",
"legalRepresent": "",
"registeredCapital": 0,
"staffSize": 0,
"templateType": "",
"updateBy": 0,
"updateTime": "",
"userId": 0
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|enterpriseAuthDto|enterpriseAuthDto|body|true|企业认证相关0|企业认证相关0|
|  address|地址 最大长度200||false|string||
|  approvalId|审批id||false|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核||false|string||
|  businessLicense|营业执照 最大长度200||false|string||
|  businessLicenseName|营业执照文件名称 最大长度50||false|string||
|  businessScope|营业范围 最大长度50||false|string||
|  contactNum|联系电话 最大长度16||false|string||
|  createBy|创建者||false|integer(int64)||
|  createTime|创建时间||false|string(date-time)||
|  delFlag|删除标志;0未删除1已删除||false|string||
|  enterpriseName|企业名称 长度1-200||false|string||
|  enterpriseType|企业类型 最大长度2||false|string||
|  legalRepresent|法定代表人 最大长度500||false|string||
|  registeredCapital|注册资本 最大长度14位||false|number||
|  staffSize|人员规模 最大长度4||false|integer(int32)||
|  templateType|统一社会信用代码 长度1-20||false|string||
|  updateBy|更新者||false|integer(int64)||
|  updateTime|更新时间||false|string(date-time)||
|  userId|用户id,生态成员端可以直接从登录信息种获取||false|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查看企业详情
**接口地址**:`/business/enterprise/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 企业列表
**接口地址**:`/business/enterprise/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 企业分页列表
**接口地址**:`/business/enterprise/pageList`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|approvalId|审批id|query|false|string||
|approvalStatus|审批状态 2驳回 1通过 0待审核|query|false|string||
|delFlag|删除标志;0未删除1已删除|query|false|string||
|enterpriseName|企业名称 长度1-200|query|false|string||
|enterpriseType|企业类型 最大长度2|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«企业认证相关»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|企业认证相关|
|  address|地址 最大长度200|string||
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  businessLicense|营业执照 最大长度200|string||
|  businessLicenseName|营业执照文件名称 最大长度50|string||
|  businessScope|营业范围 最大长度50|string||
|  contactNum|联系电话 最大长度16|string||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  delFlag|删除标志;0未删除1已删除|string||
|  enterpriseName|企业名称 长度1-200|string||
|  enterpriseType|企业类型 最大长度2|string||
|  legalRepresent|法定代表人 最大长度500|string||
|  registeredCapital|注册资本 最大长度14位|number||
|  staffSize|人员规模 最大长度4|integer(int32)||
|  templateType|统一社会信用代码 长度1-20|string||
|  updateBy|更新者|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|  userId|用户id,生态成员端可以直接从登录信息种获取|integer(int64)||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"address": "",
"approvalId": "",
"approvalStatus": "",
"businessLicense": "",
"businessLicenseName": "",
"businessScope": "",
"contactNum": "",
"createBy": 0,
"createTime": "",
"delFlag": "",
"enterpriseName": "",
"enterpriseType": "",
"legalRepresent": "",
"registeredCapital": 0,
"staffSize": 0,
"templateType": "",
"updateBy": 0,
"updateTime": "",
"userId": 0
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
# 动态消息controller
## 获取动态消息
**接口地址**:`/business/dataMessage/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|createTime|生成时间|query|false|string(date-time)||
|dataId|数据id|query|false|string||
|dataSource|数据来源|query|false|string||
|id|id|query|false|string||
|messageContent|消息内容|query|false|string||
|messageType|消息类型A0新建工单A1工单流转A2工单关闭B0新建需求单B1需求单流转B2需求单关闭|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«动态信息对象Vo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|动态信息对象Vo|
|  createTime|生成时间|string(date-time)||
|  dataId|数据id|string||
|  dataSource|数据来源|string||
|  id|id|string||
|  messageContent|消息内容|string||
|  messageType|消息类型A0新建工单A1工单流转A2工单关闭B0新建需求单B1需求单流转B2需求单关闭|string||
|  messageTypeName|消息类型A0新建工单A1工单流转A2工单关闭B0新建需求单B1需求单流转B2需求单关闭|string||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"createTime": "",
"dataId": "",
"dataSource": "",
"id": "",
"messageContent": "",
"messageType": "",
"messageTypeName": ""
}
],
"msg": "",
"total": 0
}
```
## 工作台-查询工单动态
**接口地址**:`/business/dataMessage/workOrderList`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«动态信息对象Vo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|动态信息对象Vo|
|  createTime|生成时间|string(date-time)||
|  dataId|数据id|string||
|  dataSource|数据来源|string||
|  id|id|string||
|  messageContent|消息内容|string||
|  messageType|消息类型A0新建工单A1工单流转A2工单关闭B0新建需求单B1需求单流转B2需求单关闭|string||
|  messageTypeName|消息类型A0新建工单A1工单流转A2工单关闭B0新建需求单B1需求单流转B2需求单关闭|string||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"createTime": "",
"dataId": "",
"dataSource": "",
"id": "",
"messageContent": "",
"messageType": "",
"messageTypeName": ""
}
],
"msg": "",
"total": 0
}
```
# 合同回款管理
## 新增回款记录
**接口地址**:`/business/contractReturn/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"amount": "",
"collection": "",
"contractCode": "",
"contractId": "",
"contractName": "",
"payment": "",
"paymentTime": "",
"remark": "",
"state": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|addDto|addDto|body|true|ContractReturnAddDTO|ContractReturnAddDTO|
|  amount|本次回款金额||false|string||
|  collection|收款单位||false|string||
|  contractCode|合同编码||false|string||
|  contractId|回款合同id||false|string||
|  contractName|合同名称||false|string||
|  payment|付款单位||false|string||
|  paymentTime|支付时间||false|string(date-time)||
|  remark|备注||false|string||
|  state|1部分支付2全部支付||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 修改回款记录
**接口地址**:`/business/contractReturn/edit/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"amount": "",
"collection": "",
"contractCode": "",
"contractId": "",
"contractName": "",
"payment": "",
"paymentTime": "",
"remark": "",
"state": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
|updateDTO|updateDTO|body|true|ContractReturnUpdateDTO|ContractReturnUpdateDTO|
|  amount|本次回款金额||false|string||
|  collection|收款单位||false|string||
|  contractCode|合同编码||false|string||
|  contractId|回款合同id||false|string||
|  contractName|合同名称||false|string||
|  payment|付款单位||false|string||
|  paymentTime|支付时间||false|string(date-time)||
|  remark|备注||false|string||
|  state|1部分支付2全部支付||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查询回款记录
**接口地址**:`/business/contractReturn/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|contractCode|合同编码|query|false|string||
|contractName|合同名称|query|false|string||
|payment|付款单位|query|false|string||
|state|回款状态1部分支付2全部支付|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«ContractReturn»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|ContractReturn|
|  amount||string||
|  collection||string||
|  contractCode||string||
|  contractId||string||
|  contractName||string||
|  createBy|创建人id|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  deleteStatus|逻辑删除0正常1删除|string||
|  id|主键|string||
|  payment||string||
|  paymentTime|支付时间|string(date-time)||
|  remark|备注|string||
|  state||string||
|  updateBy|修改人id|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"amount": "",
"collection": "",
"contractCode": "",
"contractId": "",
"contractName": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"id": "",
"payment": "",
"paymentTime": "",
"remark": "",
"state": "",
"updateBy": 0,
"updateTime": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 查看回款记录
**接口地址**:`/business/contractReturn/selectOne`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|ContractReturn|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|amount||string||
|collection||string||
|contractCode||string||
|contractId||string||
|contractName||string||
|createBy|创建人id|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|deleteStatus|逻辑删除0正常1删除|string||
|id|主键|string||
|payment||string||
|paymentTime|支付时间|string(date-time)|string(date-time)|
|remark|备注|string||
|state||string||
|updateBy|修改人id|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
**响应示例**:
```javascript
{
"amount": "",
"collection": "",
"contractCode": "",
"contractId": "",
"contractName": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"id": "",
"payment": "",
"paymentTime": "",
"remark": "",
"state": "",
"updateBy": 0,
"updateTime": ""
}
```
## 删除回款记录
**接口地址**:`/business/contractReturn/{id}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 合同管理
## 生态成员新增合同
**接口地址**:`/business/contract/Coop/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"amount": "",
"belongUser": "",
"belongUserId": 0,
"businessType": "",
"contractCode": "",
"contractFile": "",
"contractFileName": "",
"contractName": "",
"contractType": "",
"customerManager": "",
"customerManagerId": 0,
"purchasingAgent": "",
"remark": "",
"signTime": "",
"supplier": "",
"userContractId": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|addDto|addDto|body|true|ContractCoopAddDTO|ContractCoopAddDTO|
|  amount|合同金额||true|string||
|  belongUser|归属客户名称(合作型时为服务商)||false|string||
|  belongUserId|归属客户id(合作型时为服务商)||false|integer(int64)||
|  businessType|商机获取方式1线下 0线上||false|string||
|  contractCode|合同编码-64||true|string||
|  contractFile|合同文件||true|string||
|  contractFileName|合同文件名称||true|string||
|  contractName|合同名称-64||true|string||
|  contractType|合同类型1客户型2合作型||false|string||
|  customerManager|客户经理-16||true|string||
|  customerManagerId|客户经理id||false|integer(int64)||
|  purchasingAgent|甲方-64||false|string||
|  remark|备注-250||false|string||
|  signTime|合同签订日期||false|string||
|  supplier|乙方-64||false|string||
|  userContractId|关联客户合同id||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 新增合同
**接口地址**:`/business/contract/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"amount": "",
"belongUser": "",
"belongUserId": 0,
"businessType": "",
"contractCode": "",
"contractFile": "",
"contractFileName": "",
"contractName": "",
"contractType": "",
"customerManager": "",
"customerManagerId": 0,
"demandOrderId": [],
"purchasingAgent": "",
"remark": "",
"signTime": "",
"supplier": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|addDto|addDto|body|true|ContractAddDTO|ContractAddDTO|
|  amount|合同金额||true|string||
|  belongUser|归属客户||false|string||
|  belongUserId|归属客户id||false|integer(int64)||
|  businessType|商机获取方式1线下 0线上||false|string||
|  contractCode|合同编码-64||true|string||
|  contractFile|合同文件||true|string||
|  contractFileName|合同文件名称||true|string||
|  contractName|合同名称-64||true|string||
|  contractType|合同类型1客户型2合作型||false|string||
|  customerManager|客户经理-16||true|string||
|  customerManagerId|客户经理id||false|integer(int64)||
|  demandOrderId|获取需求单id||false|array|string|
|  purchasingAgent|甲方-64||false|string||
|  remark|备注-250||false|string||
|  signTime|合同签订日期||false|string||
|  supplier|乙方-64||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 修改合同
**接口地址**:`/business/contract/edit/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"amount": "",
"belongUser": "",
"belongUserId": 0,
"contractCode": "",
"contractFile": "",
"contractFileName": "",
"contractName": "",
"customerManager": "",
"customerManagerId": 0,
"purchasingAgent": "",
"remark": "",
"signTime": "",
"supplier": "",
"userContractId": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
|updateDTO|updateDTO|body|true|ContractUpdateDTO|ContractUpdateDTO|
|  amount|合同金额||false|string||
|  belongUser|归属客户||false|string||
|  belongUserId|归属客户id||false|integer(int64)||
|  contractCode|合同编码||false|string||
|  contractFile|合同文件||false|string||
|  contractFileName|合同文件名称||false|string||
|  contractName|合同名称||false|string||
|  customerManager|客户经理||false|string||
|  customerManagerId|客户经理id||false|integer(int64)||
|  purchasingAgent|甲方||false|string||
|  remark|备注||false|string||
|  signTime|合同签订日期||false|string||
|  supplier|乙方||false|string||
|  userContractId|关联客户合同id||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查询合同
**接口地址**:`/business/contract/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|contractCode|合同编码|query|false|string||
|contractName|合同名称|query|false|string||
|contractType|合同类型1客户型2合作型|query|false|string||
|purchasingAgent|甲方|query|false|string||
|supplier|乙方|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«ContractVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|ContractVo|
|  amount|合同金额|string||
|  belongUser|归属客户|string||
|  belongUserId|归属客户id|integer(int64)||
|  businessType|商机获取方式1线下 0线上|string||
|  contractCode|合同编码|string||
|  contractFile|合同文件|string||
|  contractFileName|合同文件名称|string||
|  contractName|合同名称|string||
|  contractType|合同类型1客户型2合作型|string||
|  createBy|创建人id|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  creator||string||
|  customerManager|客户经理|string||
|  customerManagerId|客户经理id|integer(int64)||
|  deleteStatus|逻辑删除0正常1删除|string||
|  id||string||
|  purchasingAgent|甲方|string||
|  remark|备注|string||
|  signTime|合同签订日期|string||
|  supplier|乙方|string||
|  updateBy|修改人id|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|  updator||string||
|  userContractId|关联客户合同id|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"amount": "",
"belongUser": "",
"belongUserId": 0,
"businessType": "",
"contractCode": "",
"contractFile": "",
"contractFileName": "",
"contractName": "",
"contractType": "",
"createBy": 0,
"createTime": "",
"creator": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"id": "",
"purchasingAgent": "",
"remark": "",
"signTime": "",
"supplier": "",
"updateBy": 0,
"updateTime": "",
"updator": "",
"userContractId": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 查询我的合同
**接口地址**:`/business/contract/mylist`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|amount|合同金额|query|false|string||
|contractCode|合同编码|query|false|string||
|contractName|合同名称|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«ContractVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|ContractVo|
|  amount|合同金额|string||
|  belongUser|归属客户|string||
|  belongUserId|归属客户id|integer(int64)||
|  businessType|商机获取方式1线下 0线上|string||
|  contractCode|合同编码|string||
|  contractFile|合同文件|string||
|  contractFileName|合同文件名称|string||
|  contractName|合同名称|string||
|  contractType|合同类型1客户型2合作型|string||
|  createBy|创建人id|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  creator||string||
|  customerManager|客户经理|string||
|  customerManagerId|客户经理id|integer(int64)||
|  deleteStatus|逻辑删除0正常1删除|string||
|  id||string||
|  purchasingAgent|甲方|string||
|  remark|备注|string||
|  signTime|合同签订日期|string||
|  supplier|乙方|string||
|  updateBy|修改人id|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|  updator||string||
|  userContractId|关联客户合同id|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"amount": "",
"belongUser": "",
"belongUserId": 0,
"businessType": "",
"contractCode": "",
"contractFile": "",
"contractFileName": "",
"contractName": "",
"contractType": "",
"createBy": 0,
"createTime": "",
"creator": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"id": "",
"purchasingAgent": "",
"remark": "",
"signTime": "",
"supplier": "",
"updateBy": 0,
"updateTime": "",
"updator": "",
"userContractId": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 查询合同详细信息
**接口地址**:`/business/contract/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|ContractDetailVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|amount|合同金额|string||
|belongUser|归属客户|string||
|belongUserId|归属客户id|integer(int64)|integer(int64)|
|businessType|商机获取方式1线下 0线上|string||
|contractCode|合同编码|string||
|contractFile|合同文件|string||
|contractFileName|合同文件名称|string||
|contractName|合同名称|string||
|contractType|合同类型1客户型2合作型|string||
|contracts|关联用户合同|array|Contract|
|  amount|合同金额|string||
|  belongUser|归属客户|string||
|  belongUserId|归属客户id|integer(int64)||
|  businessType|商机获取方式1线下 0线上|string||
|  contractCode|合同编码|string||
|  contractFile|合同文件|string||
|  contractFileName|合同文件名称|string||
|  contractName|合同名称|string||
|  contractType|合同类型1客户型2合作型|string||
|  createBy|创建人id|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  customerManager|客户经理|string||
|  customerManagerId|客户经理id|integer(int64)||
|  deleteStatus|逻辑删除0正常1删除|string||
|  id|主键|string||
|  purchasingAgent|甲方|string||
|  remark|备注|string||
|  signTime|合同签订日期|string||
|  supplier|乙方|string||
|  updateBy|修改人id|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|  userContractId|关联客户合同id|string||
|createBy|创建人id|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|customerManager|客户经理|string||
|customerManagerId|客户经理id|integer(int64)|integer(int64)|
|customerVo|归属客户企业信息|客户管理|客户管理|
|  authStatus|企业认证状态 2驳回 1通过 0待审核|string||
|  avatar|用户头像|string||
|  email|用户邮箱|string||
|  enterpriseId|企业id|string||
|  enterpriseName|企业名称|string||
|  loginDate|最后登录时间|string(date-time)||
|  nickName|用户名称|string||
|  phonenumber|手机号码|string||
|  status|帐号状态|string||
|  userId|用户ID|integer(int64)||
|  userName|登录名称|string||
|deleteStatus|逻辑删除0正常1删除|string||
|demand|关联需求单|array|需求单表|
|  clueId|关联线索id|string||
|  company|公司名称|string||
|  createBy|创建人|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  customerManager|客户经理|string||
|  customerManagerId|客户经理id|integer(int64)||
|  deleteStatus|逻辑删除:{0不删除1删除}|string||
|  demandCode|需求单号 用户ID + 年-月-日+三位序列号|string||
|  demandDesc|需求描述|string||
|  demandName|姓名|string||
|  facilitatorId|服务商id|string||
|  feedback|反馈结果|string||
|  id|id|string||
|  origin|0咪咕商机线索1服务商商机线索|string||
|  phoneNum|手机号码|string||
|  relatedId|关联id|string||
|  relatedName|关联名称|string||
|  relatedType|0产品1解决方案|string||
|  remark|备注|string||
|  sellPredict|销售金额预测|number||
|  source|0营销门户创建1系统用户创建|string||
|  status|0已提交1跟进中2已完成|string||
|  transactionStatus|成交状态 0未完成1已完成|string||
|  updateBy|修改人|integer(int64)||
|  updateTime|修改时间|string(date-time)||
|id||string||
|order|关联订单|array|订单表|
|  appId|应用id|string||
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  catalogueName|产品或者解决方案的目录名称|string||
|  contractId|关联的合同id|string||
|  createBy|创建人|integer(int64)||
|  createByName|创建人姓名|string||
|  createTime|创建时间|string(date-time)||
|  customerManager|客户经理|string||
|  customerManagerId|客户经理id|integer(int64)||
|  deleteStatus|逻辑删除:{0不删除1删除}|string||
|  demandSideId|订单需求方id|string||
|  demandSideName|订单需求方name(冗余字段)|string||
|  discountRate|折扣率|number||
|  effectiveTime|生效时间|string(date-time)||
|  expirationTime|到期时间|string(date-time)||
|  id|id|string||
|  orderAmount|订单金额(单位为元,保留两位小数点)|number||
|  orderCode|订单编号,生成规则 DD+年月日时分秒+客户ID|string||
|  orderState|订单状态(0已提交,1审核中2已确认3订单转工单4已完成)|string||
|  productDesc|其他订单-交付内容|string||
|  relatedId|关联id|string||
|  relatedName|关联名称|string||
|  relatedType|订单类型(0表示产品订单,1表示解决方案订单,2表示其他订单)|string||
|  updateBy|修改人|integer(int64)||
|  updateTime|修改时间|string(date-time)||
|purchasingAgent|甲方|string||
|remark|备注|string||
|signTime|合同签订日期|string||
|supplier|乙方|string||
|updateBy|修改人id|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
|userContractId|关联客户合同id|string||
**响应示例**:
```javascript
{
"amount": "",
"belongUser": "",
"belongUserId": 0,
"businessType": "",
"contractCode": "",
"contractFile": "",
"contractFileName": "",
"contractName": "",
"contractType": "",
"contracts": [
{
"amount": "",
"belongUser": "",
"belongUserId": 0,
"businessType": "",
"contractCode": "",
"contractFile": "",
"contractFileName": "",
"contractName": "",
"contractType": "",
"createBy": 0,
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"id": "",
"purchasingAgent": "",
"remark": "",
"signTime": "",
"supplier": "",
"updateBy": 0,
"updateTime": "",
"userContractId": ""
}
],
"createBy": 0,
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"customerVo": {
"authStatus": "",
"avatar": "",
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"nickName": "",
"phonenumber": "",
"status": "",
"userId": 0,
"userName": ""
},
"deleteStatus": "",
"demand": [
{
"clueId": "",
"company": "",
"createBy": 0,
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"demandCode": "",
"demandDesc": "",
"demandName": "",
"facilitatorId": "",
"feedback": "",
"id": "",
"origin": "",
"phoneNum": "",
"relatedId": "",
"relatedName": "",
"relatedType": "",
"remark": "",
"sellPredict": 0,
"source": "",
"status": "",
"transactionStatus": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"order": [
{
"appId": "",
"approvalId": "",
"approvalStatus": "",
"catalogueName": "",
"contractId": "",
"createBy": 0,
"createByName": "",
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"demandSideId": "",
"demandSideName": "",
"discountRate": 0,
"effectiveTime": "",
"expirationTime": "",
"id": "",
"orderAmount": 0,
"orderCode": "",
"orderState": "",
"productDesc": "",
"relatedId": "",
"relatedName": "",
"relatedType": "",
"updateBy": 0,
"updateTime": ""
}
],
"purchasingAgent": "",
"remark": "",
"signTime": "",
"supplier": "",
"updateBy": 0,
"updateTime": "",
"userContractId": ""
}
```
## 删除合同
**接口地址**:`/business/contract/{id}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 审核
## 审批
**接口地址**:`/business/approval/edit/{id}`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"approvalDesc": "",
"approvalStatus": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|审批记录修改对象dto|审批记录修改对象dto|
|  approvalDesc|审批描述||false|string||
|  approvalStatus|审批状态 2驳回 1通过||false|string||
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 审批list查询
**接口地址**:`/business/approval/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|approvalDesc|审批描述|query|false|string||
|approvalStatus|审批状态 2驳回 1通过 0待审核|query|false|string||
|dataId|审批数据ID|query|false|string||
|dataSource|审批来源{A0 产品创建审核A1 产品上下架审核B0解决方案创建审核B1解决方案上下架审核C0企业认证审核D0能力注册审核E0账单核算核审F0订单审核G0租户服务开通审核}}|query|false|string||
|handerId|审批人|query|false|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«审批对象vo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|审批对象vo|
|  approvalDesc|审批描述|string||
|  approvalId|审批ID|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  approvalTime|审批时间|string(date-time)||
|  createBy|提交人|integer(int64)||
|  createByName|提交人名称|string||
|  createTime|提交时间|string(date-time)||
|  dataId|审批数据ID|string||
|  dataSource|审批来源{A0 产品创建审核A1 产品上下架审核B0解决方案创建审核B1解决方案上下架审核C0企业认证审核D0能力注册审核E0账单核算核审F0订单审核G0租户服务开通审核}}|string||
|  dataSourceName|审批来源{A0 产品创建审核A1 产品上下架审核B0解决方案创建审核B1解决方案上下架审核C0企业认证审核D0能力注册审核E0账单核算核审F0订单审核G0租户服务开通审核}}|string||
|  handerId|审批人|integer(int64)||
|  handlerName|审批人姓名|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"approvalDesc": "",
"approvalId": "",
"approvalStatus": "",
"approvalTime": "",
"createBy": 0,
"createByName": "",
"createTime": "",
"dataId": "",
"dataSource": "",
"dataSourceName": "",
"handerId": 0,
"handlerName": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 工作台list查询
**接口地址**:`/business/approval/opList`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 通过审批id查看审批详情
**接口地址**:`/business/approval/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 客户中心产品已购相关接口
## 已购产品Api类的调用记录
**接口地址**:`/business/pre/proCus/callRecord`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|apiCode|apiCode|query|false|string||
|appCode|appCode|query|false|string||
|length|length|query|false|integer(int32)||
|start|start|query|false|integer(int32)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 已购产品查看详情
**接口地址**:`/business/pre/proCus/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|OrderProductDetailVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|appCode|appkey|string||
|appId|应用id|string||
|appSecretKey|appSecretKey|string||
|effectiveTime|生效时间|string(date-time)|string(date-time)|
|id|订单id|string||
|productAbisVoForPreList|对应能力列表|array|ProductAbisVoForPre|
|  abilityId|能力id|string||
|  abilityInvokeAddress|调用地址|string||
|  abilityName|能力名称|string||
|  abilityPlatformId|能力平台id|string||
|  abilityType|能力类型{0API,1SDK2SaaS服务3其他}|string||
|  gatewayAbilityId|能力平台名称|string||
|  gatewayAbilityName|下载地址|string||
|  id|主键|string||
|  loginAddress|sass应用登录地址|string||
|  loginPassword|sass应用登录密码|string||
|  loginUserName|sass应用登录用户名|string||
|  openMode|能力开通方式|string||
|  productId|产品id|string||
|relatedId|订单关联产品解决方案其他类产品id|string||
|relatedName|关联名称(订单name或者解决方案name)|string||
|relatedType|订单类型(0表示产品订单,1表示解决方案订单,2表示其他订单)|string||
**响应示例**:
```javascript
{
"appCode": "",
"appId": "",
"appSecretKey": "",
"effectiveTime": "",
"id": "",
"productAbisVoForPreList": [
{
"abilityId": "",
"abilityInvokeAddress": "",
"abilityName": "",
"abilityPlatformId": "",
"abilityType": "",
"gatewayAbilityId": "",
"gatewayAbilityName": "",
"id": "",
"loginAddress": "",
"loginPassword": "",
"loginUserName": "",
"openMode": "",
"productId": ""
}
],
"relatedId": "",
"relatedName": "",
"relatedType": ""
}
```
## 已购产品查询
**接口地址**:`/business/pre/proCus/pagelist`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|isValid||query|false|string||
|relatedName||query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«已购产品listvo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|已购产品listvo|
|  consoleUrl|控制台链接|string||
|  effectiveTime|生效时间|string(date-time)||
|  id|订单id|string||
|  orderAmount|订单金额(单位为元,保留两位小数点)|number||
|  orderCode|订单编号|string||
|  relatedId|关联id(订单id或者解决方案id)|string||
|  relatedName|关联名称(订单name或者解决方案name)|string||
|  relatedType|订单类型(0表示产品订单,1表示解决方案订单,2表示其他订单)|string||
|  statusName|是否有效|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"consoleUrl": "",
"effectiveTime": "",
"id": "",
"orderAmount": 0,
"orderCode": "",
"relatedId": "",
"relatedName": "",
"relatedType": "",
"statusName": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
# 客户相关接口
## 新增
**接口地址**:`/business/customer/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"avatar": "",
"email": "",
"enterpriseName": "",
"nickName": "",
"password": "",
"phonenumber": "",
"userName": "",
"userType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|customerDto|customerDto|body|true|CustomerAddDto|CustomerAddDto|
|  avatar|用户头像 长度1-100||false|string||
|  email|用户邮箱 长度1-50||false|string||
|  enterpriseName|企业名称 长度1-200||false|string||
|  nickName|用户名称 长度2-30||false|string||
|  password|密码 长度6-50||false|string||
|  phonenumber|手机号码 长度11||false|string||
|  userName|用户账号 长度2-30||false|string||
|  userType|账号类型 A0系统A1客户A2生态成员 长度6-50||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查看客户详情
**接口地址**:`/business/customer/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 客户管理分页列表
**接口地址**:`/business/customer/pagelist`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|avatar|用户头像 长度1-100|query|false|string||
|email|用户邮箱 长度1-50|query|false|string||
|enterpriseName|企业名称 长度1-200|query|false|string||
|nickName|用户名称 长度2-30|query|false|string||
|phonenumber|手机号码 长度11|query|false|string||
|userType|用户类型 A0系统用户,A1客户,A2团队成员|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«客户管理»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|客户管理|
|  authStatus|企业认证状态 2驳回 1通过 0待审核|string||
|  avatar|用户头像|string||
|  email|用户邮箱|string||
|  enterpriseId|企业id|string||
|  enterpriseName|企业名称|string||
|  loginDate|最后登录时间|string(date-time)||
|  nickName|用户名称|string||
|  phonenumber|手机号码|string||
|  status|帐号状态|string||
|  userId|用户ID|integer(int64)||
|  userName|登录名称|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"authStatus": "",
"avatar": "",
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"nickName": "",
"phonenumber": "",
"status": "",
"userId": 0,
"userName": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 修改客户手机或邮箱或头像
**接口地址**:`/business/customer/update/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"avatar": "",
"email": "",
"phonenumber": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|customerDto|customerDto|body|true|CustomerEditDto|CustomerEditDto|
|  avatar|用户头像 长度1-100||false|string||
|  email|用户邮箱 长度1-50||false|string||
|  phonenumber|手机号码 长度11||false|string||
|id|id|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 工单信息
## 分配执行人
**接口地址**:`/business/WorkOrder/distribution/{id}/{workerId}/{worker}`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|工单id|path|true|string||
|worker|用户昵称|path|true|string||
|workerId|用户id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取执行人列表
**接口地址**:`/business/WorkOrder/executor`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|roleId|roleId|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«RoleVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|RoleVo|
|  children||array|UserVo|
|    company||string||
|    email||string||
|    telephone||string||
|    userId||string||
|    userName||string||
|  des||string||
|  roleId||string||
|  roleName||string||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"children": [
{
"company": "",
"email": "",
"telephone": "",
"userId": "",
"userName": ""
}
],
"des": "",
"roleId": "",
"roleName": ""
}
],
"msg": "",
"total": 0
}
```
## 执行人反馈工单
**接口地址**:`/business/WorkOrder/feedback`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"feedback": "",
"id": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|执行人反馈工单dto|执行人反馈工单dto|
|  feedback|反馈说明||false|string||
|  id|||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 工单信息list查询
**接口地址**:`/business/WorkOrder/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|createBy|创建者-16|query|false|string||
|orderId|订单id|query|false|string||
|relatedName|关联名称|query|false|string||
|relatedType|工单来源0产品1解决方案2其他订单|query|false|string||
|worker|执行人|query|false|string||
|workOrderCode|工单编号|query|false|string||
|workOrderState|工单状态(0新建,1已分配2已拒绝3已交付4已竣工)|query|false|string||
|workOrderType|工单开通类型(0表示自动开通,1人工开通)-1|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«WorkOrderListVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|WorkOrderListVo|
|  abilityName|能力名称|string||
|  createTime|提交时间|string(date-time)||
|  id|工单id|string||
|  orderId|订单id|string||
|  productDesc|其他订单-交付内容|string||
|  relatedName|订购产品名称(当类型为解决方案时存解决方案名称)-32|string||
|  relatedType|工单来源0产品1解决方案2其他订单|string||
|  relatedTypeName|工单来源Name0产品1解决方案2其他订单|string||
|  workOrderCode|工单编号|string||
|  workOrderState|工单状态|string||
|  workOrderStateName|工单状态Name|string||
|  workOrderType|工单开通类型(0表示自动开通,1人工开通)|string||
|  workOrderTypeName|工单开通类型Name(0表示自动开通,1人工开通)|string||
|  worker|执行人|string||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"abilityName": "",
"createTime": "",
"id": "",
"orderId": "",
"productDesc": "",
"relatedName": "",
"relatedType": "",
"relatedTypeName": "",
"workOrderCode": "",
"workOrderState": "",
"workOrderStateName": "",
"workOrderType": "",
"workOrderTypeName": "",
"worker": ""
}
],
"msg": "",
"total": 0
}
```
## 工作台工单信息list
**接口地址**:`/business/WorkOrder/opList`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 执行人接收-拒绝
**接口地址**:`/business/WorkOrder/receiveOrRefuse`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|工单id|query|false|string||
|state|状态 2-拒绝 , 1-接收|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 通过工单Id查看工单信息详情
**接口地址**:`/business/WorkOrder/{workOrderId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|workOrderId|workOrderId|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 工单评价
## 通过工单id查询其评价
**接口地址**:`/business/WorkOrderEvaluate/WorkOrder/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|WorkOrderEvaluate|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|allEvaluation||string||
|createBy||integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|deleteStatus||string||
|evaluateFile||string||
|evaluateFileName||string||
|id|id|string||
|remark||string||
|updateBy||integer(int64)|integer(int64)|
|updateTime|修改时间|string(date-time)|string(date-time)|
|workOrderId||string||
**响应示例**:
```javascript
[
{
"allEvaluation": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"evaluateFile": "",
"evaluateFileName": "",
"id": "",
"remark": "",
"updateBy": 0,
"updateTime": "",
"workOrderId": ""
}
]
```
## 工单评价
**接口地址**:`/business/WorkOrderEvaluate/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"allEvaluation": "",
"evaluateFile": "",
"evaluateFileName": "",
"remark": "",
"workOrderId": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|WorkOrderEvaluateDTO|WorkOrderEvaluateDTO|
|  allEvaluation|总体评价||false|string||
|  evaluateFile|附件||false|string||
|  evaluateFileName|附件名称||false|string||
|  remark|评价信息||false|string||
|  workOrderId|工单id||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 修改工单评价
**接口地址**:`/business/WorkOrderEvaluate/update/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"allEvaluation": "",
"evaluateFile": "",
"evaluateFileName": "",
"remark": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
|updateDTO|updateDTO|body|true|WorkOrderEvaluateUpdateDTO|WorkOrderEvaluateUpdateDTO|
|  allEvaluation|总体评价||false|string||
|  evaluateFile|附件||false|string||
|  evaluateFileName|附件名称||false|string||
|  remark|评价信息||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 通过评价id查询工单评价
**接口地址**:`/business/WorkOrderEvaluate/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|WorkOrderEvaluateVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|allEvaluation||string||
|createBy||integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|evaluateFile||string||
|evaluateFileName||string||
|id|id|string||
|remark||string||
|updateBy||integer(int64)|integer(int64)|
|updateTime|修改时间|string(date-time)|string(date-time)|
|workOrderId||string||
**响应示例**:
```javascript
{
"allEvaluation": "",
"createBy": 0,
"createTime": "",
"evaluateFile": "",
"evaluateFileName": "",
"id": "",
"remark": "",
"updateBy": 0,
"updateTime": "",
"workOrderId": ""
}
```
# 抽取
## 新增
**接口地址**:`/business/draw`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"drawMode": "",
"evaluateMode": "",
"evaluateNumber": 0,
"evaluateTime": "",
"expertList": [
{
"drawId": "",
"expertId": "",
"expertStatus": "",
"id": ""
}
],
"name": "",
"professionalFieldIds": "",
"remark": "",
"requestIds": [],
"status": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|抽取新增Dto|抽取新增Dto|
|  drawMode|抽取方式0系统随机抽取 1直接指定||false|string||
|  evaluateMode|评审方式0远程评审 1现场评审||false|string||
|  evaluateNumber|评审人数||false|integer(int32)||
|  evaluateTime|评审时间||false|string(date-time)||
|  expertList|专家ids||false|array|DrawExpertDto|
|    drawId|抽取id||false|string||
|    expertId|专家id||false|string||
|    expertStatus|专家状态 0已抽取 1确定参加||false|string||
|    id|id||false|string||
|  name|抽取名称||false|string||
|  professionalFieldIds|专业领域id多个用英文逗号分隔||false|string||
|  remark|备注||false|string||
|  requestIds|申请单ids||false|array|string|
|  status|状态 0已保存 1已关闭||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取列表
**接口地址**:`/business/draw/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|drawMode|抽取方式0系统随机抽取 1直接指定|query|false|string||
|evaluateNumber|评审人数|query|false|integer(int32)||
|name|抽取名称|query|false|string||
|professionalFieldId|专业领域id|query|false|string||
|status|状态 0已保存 1已关闭|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«抽取VO»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|抽取VO|
|  createBy||integer(int64)||
|  createTime||string(date-time)||
|  drawMode|抽取方式0系统随机抽取 1直接指定|string||
|  evaluateMode|评审方式0远程评审 1现场评审|string||
|  evaluateNumber|评审人数|integer(int32)||
|  evaluateTime|评审时间|string(date-time)||
|  id||string||
|  name|抽取名称|string||
|  professionalFieldIds|专业领域id多个用英文逗号分隔|string||
|  professionalFieldNames|专业领域名称|array|string|
|  remark|备注|string||
|  status|状态 0已保存 1已关闭|string||
|  updateBy||integer(int64)||
|  updateTime||string(date-time)||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"createBy": 0,
"createTime": "",
"drawMode": "",
"evaluateMode": "",
"evaluateNumber": 0,
"evaluateTime": "",
"id": "",
"name": "",
"professionalFieldIds": "",
"professionalFieldNames": [],
"remark": "",
"status": "",
"updateBy": 0,
"updateTime": ""
}
],
"msg": "",
"total": 0
}
```
## 按专业领域类型和人数随机抽取
**接口地址**:`/business/draw/random`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"evaluateNumber": 0,
"professionalFieldIds": []
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|专家抽取对象Dto|专家抽取对象Dto|
|  evaluateNumber|评审人数||false|integer(int32)||
|  professionalFieldIds|专业领域ids||false|array|string|
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|专家Vo|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|certificateNumber|证件号码|string||
|certificateType|证件类型0工号1身份证2护照|string||
|city|所在城市|string||
|createBy||integer(int64)|integer(int64)|
|createTime||string(date-time)|string(date-time)|
|expertCode|专家编号|string||
|id||string||
|name|专家姓名|string||
|phoneNumber|手机号|string||
|professionalFieldNames|专业领域名称|array||
|status|状态0已入库 1已失效|string||
|updateBy||integer(int64)|integer(int64)|
|updateTime||string(date-time)|string(date-time)|
|workUnit|工作单位|string||
|workYear|行业工作年限|integer(int32)|integer(int32)|
**响应示例**:
```javascript
[
{
"certificateNumber": "",
"certificateType": "",
"city": "",
"createBy": 0,
"createTime": "",
"expertCode": "",
"id": "",
"name": "",
"phoneNumber": "",
"professionalFieldNames": [],
"status": "",
"updateBy": 0,
"updateTime": "",
"workUnit": "",
"workYear": 0
}
]
```
## 按专业领域类型 重新抽取,排除当前专家
**接口地址**:`/business/draw/reRandom`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"expertId": "",
"professionalFieldIds": []
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|专家重新抽取对象Dto|专家重新抽取对象Dto|
|  expertId|专家id||false|string||
|  professionalFieldIds|专业领域ids||false|array|string|
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|专家Vo|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|certificateNumber|证件号码|string||
|certificateType|证件类型0工号1身份证2护照|string||
|city|所在城市|string||
|createBy||integer(int64)|integer(int64)|
|createTime||string(date-time)|string(date-time)|
|expertCode|专家编号|string||
|id||string||
|name|专家姓名|string||
|phoneNumber|手机号|string||
|professionalFieldNames|专业领域名称|array||
|status|状态0已入库 1已失效|string||
|updateBy||integer(int64)|integer(int64)|
|updateTime||string(date-time)|string(date-time)|
|workUnit|工作单位|string||
|workYear|行业工作年限|integer(int32)|integer(int32)|
**响应示例**:
```javascript
{
"certificateNumber": "",
"certificateType": "",
"city": "",
"createBy": 0,
"createTime": "",
"expertCode": "",
"id": "",
"name": "",
"phoneNumber": "",
"professionalFieldNames": [],
"status": "",
"updateBy": 0,
"updateTime": "",
"workUnit": "",
"workYear": 0
}
```
## selectById
**接口地址**:`/business/draw/selectById`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|抽取详情VO|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|createBy||integer(int64)|integer(int64)|
|createTime||string(date-time)|string(date-time)|
|drawMode|抽取方式0系统随机抽取 1直接指定|string||
|evaluateMode|评审方式0远程评审 1现场评审|string||
|evaluateNumber|评审人数|integer(int32)|integer(int32)|
|evaluateTime|评审时间|string(date-time)|string(date-time)|
|expertList|专家列表|array|抽取专家Vo|
|  certificateNumber|证件号码|string||
|  certificateType|证件类型0工号1身份证2护照|string||
|  city|所在城市|string||
|  createBy||integer(int64)||
|  createTime||string(date-time)||
|  expertCode|专家编号|string||
|  expertStatus|专家状态 0已抽取 1确定参加|string||
|  id||string||
|  name|专家姓名|string||
|  phoneNumber|手机号|string||
|  professionalFieldNames|专业领域名称|array|string|
|  status|状态0已入库 1已失效|string||
|  updateBy||integer(int64)||
|  updateTime||string(date-time)||
|  workUnit|工作单位|string||
|  workYear|行业工作年限|integer(int32)||
|id||string||
|name|抽取名称|string||
|professionalFieldIds|专业领域id多个用英文逗号分隔|string||
|professionalFieldNames|专业领域名称|array||
|remark|备注|string||
|requestIds|申请单列表|array|ApplyInfoVo|
|  applyFileList|申请文件列表|array|文件表返回VO|
|    dataId|数据id|string||
|    delFlag||string||
|    fileName|文件名称|string||
|    fileOriginName|文件原名称|string||
|    fileSource|文件来源|string||
|    fileUrl|文件地址|string||
|    id|文件ID|string||
|  applyName|申请单名称|string||
|  applyNum|申请单编号|string||
|  applyStatus|申请状态|string||
|  applyTime|申请提交时间|string(date-time)||
|  applyUserName|申请人姓名|string||
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  decisionFilesList|决策文件列表|array|文件表返回VO|
|    dataId|数据id|string||
|    delFlag||string||
|    fileName|文件名称|string||
|    fileOriginName|文件原名称|string||
|    fileSource|文件来源|string||
|    fileUrl|文件地址|string||
|    id|文件ID|string||
|  decisionInfo|决策结果|string||
|  email|联系人邮箱|string||
|  id|主键|string||
|  noticeName|公告名称|string||
|  serviceProviderId|服务商外键|string||
|  serviceProviderTagList|服务商标签列表|array|能力标签|
|    createBy|创建者|integer||
|    createTime|创建时间|string||
|    deleteStatus|逻辑删除0正常1删除|string||
|    id|主键|string||
|    parentId|上级id|string||
|    remark|标签备注|string||
|    tagName|标签名称|string||
|    updateBy|更新者|integer||
|    updateTime|更新时间|string||
|  serviceProviderTypeList|服务商类型列表|array|服务商类型标签|
|    dictCode|类型code|integer||
|    dictLabel|类型名称|string||
|    dictType|固定值 service_provider_type|string||
|    remark|备注|string||
|    status|状态|string||
|  userId|联系人id|string||
|  userName|联系人姓名|string||
|  userPhone|联系人手机号|string||
|status|状态 0已保存 1已关闭|string||
|updateBy||integer(int64)|integer(int64)|
|updateTime||string(date-time)|string(date-time)|
**响应示例**:
```javascript
{
"createBy": 0,
"createTime": "",
"drawMode": "",
"evaluateMode": "",
"evaluateNumber": 0,
"evaluateTime": "",
"expertList": [
{
"certificateNumber": "",
"certificateType": "",
"city": "",
"createBy": 0,
"createTime": "",
"expertCode": "",
"expertStatus": "",
"id": "",
"name": "",
"phoneNumber": "",
"professionalFieldNames": [],
"status": "",
"updateBy": 0,
"updateTime": "",
"workUnit": "",
"workYear": 0
}
],
"id": "",
"name": "",
"professionalFieldIds": "",
"professionalFieldNames": [],
"remark": "",
"requestIds": [
{
"applyFileList": [
{
"dataId": "",
"delFlag": "",
"fileName": "",
"fileOriginName": "",
"fileSource": "",
"fileUrl": "",
"id": ""
}
],
"applyName": "",
"applyNum": "",
"applyStatus": "",
"applyTime": "",
"applyUserName": "",
"approvalId": "",
"approvalStatus": "",
"decisionFilesList": [
{
"dataId": "",
"delFlag": "",
"fileName": "",
"fileOriginName": "",
"fileSource": "",
"fileUrl": "",
"id": ""
}
],
"decisionInfo": "",
"email": "",
"id": "",
"noticeName": "",
"serviceProviderId": "",
"serviceProviderTagList": [
{
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"id": "",
"parentId": "",
"remark": "",
"tagName": "",
"updateBy": 0,
"updateTime": ""
}
],
"serviceProviderTypeList": [
{
"dictCode": 0,
"dictLabel": "",
"dictType": "",
"remark": "",
"status": ""
}
],
"userId": "",
"userName": "",
"userPhone": ""
}
],
"status": "",
"updateBy": 0,
"updateTime": ""
}
```
## 修改
**接口地址**:`/business/draw/update/{id}`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"evaluateMode": "",
"evaluateNumber": 0,
"evaluateTime": "",
"expertIds": [],
"expertList": [
{
"drawId": "",
"expertId": "",
"expertStatus": "",
"id": ""
}
],
"name": "",
"professionalFieldIds": "",
"remark": "",
"requestIds": [],
"status": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|抽取修改Dto|抽取修改Dto|
|  evaluateMode|评审方式0远程评审 1现场评审||false|string||
|  evaluateNumber|评审人数||false|integer(int32)||
|  evaluateTime|评审时间||false|string(date-time)||
|  expertIds|||false|array|string|
|  expertList|专家ids||false|array|DrawExpertDto|
|    drawId|抽取id||false|string||
|    expertId|专家id||false|string||
|    expertStatus|专家状态 0已抽取 1确定参加||false|string||
|    id|id||false|string||
|  name|抽取名称||false|string||
|  professionalFieldIds|专业领域id多个用英文逗号分隔||false|string||
|  remark|备注||false|string||
|  requestIds|申请单ids||false|array|string|
|  status|状态 0已保存 1已关闭||false|string||
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 数据统计
## 能力中心数据统计
**接口地址**:`/business/dataStatistics/abilityCenter`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|AbilityCenterVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|abilityCenterAllSum||string||
|abilityCenterSum||string||
|abilityCenterType||string||
|abilityProportion||string||
**响应示例**:
```javascript
[
{
"abilityCenterAllSum": "",
"abilityCenterSum": "",
"abilityCenterType": "",
"abilityProportion": ""
}
]
```
## 账目管理
**接口地址**:`/business/dataStatistics/billData`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|账单管理对象Vo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|credit|实收账款|string||
|month|月份|string||
|payFees|支付费用|string||
|receivables|应收账款|string||
**响应示例**:
```javascript
[
{
"credit": "",
"month": "",
"payFees": "",
"receivables": ""
}
]
```
## 商业漏斗(0线上1线下)
**接口地址**:`/business/dataStatistics/commercialFunnel/{source}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|source|source|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|商业漏斗对象Vo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|clueNumber|商机数|string||
|contractNumber|合同数|string||
|demandOrderNumber|需求单数|string||
|totalPredictMoney|销售预测总金额|number||
|transformMoney|转换总金额|number||
**响应示例**:
```javascript
{
"clueNumber": "",
"contractNumber": "",
"demandOrderNumber": "",
"totalPredictMoney": 0,
"transformMoney": 0
}
```
## 查询合同数量以及金额
**接口地址**:`/business/dataStatistics/contractData`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|ContractDataVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|coopAmount|合作形合同金额|string||
|coopContract|合作形合同数量|integer(int32)|integer(int32)|
|customerAmount|客户形合同金额|string||
|customerContract|客户形合同数量|integer(int32)|integer(int32)|
|customerReturnAmount|客户形回款合同金额|string||
**响应示例**:
```javascript
{
"coopAmount": "",
"coopContract": 0,
"customerAmount": "",
"customerContract": 0,
"customerReturnAmount": ""
}
```
## 客户数量
**接口地址**:`/business/dataStatistics/customer`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 需求单
**接口地址**:`/business/dataStatistics/doData`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|需求单对象Vo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|demandOrderNumber|需求单总数|string||
|offlineNumber|线下需求单总数|string||
|onlineNumber|线上需求单总数|string||
|originFacilitator|服务商商机线索|string||
|originMigu|咪咕商机线索|string||
**响应示例**:
```javascript
{
"demandOrderNumber": "",
"offlineNumber": "",
"onlineNumber": "",
"originFacilitator": "",
"originMigu": ""
}
```
## 生态成员能力分布
**接口地址**:`/business/dataStatistics/providerAbility`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|ProviderAbilityVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|abilityName||string||
|abilityNum||integer(int32)|integer(int32)|
|abilityProportion||string||
|aid||string||
**响应示例**:
```javascript
[
{
"abilityName": "",
"abilityNum": 0,
"abilityProportion": "",
"aid": ""
}
]
```
## 生态成员数量
**接口地址**:`/business/dataStatistics/providerNum`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 生态成员类型分布
**接口地址**:`/business/dataStatistics/providerType`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|ProviderTypeVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|id||string||
|num||integer(int32)|integer(int32)|
|providerProportion||string||
|typeName||string||
**响应示例**:
```javascript
[
{
"id": "",
"num": 0,
"providerProportion": "",
"typeName": ""
}
]
```
## 产品方案管理
**接口地址**:`/business/dataStatistics/psData`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|产品方案管理对象Vo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|pdemandNumber||string||
|productNumber|产品总数|string||
|psellNumber||string||
|pviewNumber||string||
|sdemandNumber||string||
|solutionNumber|方案总数|string||
|ssellNumber||string||
|sviewNumber||string||
**响应示例**:
```javascript
{
"pdemandNumber": "",
"productNumber": "",
"psellNumber": "",
"pviewNumber": "",
"sdemandNumber": "",
"solutionNumber": "",
"ssellNumber": "",
"sviewNumber": ""
}
```
## 服务调用量统计
**接口地址**:`/business/dataStatistics/transferData`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|服务量调用统计对象Vo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|total|服务调用总量|integer(int64)|integer(int64)|
|ttList|服务调用量Top10列表|array|服务量调用统计对象Vo|
|  total|服务调用总量|integer(int64)||
|  ttList|服务调用量Top10列表|array|服务量调用统计对象Vo|
|  tvList|按月份统计调用量列表|array|服务量调用统计对象Vo|
|tvList|按月份统计调用量列表|array|服务量调用统计对象Vo|
|  total|服务调用总量|integer(int64)||
|  ttList|服务调用量Top10列表|array|服务量调用统计对象Vo|
|  tvList|按月份统计调用量列表|array|服务量调用统计对象Vo|
**响应示例**:
```javascript
{
"total": 0,
"ttList": [
{
"total": 0,
"ttList": [],
"tvList": []
}
],
"tvList": [
{
"total": 0,
"ttList": [],
"tvList": []
}
]
}
```
# 服务商申请单相关接口
## 服务商申请单上传决策结果
**接口地址**:`/business/applyInfo/decision`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"applyStatus": "",
"decisionInfo": "",
"fileList": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"id": "",
"serviceProviderTagList": [],
"serviceProviderTypeList": []
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|applyInfoDecisionDto|applyInfoDecisionDto|body|true|ApplyInfoDecisionDto|ApplyInfoDecisionDto|
|  applyStatus|决策结果5通过6不通过||false|string||
|  decisionInfo|决策说明||false|string||
|  fileList|决策文件列表列表||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  id|申请单id||false|string||
|  serviceProviderTagList|服务商标签列表||false|array|string|
|  serviceProviderTypeList|服务商类型列表||false|array|string|
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查看服务商申请单详情
**接口地址**:`/business/applyInfo/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 服务商申请单分页列表
**接口地址**:`/business/applyInfo/service/pagelist`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|applyName|申请单名称|query|false|string||
|applyNum|申请单编号|query|false|string||
|applyStatus|申请状态|query|false|string||
|applyStatusList||query|false|array|string|
|applyTime|申请提交时间|query|false|string(date-time)||
|applyType|申请单类型 0服务商1调用单|query|false|string||
|applyUserName|申请人名称|query|false|string||
|endTime|结束时间|query|false|string(date-time)||
|forApproval|是否审批 true审核 null or false 所有状态|query|false|boolean||
|id|主键|query|false|string||
|noticeName|公告名称|query|false|string||
|serviceProviderId|服务商外键|query|false|string||
|startTime|开始时间|query|false|string(date-time)||
|userId|联系人id|query|false|string||
|userName|申请人姓名|query|false|string||
|userPhone|联系人手机号|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«ApplyInfoVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|ApplyInfoVo|
|  applyFileList|申请文件列表|array|文件表返回VO|
|    dataId|数据id|string||
|    delFlag||string||
|    fileName|文件名称|string||
|    fileOriginName|文件原名称|string||
|    fileSource|文件来源|string||
|    fileUrl|文件地址|string||
|    id|文件ID|string||
|  applyName|申请单名称|string||
|  applyNum|申请单编号|string||
|  applyStatus|申请状态|string||
|  applyTime|申请提交时间|string(date-time)||
|  applyUserName|申请人姓名|string||
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  decisionFilesList|决策文件列表|array|文件表返回VO|
|    dataId|数据id|string||
|    delFlag||string||
|    fileName|文件名称|string||
|    fileOriginName|文件原名称|string||
|    fileSource|文件来源|string||
|    fileUrl|文件地址|string||
|    id|文件ID|string||
|  decisionInfo|决策结果|string||
|  email|联系人邮箱|string||
|  id|主键|string||
|  noticeName|公告名称|string||
|  serviceProviderId|服务商外键|string||
|  serviceProviderTagList|服务商标签列表|array|能力标签|
|    createBy|创建者|integer||
|    createTime|创建时间|string||
|    deleteStatus|逻辑删除0正常1删除|string||
|    id|主键|string||
|    parentId|上级id|string||
|    remark|标签备注|string||
|    tagName|标签名称|string||
|    updateBy|更新者|integer||
|    updateTime|更新时间|string||
|  serviceProviderTypeList|服务商类型列表|array|服务商类型标签|
|    dictCode|类型code|integer||
|    dictLabel|类型名称|string||
|    dictType|固定值 service_provider_type|string||
|    remark|备注|string||
|    status|状态|string||
|  userId|联系人id|string||
|  userName|联系人姓名|string||
|  userPhone|联系人手机号|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"applyFileList": [
{
"dataId": "",
"delFlag": "",
"fileName": "",
"fileOriginName": "",
"fileSource": "",
"fileUrl": "",
"id": ""
}
],
"applyName": "",
"applyNum": "",
"applyStatus": "",
"applyTime": "",
"applyUserName": "",
"approvalId": "",
"approvalStatus": "",
"decisionFilesList": [
{
"dataId": "",
"delFlag": "",
"fileName": "",
"fileOriginName": "",
"fileSource": "",
"fileUrl": "",
"id": ""
}
],
"decisionInfo": "",
"email": "",
"id": "",
"noticeName": "",
"serviceProviderId": "",
"serviceProviderTagList": [
{
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"id": "",
"parentId": "",
"remark": "",
"tagName": "",
"updateBy": 0,
"updateTime": ""
}
],
"serviceProviderTypeList": [
{
"dictCode": 0,
"dictLabel": "",
"dictType": "",
"remark": "",
"status": ""
}
],
"userId": "",
"userName": "",
"userPhone": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
# 服务商相关接口
## 新增服务商
**接口地址**:`/business/provider/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"abilityTagId": "",
"abilityTagIds": [],
"enterpriseId": "",
"serviceName": "",
"serviceTypeId": "",
"serviceTypeIds": [],
"status": "",
"userName": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|serviceProviderDto|serviceProviderDto|body|true|服务商0|服务商0|
|  abilityTagId|能力标签外键||false|string||
|  abilityTagIds|能力标签外键集合||false|array|string|
|  enterpriseId|企业id||false|string||
|  serviceName|服务商名称||false|string||
|  serviceTypeId|服务商类型外键||false|string||
|  serviceTypeIds|服务商类型外键集合||false|array|string|
|  status|合作状态0合作种 1已过期||false|string||
|  userName|联系人姓名||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查看服务商详情
**接口地址**:`/business/provider/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
|pageNum|pageNum|query|false|integer(int32)||
|pageSize|pageSize|query|false|integer(int32)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|服务商|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|abilityDesc|联系人|string||
|account|用户账号|string||
|createBy|创建者|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|enterpriseId|企业id|string||
|expectedBusiness|预期商务模式|string||
|expectedCooperation|预期合作方式|string||
|fileList|服务商附件列表|array|文件表返回VO|
|  dataId|数据id|string||
|  delFlag||string||
|  fileName|文件名称|string||
|  fileOriginName|文件原名称|string||
|  fileSource|文件来源|string||
|  fileUrl|文件地址|string||
|  id|文件ID|string||
|id|主键|string||
|mail|联系人邮箱|string||
|phone|联系人电话|string||
|serviceName|标签名称|string||
|serviceTypeIds|服务商类型外键集合,逗号分隔|string||
|status|合作状态0合作种 1已过期|string||
|tagNameList|能力标签外键集合|array|能力标签|
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  deleteStatus|逻辑删除0正常1删除|string||
|  id|主键|string||
|  parentId|上级id|string||
|  remark|标签备注|string||
|  tagName|标签名称|string||
|  updateBy|更新者|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|tagNames|能力标签外键集合,逗号分隔|string||
|typeNameList|服务商类型名称集合|array|服务商类型标签|
|  dictCode|类型code|integer(int64)||
|  dictLabel|类型名称|string||
|  dictType|固定值 service_provider_type|string||
|  remark|备注|string||
|  status|状态|string||
|typeNames|服务商类型名称集合,逗号分隔|string||
|updateBy|更新者|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
|userName|用户名称|string||
**响应示例**:
```javascript
{
"abilityDesc": "",
"account": "",
"createBy": 0,
"createTime": "",
"enterpriseId": "",
"expectedBusiness": "",
"expectedCooperation": "",
"fileList": [
{
"dataId": "",
"delFlag": "",
"fileName": "",
"fileOriginName": "",
"fileSource": "",
"fileUrl": "",
"id": ""
}
],
"id": "",
"mail": "",
"phone": "",
"serviceName": "",
"serviceTypeIds": "",
"status": "",
"tagNameList": [
{
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"id": "",
"parentId": "",
"remark": "",
"tagName": "",
"updateBy": 0,
"updateTime": ""
}
],
"tagNames": "",
"typeNameList": [
{
"dictCode": 0,
"dictLabel": "",
"dictType": "",
"remark": "",
"status": ""
}
],
"typeNames": "",
"updateBy": 0,
"updateTime": "",
"userName": ""
}
```
## 导出服务商
**接口地址**:`/business/provider/export`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
|abilityTagId|能力标签外键|query|false|string||
|abilityTagIds|能力标签外键集合|query|false|array|string|
|enterpriseId|企业id|query|false|string||
|serviceName|服务商名称|query|false|string||
|serviceTypeId|服务商类型外键|query|false|string||
|serviceTypeIds|服务商类型外键集合|query|false|array|string|
|status|合作状态0合作种 1已过期|query|false|string||
|userName|联系人姓名|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 导出服务商
**接口地址**:`/business/provider/export/{ids}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
|abilityTagId|能力标签外键|query|false|string||
|abilityTagIds|能力标签外键集合|query|false|array|string|
|enterpriseId|企业id|query|false|string||
|serviceName|服务商名称|query|false|string||
|serviceTypeId|服务商类型外键|query|false|string||
|serviceTypeIds|服务商类型外键集合|query|false|array|string|
|status|合作状态0合作种 1已过期|query|false|string||
|userName|联系人姓名|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 服务商列表
**接口地址**:`/business/provider/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 服务商分页列表
**接口地址**:`/business/provider/pagelist`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|abilityTagId|能力标签外键|query|false|string||
|abilityTagIds|能力标签外键集合|query|false|array|string|
|enterpriseId|企业id|query|false|string||
|serviceName|服务商名称|query|false|string||
|serviceTypeId|服务商类型外键|query|false|string||
|serviceTypeIds|服务商类型外键集合|query|false|array|string|
|status|合作状态0合作种 1已过期|query|false|string||
|userName|联系人姓名|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«服务商»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|服务商|
|  abilityDesc|联系人|string||
|  account|用户账号|string||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  enterpriseId|企业id|string||
|  expectedBusiness|预期商务模式|string||
|  expectedCooperation|预期合作方式|string||
|  fileList|服务商附件列表|array|文件表返回VO|
|    dataId|数据id|string||
|    delFlag||string||
|    fileName|文件名称|string||
|    fileOriginName|文件原名称|string||
|    fileSource|文件来源|string||
|    fileUrl|文件地址|string||
|    id|文件ID|string||
|  id|主键|string||
|  mail|联系人邮箱|string||
|  phone|联系人电话|string||
|  serviceName|标签名称|string||
|  serviceTypeIds|服务商类型外键集合,逗号分隔|string||
|  status|合作状态0合作种 1已过期|string||
|  tagNameList|能力标签外键集合|array|能力标签|
|    createBy|创建者|integer||
|    createTime|创建时间|string||
|    deleteStatus|逻辑删除0正常1删除|string||
|    id|主键|string||
|    parentId|上级id|string||
|    remark|标签备注|string||
|    tagName|标签名称|string||
|    updateBy|更新者|integer||
|    updateTime|更新时间|string||
|  tagNames|能力标签外键集合,逗号分隔|string||
|  typeNameList|服务商类型名称集合|array|服务商类型标签|
|    dictCode|类型code|integer||
|    dictLabel|类型名称|string||
|    dictType|固定值 service_provider_type|string||
|    remark|备注|string||
|    status|状态|string||
|  typeNames|服务商类型名称集合,逗号分隔|string||
|  updateBy|更新者|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|  userName|用户名称|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"abilityDesc": "",
"account": "",
"createBy": 0,
"createTime": "",
"enterpriseId": "",
"expectedBusiness": "",
"expectedCooperation": "",
"fileList": [
{
"dataId": "",
"delFlag": "",
"fileName": "",
"fileOriginName": "",
"fileSource": "",
"fileUrl": "",
"id": ""
}
],
"id": "",
"mail": "",
"phone": "",
"serviceName": "",
"serviceTypeIds": "",
"status": "",
"tagNameList": [
{
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"id": "",
"parentId": "",
"remark": "",
"tagName": "",
"updateBy": 0,
"updateTime": ""
}
],
"tagNames": "",
"typeNameList": [
{
"dictCode": 0,
"dictLabel": "",
"dictType": "",
"remark": "",
"status": ""
}
],
"typeNames": "",
"updateBy": 0,
"updateTime": "",
"userName": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 修改服务商
**接口地址**:`/business/provider/update`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"abilityDesc": "",
"expectedBusiness": "",
"expectedCooperation": "",
"fileList": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"id": "",
"tagNameList": [
{
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"id": "",
"parentId": "",
"remark": "",
"tagName": "",
"updateBy": 0,
"updateTime": ""
}
],
"typeNameList": [
{
"dictCode": 0,
"dictLabel": "",
"dictType": "",
"remark": "",
"status": ""
}
]
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|serviceProviderDto|serviceProviderDto|body|true|更新服务商|更新服务商|
|  abilityDesc|能力描述||false|string||
|  expectedBusiness|预期商务模式||false|string||
|  expectedCooperation|预期合作方式||false|string||
|  fileList|服务商附件列表||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  id|主键||false|string||
|  tagNameList|能力标签外键集合||false|array|能力标签|
|    createBy|创建者||false|integer||
|    createTime|创建时间||false|string||
|    deleteStatus|逻辑删除0正常1删除||false|string||
|    id|主键||false|string||
|    parentId|上级id||false|string||
|    remark|标签备注||false|string||
|    tagName|标签名称||false|string||
|    updateBy|更新者||false|integer||
|    updateTime|更新时间||false|string||
|  typeNameList|服务商类型名称集合||false|array|服务商类型标签|
|    dictCode|类型code||false|integer||
|    dictLabel|类型名称||false|string||
|    dictType|固定值 service_provider_type||false|string||
|    remark|备注||false|string||
|    status|状态||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 停用或开启服务商0启用1停止
**接口地址**:`/business/provider/{id}/{status}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
|status|status|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 服务商评分相关接口
## 新增
**接口地址**:`/business/providerComment/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"attrName": "",
"attrUrl": "",
"commentTime": "",
"content": "",
"fraction": 0,
"id": "",
"serviceProviderId": "",
"userId": "",
"userName": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|providerCommentDto|providerCommentDto|body|true|ProviderCommentDto|ProviderCommentDto|
|  attrName|附件文件名称||false|string||
|  attrUrl|附件地址||false|string||
|  commentTime|评定时间||false|string(date-time)||
|  content|评定内容||false|string||
|  fraction|评分||false|integer(int32)||
|  id|主键||false|string||
|  serviceProviderId|服务商外键||false|string||
|  userId|评定人id||false|string||
|  userName|评定人名称||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查看服务商评分详情
**接口地址**:`/business/providerComment/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|服务商评分|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|attrName|附件名称|string||
|attrUrl|附件地址|string||
|commentTime|评定时间|string(date-time)|string(date-time)|
|content|评定内容|string||
|fraction|评分|integer(int32)|integer(int32)|
|id|主键|string||
|userName|评定人名称|string||
**响应示例**:
```javascript
{
"attrName": "",
"attrUrl": "",
"commentTime": "",
"content": "",
"fraction": 0,
"id": "",
"userName": ""
}
```
## 修改
**接口地址**:`/business/providerComment/update`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"attrName": "",
"attrUrl": "",
"commentTime": "",
"content": "",
"fraction": 0,
"id": "",
"serviceProviderId": "",
"userId": "",
"userName": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|providerCommentDto|providerCommentDto|body|true|ProviderCommentDto|ProviderCommentDto|
|  attrName|附件文件名称||false|string||
|  attrUrl|附件地址||false|string||
|  commentTime|评定时间||false|string(date-time)||
|  content|评定内容||false|string||
|  fraction|评分||false|integer(int32)||
|  id|主键||false|string||
|  serviceProviderId|服务商外键||false|string||
|  userId|评定人id||false|string||
|  userName|评定人名称||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 消息
## 根据登录用户查询所有未读消息,超级管理员返回所有未读消息数
**接口地址**:`/business/msg/count`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 批量删除
**接口地址**:`/business/msg/deletes/{ids}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 根据登录用户查询所有未读列表,超级管理员返回所有未读数据(最近的99条消息)
**接口地址**:`/business/msg/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## 查询当前登录用户的所有消息或所有未读消息,如果是超级管理员,返回所有用户的
**接口地址**:`/business/msg/listByReadFlag`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|msgSource|消息来源,\nA0工单已竣工 A1工单分配执行人 A2工单执行人接收工单 A3工单执行人拒绝工单 \nB0订单已完成 B1 账单已出账 B2账单待核销 B3账单已核销\nC0线上需求单已提交 C1线上需求单分配客户经理 C2线上需求单关闭 C3线下需求单关闭\nD0审核完成\nE0结算单已出账 E1结算单待结算 E2结算单已结算|query|false|string||
|msgType|消息类型 0消息通知 1待办事项|query|false|string||
|readFlag|阅读标签0未阅读1已阅|query|false|string||
|receiveUserId|收件人id|query|false|integer(int64)||
|title|标题|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## 设置为全部已读
**接口地址**:`/business/msg/readAll`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 批量已读
**接口地址**:`/business/msg/reads/{ids}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 按消息类型批量已读
**接口地址**:`/business/msg/readsByType/{msgType}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|msgType|msgType|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取消息详情
**接口地址**:`/business/msg/selectById/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|操作通知对象Vo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|content|内容|string||
|createBy|创建人|string||
|createTime|创建时间|string(date-time)|string(date-time)|
|id|id|string||
|msgSource|消息来源,\nA0工单已竣工 A1工单分配执行人 A2工单执行人接收工单 A3工单执行人拒绝工单 \nB0订单已完成 B1 账单已出账 B2账单待核销 B3账单已核销\nC0线上需求单已提交 C1线上需求单分配客户经理 C2线上需求单关闭 C3线下需求单关闭\nD0审核完成\nE0结算单已出账 E1结算单待结算 E2结算单已结算|string||
|msgSourceName|消息来源名称|string||
|msgStatus|状态0开放1关闭|string||
|msgType|消息类型 0消息通知 1待办|string||
|msgTypeName|消息类型名称|string||
|readFlag|阅读标签0未阅读1已阅|string||
|receiveUserId|收件人id|integer(int64)|integer(int64)|
|resourceId|关联资源id|string||
|resourceType| 跳转工单详情页A0,\n 分配工单执行人A1,\n 跳转订单详情页B0,\n 跳转账单详情页C0,\n 跳转线上需求单详情页D0,\n 跳转需求单详情页D1,\n 跳转审批详情页E0,\n 跳转单据页(企业认证审核)F0,\n 跳转单据页(产品新建、上下架审核)F1,\n 跳转单据页(解决方案新建、上下架审核)F2,\n 跳转单据页(订单创建审核)F3,\n 跳转单据页(账单出账审核)F4,\n 跳转单据页(公告审核)F5|string||
|title|标题|string||
|updateBy|修改人|string||
|updateTime|修改时间|string(date-time)|string(date-time)|
**响应示例**:
```javascript
{
"content": "",
"createBy": "",
"createTime": "",
"id": "",
"msgSource": "",
"msgSourceName": "",
"msgStatus": "",
"msgType": "",
"msgTypeName": "",
"readFlag": "",
"receiveUserId": 0,
"resourceId": "",
"resourceType": "",
"title": "",
"updateBy": "",
"updateTime": ""
}
```
## 根据通知id修改通知状态为已读
**接口地址**:`/business/msg/update/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 目录管理
## 新增目录导航
**接口地址**:`/business/catalog/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"catalogName": "",
"catalogType": "",
"displayNot": "",
"parentId": "",
"remark": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|addDto|addDto|body|true|CatalogAddDTO|CatalogAddDTO|
|  catalogName|目录名称-16||false|string||
|  catalogType|导航类型0产品1解决方案||false|string||
|  displayNot|是否展示0否1是||false|string||
|  parentId|父级目录id(1级为0)||false|string||
|  remark|目录说明-100||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查询目录的详细信息
**接口地址**:`/business/catalog/info/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|CatalogListVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|catalogName|目录名称|string||
|catalogType|导航类型0产品1解决方案|string||
|childrenList|该目录下的子集目录|array|CatalogVo|
|  catalogName|目录名称|string||
|  catalogType|导航类型0产品1解决方案|string||
|  createBy|创建人id|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  deleteStatus||string||
|  displayNot|是否展示0否1是|string||
|  id||string||
|  nodeList|该目录下的产品或解决方案|array|NodeVo|
|    id||string||
|    name||string||
|  parentId|父级目录id(1级为0)|string||
|  remark|目录说明|string||
|  updateBy|修改人id|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|displayNot|是否展示0否1是|string||
|id||string||
|parentId|父级目录id(1级为0)|string||
|remark|目录说明|string||
**响应示例**:
```javascript
{
"catalogName": "",
"catalogType": "",
"childrenList": [
{
"catalogName": "",
"catalogType": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"displayNot": "",
"id": "",
"nodeList": [
{
"id": "",
"name": ""
}
],
"parentId": "",
"remark": "",
"updateBy": 0,
"updateTime": ""
}
],
"displayNot": "",
"id": "",
"parentId": "",
"remark": ""
}
```
## 后台管理目录
**接口地址**:`/business/catalog/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|catalogName|目录名称|query|false|string||
|catalogType|导航类型0产品1解决方案|query|false|string||
|parentId|父级目录id(1级为0)|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«CatalogListVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|CatalogListVo|
|  catalogName|目录名称|string||
|  catalogType|导航类型0产品1解决方案|string||
|  childrenList|该目录下的子集目录|array|CatalogVo|
|    catalogName|目录名称|string||
|    catalogType|导航类型0产品1解决方案|string||
|    createBy|创建人id|integer||
|    createTime|创建时间|string||
|    deleteStatus||string||
|    displayNot|是否展示0否1是|string||
|    id||string||
|    nodeList|该目录下的产品或解决方案|array|NodeVo|
|      id||string||
|      name||string||
|    parentId|父级目录id(1级为0)|string||
|    remark|目录说明|string||
|    updateBy|修改人id|integer||
|    updateTime|更新时间|string||
|  displayNot|是否展示0否1是|string||
|  id||string||
|  parentId|父级目录id(1级为0)|string||
|  remark|目录说明|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"catalogName": "",
"catalogType": "",
"childrenList": [
{
"catalogName": "",
"catalogType": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"displayNot": "",
"id": "",
"nodeList": [
{
"id": "",
"name": ""
}
],
"parentId": "",
"remark": "",
"updateBy": 0,
"updateTime": ""
}
],
"displayNot": "",
"id": "",
"parentId": "",
"remark": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 后台产品或解决方案新建目录接口
**接口地址**:`/business/catalog/proOrSolCatalog`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|catalogName|目录名称|query|false|string||
|catalogType|导航类型0产品1解决方案|query|false|string||
|parentId|父级目录id(1级为0)|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«CatalogListVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|CatalogListVo|
|  catalogName|目录名称|string||
|  catalogType|导航类型0产品1解决方案|string||
|  childrenList|该目录下的子集目录|array|CatalogVo|
|    catalogName|目录名称|string||
|    catalogType|导航类型0产品1解决方案|string||
|    createBy|创建人id|integer||
|    createTime|创建时间|string||
|    deleteStatus||string||
|    displayNot|是否展示0否1是|string||
|    id||string||
|    nodeList|该目录下的产品或解决方案|array|NodeVo|
|      id||string||
|      name||string||
|    parentId|父级目录id(1级为0)|string||
|    remark|目录说明|string||
|    updateBy|修改人id|integer||
|    updateTime|更新时间|string||
|  displayNot|是否展示0否1是|string||
|  id||string||
|  parentId|父级目录id(1级为0)|string||
|  remark|目录说明|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"catalogName": "",
"catalogType": "",
"childrenList": [
{
"catalogName": "",
"catalogType": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"displayNot": "",
"id": "",
"nodeList": [
{
"id": "",
"name": ""
}
],
"parentId": "",
"remark": "",
"updateBy": 0,
"updateTime": ""
}
],
"displayNot": "",
"id": "",
"parentId": "",
"remark": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 修改目录
**接口地址**:`/business/catalog/update/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"catalogName": "",
"catalogType": "",
"displayNot": "",
"parentId": "",
"remark": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
|updateDTO|updateDTO|body|true|CatalogUpdateDTO|CatalogUpdateDTO|
|  catalogName|目录名称||false|string||
|  catalogType|导航类型0产品1解决方案||false|string||
|  displayNot|是否展示0否1是||false|string||
|  parentId|父级目录id(1级为0)||false|string||
|  remark|目录说明-100||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查询目录的详细信息(后台端)
**接口地址**:`/business/catalog/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|CatalogVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|catalogName|目录名称|string||
|catalogType|导航类型0产品1解决方案|string||
|createBy|创建人id|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|deleteStatus||string||
|displayNot|是否展示0否1是|string||
|id||string||
|nodeList|该目录下的产品或解决方案|array|NodeVo|
|  id||string||
|  name||string||
|parentId|父级目录id(1级为0)|string||
|remark|目录说明|string||
|updateBy|修改人id|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
**响应示例**:
```javascript
{
"catalogName": "",
"catalogType": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"displayNot": "",
"id": "",
"nodeList": [
{
"id": "",
"name": ""
}
],
"parentId": "",
"remark": "",
"updateBy": 0,
"updateTime": ""
}
```
## 删除目录
**接口地址**:`/business/catalog/{id}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 线索
## 新增线索
**接口地址**:`/business/clue`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": 0,
"deleteStatus": "",
"desc": "",
"facilitatorId": "",
"origin": "",
"originUser": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|销售线索新增Dto|销售线索新增Dto|
|  createBy|||false|integer(int64)||
|  deleteStatus|逻辑删除0未删除1已删除||false|string||
|  desc|线索描述||false|string||
|  facilitatorId|服务商id||false|string||
|  origin|线索来源0咪咕商机线索1服务商商机线索||false|string||
|  originUser|线索提供人||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取列表
**接口地址**:`/business/clue/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|beginTime|创建开始时间|query|false|string(date-time)||
|createBy||query|false|integer(int64)||
|endTime|创建开始时间|query|false|string(date-time)||
|origin|线索来源0咪咕商机线索1服务商商机线索|query|false|string||
|originUser|线索提供人|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«销售线索表»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|销售线索表|
|  clueCode|线索ID生成规则xs + 年-月-日-时-分-秒 + 创建人ID|string||
|  createBy||integer(int64)||
|  createTime||string(date-time)||
|  deleteStatus|逻辑删除0未删除1已删除|string||
|  desc|线索描述|string||
|  facilitatorId|服务商id|string||
|  id||string||
|  origin|线索来源0咪咕商机线索1服务商商机线索|string||
|  originUser|线索提供人|string||
|  updateBy||integer(int64)||
|  updateTime||string(date-time)||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"clueCode": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"desc": "",
"facilitatorId": "",
"id": "",
"origin": "",
"originUser": "",
"updateBy": 0,
"updateTime": ""
}
],
"msg": "",
"total": 0
}
```
## selectOne
**接口地址**:`/business/clue/selectOne`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|销售线索表|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|clueCode|线索ID生成规则xs + 年-月-日-时-分-秒 + 创建人ID|string||
|createBy||integer(int64)|integer(int64)|
|createTime||string(date-time)|string(date-time)|
|deleteStatus|逻辑删除0未删除1已删除|string||
|desc|线索描述|string||
|facilitatorId|服务商id|string||
|id||string||
|origin|线索来源0咪咕商机线索1服务商商机线索|string||
|originUser|线索提供人|string||
|updateBy||integer(int64)|integer(int64)|
|updateTime||string(date-time)|string(date-time)|
**响应示例**:
```javascript
{
"clueCode": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"desc": "",
"facilitatorId": "",
"id": "",
"origin": "",
"originUser": "",
"updateBy": 0,
"updateTime": ""
}
```
## 修改线索
**接口地址**:`/business/clue/update/{id}`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"desc": "",
"facilitatorId": "",
"origin": "",
"originUser": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|销售线索修改Dto|销售线索修改Dto|
|  desc|线索描述||false|string||
|  facilitatorId|服务商id||false|string||
|  origin|线索来源0咪咕商机线索1服务商商机线索||false|string||
|  originUser|线索提供人||false|string||
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 删除线索
**接口地址**:`/business/clue/{id}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 结算单相关接口
## 结算单详情
**接口地址**:`/business/settle/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|SettleVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|approvalId|审批id|string||
|approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|billCode|结算单编号|string||
|billMoney|结算单金额|number||
|billTime|结算单出账日期|string||
|createBy|创建人|integer(int64)|integer(int64)|
|createTime|创建时间|string||
|demandSideId|订单需求方id|string||
|demandSideName|订单需求方name(冗余字段)|string||
|id|id|string||
|orderId|订单id|string||
|relatedBelongId|结算单关联主体关联合作伙伴id|string||
|relatedBelongName|结算单关联主体名称关联合作伙伴名称(咪咕自营-》咪咕自营)|string||
|relatedId|结算单关联主体id能力名称或解决方案名称或产品id|string||
|relatedName|结算单关联主体名称(能力名称或解决方案名称或产品名称)|string||
|relatedProType|结算单关联能力类型|string||
|relatedType|结算单类型0产品、1解决方案2其他订单|string||
|settleBelong|结算单关联主体归属0-咪咕自营1-合作伙伴)|string||
|settleVoList|当前结算单能力关联产品列表|array|SettleVo|
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  billCode|结算单编号|string||
|  billMoney|结算单金额|number||
|  billTime|结算单出账日期|string||
|  createBy|创建人|integer(int64)||
|  createTime|创建时间|string||
|  demandSideId|订单需求方id|string||
|  demandSideName|订单需求方name(冗余字段)|string||
|  id|id|string||
|  orderId|订单id|string||
|  relatedBelongId|结算单关联主体关联合作伙伴id|string||
|  relatedBelongName|结算单关联主体名称关联合作伙伴名称(咪咕自营-》咪咕自营)|string||
|  relatedId|结算单关联主体id能力名称或解决方案名称或产品id|string||
|  relatedName|结算单关联主体名称(能力名称或解决方案名称或产品名称)|string||
|  relatedProType|结算单关联能力类型|string||
|  relatedType|结算单类型0产品、1解决方案2其他订单|string||
|  settleBelong|结算单关联主体归属0-咪咕自营1-合作伙伴)|string||
|  settleVoList|当前结算单能力关联产品列表|array|SettleVo|
|  status|状态:{0已出账2待结算1已结算,3驳回}|string||
|  statusName|状态:{0已出账2待结算1已结算,3驳回}|string||
|  updateBy|修改人|integer(int64)||
|  updateTime|修改时间|string||
|status|状态:{0已出账2待结算1已结算,3驳回}|string||
|statusName|状态:{0已出账2待结算1已结算,3驳回}|string||
|updateBy|修改人|integer(int64)|integer(int64)|
|updateTime|修改时间|string||
**响应示例**:
```javascript
{
"approvalId": "",
"approvalStatus": "",
"billCode": "",
"billMoney": 0,
"billTime": "",
"createBy": 0,
"createTime": "",
"demandSideId": "",
"demandSideName": "",
"id": "",
"orderId": "",
"relatedBelongId": "",
"relatedBelongName": "",
"relatedId": "",
"relatedName": "",
"relatedProType": "",
"relatedType": "",
"settleBelong": "",
"settleVoList": [
{
"approvalId": "",
"approvalStatus": "",
"billCode": "",
"billMoney": 0,
"billTime": "",
"createBy": 0,
"createTime": "",
"demandSideId": "",
"demandSideName": "",
"id": "",
"orderId": "",
"relatedBelongId": "",
"relatedBelongName": "",
"relatedId": "",
"relatedName": "",
"relatedProType": "",
"relatedType": "",
"settleBelong": "",
"settleVoList": [],
"status": "",
"statusName": "",
"updateBy": 0,
"updateTime": ""
}
],
"status": "",
"statusName": "",
"updateBy": 0,
"updateTime": ""
}
```
## export
**接口地址**:`/business/settle/export`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
|approvalStatus|审批状态|query|false|string||
|forApproval|是否审批|query|false|string||
|relateBelong|归属咪咕自营 或xxx生态成员|query|false|string||
|relateName|结算单主体名称|query|false|string||
|relateType|结算单类型 0产品、1解决方案2其他订单|query|false|string||
|settleEndTime|出账结束日期|query|false|string(date-time)||
|settleStartTime|出账开始日期|query|false|string(date-time)||
|settleStatus|结算单状态{0已出账1待结算2已结算}|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## export
**接口地址**:`/business/settle/export/{ids}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
|approvalStatus|审批状态|query|false|string||
|forApproval|是否审批|query|false|string||
|relateBelong|归属咪咕自营 或xxx生态成员|query|false|string||
|relateName|结算单主体名称|query|false|string||
|relateType|结算单类型 0产品、1解决方案2其他订单|query|false|string||
|settleEndTime|出账结束日期|query|false|string(date-time)||
|settleStartTime|出账开始日期|query|false|string(date-time)||
|settleStatus|结算单状态{0已出账1待结算2已结算}|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 结算单查询
**接口地址**:`/business/settle/pageList`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|approvalStatus|审批状态|query|false|string||
|forApproval|是否审批|query|false|string||
|relateBelong|归属咪咕自营 或xxx生态成员|query|false|string||
|relateName|结算单主体名称|query|false|string||
|relateType|结算单类型 0产品、1解决方案2其他订单|query|false|string||
|settleEndTime|出账结束日期|query|false|string(date-time)||
|settleStartTime|出账开始日期|query|false|string(date-time)||
|settleStatus|结算单状态{0已出账1待结算2已结算}|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«SettleVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|SettleVo|
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  billCode|结算单编号|string||
|  billMoney|结算单金额|number||
|  billTime|结算单出账日期|string||
|  createBy|创建人|integer(int64)||
|  createTime|创建时间|string||
|  demandSideId|订单需求方id|string||
|  demandSideName|订单需求方name(冗余字段)|string||
|  id|id|string||
|  orderId|订单id|string||
|  relatedBelongId|结算单关联主体关联合作伙伴id|string||
|  relatedBelongName|结算单关联主体名称关联合作伙伴名称(咪咕自营-》咪咕自营)|string||
|  relatedId|结算单关联主体id能力名称或解决方案名称或产品id|string||
|  relatedName|结算单关联主体名称(能力名称或解决方案名称或产品名称)|string||
|  relatedProType|结算单关联能力类型|string||
|  relatedType|结算单类型0产品、1解决方案2其他订单|string||
|  settleBelong|结算单关联主体归属0-咪咕自营1-合作伙伴)|string||
|  settleVoList|当前结算单能力关联产品列表|array|SettleVo|
|  status|状态:{0已出账2待结算1已结算,3驳回}|string||
|  statusName|状态:{0已出账2待结算1已结算,3驳回}|string||
|  updateBy|修改人|integer(int64)||
|  updateTime|修改时间|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"approvalId": "",
"approvalStatus": "",
"billCode": "",
"billMoney": 0,
"billTime": "",
"createBy": 0,
"createTime": "",
"demandSideId": "",
"demandSideName": "",
"id": "",
"orderId": "",
"relatedBelongId": "",
"relatedBelongName": "",
"relatedId": "",
"relatedName": "",
"relatedProType": "",
"relatedType": "",
"settleBelong": "",
"settleVoList": [],
"status": "",
"statusName": "",
"updateBy": 0,
"updateTime": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 撤回
**接口地址**:`/business/settle/recall/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 结算单结算
**接口地址**:`/business/settle/settlement/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 结算单编辑
**接口地址**:`/business/settle/update`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"billMoney": 0,
"billTime": "",
"demandSideId": "",
"demandSideName": "",
"id": "",
"orderId": "",
"relatedBelongId": "",
"relatedBelongName": "",
"relatedId": "",
"relatedName": "",
"relatedProType": "",
"relatedType": "",
"settleBelong": "",
"settleDetails": [
{
"abilityId": "",
"billEndDate": "",
"billMoney": 0,
"billStartDate": "",
"billingType": "",
"billingUnit": "",
"callNum": 0,
"costing": 0,
"cycleUnit": "",
"id": "",
"orderId": "",
"proId": "",
"proName": "",
"sellingPrice": 0,
"settleId": ""
}
]
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|settleAddDto|账单编辑、修改请求体|body|true|SettleAddDto|SettleAddDto|
|  billMoney|结算单金额||false|number||
|  billTime|结算单出账日期||false|string||
|  demandSideId|订单需求方id||false|string||
|  demandSideName|订单需求方name(冗余字段)||false|string||
|  id|id||false|string||
|  orderId|订单id||false|string||
|  relatedBelongId|结算单关联主体名称关联合作伙伴id||false|string||
|  relatedBelongName|结算单关联主体名称关联合作伙伴名称(咪咕自营-》咪咕自营)||false|string||
|  relatedId|结算单关联主体id能力名称或解决方案名称或产品id||false|string||
|  relatedName|结算单关联主体名称(能力名称或解决方案名称或产品名称)||false|string||
|  relatedProType|结算单关联能力类型||false|string||
|  relatedType|结算单类型0产品、1解决方案2其他订单||false|string||
|  settleBelong|结算单关联主体归属0-咪咕自营1-合作伙伴)||false|string||
|  settleDetails|能力结算单明细||false|array|产品结算单明细表|
|    abilityId|能力id||false|string||
|    billEndDate|结算日期结束||false|string||
|    billMoney|金额||false|number||
|    billStartDate|结算日期开始||false|string||
|    billingType|计费方式类型0按使用量1一次性收费2周期收费||false|string||
|    billingUnit|计价单位0次1流量2容量3时长4人||false|string||
|    callNum|调用次数||false|integer||
|    costing|成本价格||false|number||
|    cycleUnit|周期单位0年1月2季3日||false|string||
|    id|id||false|string||
|    orderId|账单id||false|string||
|    proId|产品id||false|string||
|    proName|产品名称||false|string||
|    sellingPrice|销售价格||false|number||
|    settleId|结算单Id||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 能力标签相关接口
## 新增能力标签
**接口地址**:`/business/abilityTag/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"id": "",
"parentId": "",
"remark": "",
"tagName": "",
"updateBy": 0,
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|abilityTagDto|abilityTagDto|body|true|能力标签|能力标签|
|  createBy|创建者||false|integer(int64)||
|  createTime|创建时间||false|string(date-time)||
|  deleteStatus|逻辑删除0正常1删除||false|string||
|  id|主键||false|string||
|  parentId|上级id||false|string||
|  remark|标签备注||false|string||
|  tagName|标签名称||false|string||
|  updateBy|更新者||false|integer(int64)||
|  updateTime|更新时间||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 能力标签详情
**接口地址**:`/business/abilityTag/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|能力标签0|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|createBy|创建者|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|deleteStatus|逻辑删除0正常1删除|string||
|id|主键|string||
|parentId|上级id|string||
|remark|标签备注|string||
|tagName|标签名称|string||
|updateBy|更新者|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
**响应示例**:
```javascript
{
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"id": "",
"parentId": "",
"remark": "",
"tagName": "",
"updateBy": 0,
"updateTime": ""
}
```
## 能力标签树
**接口地址**:`/business/abilityTag/tree`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 修改能力标签
**接口地址**:`/business/abilityTag/update`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"id": "",
"parentId": "",
"remark": "",
"tagName": "",
"updateBy": 0,
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|abilityTagDto|abilityTagDto|body|true|能力标签|能力标签|
|  createBy|创建者||false|integer(int64)||
|  createTime|创建时间||false|string(date-time)||
|  deleteStatus|逻辑删除0正常1删除||false|string||
|  id|主键||false|string||
|  parentId|上级id||false|string||
|  remark|标签备注||false|string||
|  tagName|标签名称||false|string||
|  updateBy|更新者||false|integer(int64)||
|  updateTime|更新时间||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## remove
**接口地址**:`/business/abilityTag/{id}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 能力相关接口
## 新增
**接口地址**:`/business/ability/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"abilityBelongTo": "",
"abilityDesc": "",
"abilityDownAddress": "",
"abilityInvokeAddress": "",
"abilityName": "",
"abilityPlatformId": "",
"abilityPlatformName": "",
"abilityType": "",
"belongId": "",
"belongName": "",
"gatewayAbilityId": "",
"gatewayAbilityName": "",
"id": "",
"openMode": "",
"validDate": "",
"validDateBegin": "",
"validStatus": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|abilityAddDto|abilityAddDto|body|true|能力新增、修改请求体|能力新增、修改请求体|
|  abilityBelongTo|能力归属0咪咕自有1合作伙伴||false|string||
|  abilityDesc|能力介绍||false|string||
|  abilityDownAddress|下载地址||false|string||
|  abilityInvokeAddress|调用地址||false|string||
|  abilityName|能力名称||false|string||
|  abilityPlatformId|能力平台id||false|string||
|  abilityPlatformName|能力平台名称||false|string||
|  abilityType|能力类型{0API,1SDK2SaaS服务3其他}||false|string||
|  belongId|合作伙伴id||false|string||
|  belongName|合作伙伴名称,咪咕自营的后端手动设置为咪咕自营||false|string||
|  gatewayAbilityId|网关能力id||false|string||
|  gatewayAbilityName|网关能力名称||false|string||
|  id|主键||false|string||
|  openMode|开通方式{0自动开通1人工开通}||false|string||
|  validDate|能力有效期||false|string||
|  validDateBegin|能力有效期--开始时间||false|string||
|  validStatus|能力状态0失效1有效||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查看详情
**接口地址**:`/business/ability/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|AbilityVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|abilityBelongTo|能力归属0咪咕自有1合作伙伴|string||
|abilityDesc|能力平台名称|string||
|abilityDownAddress|下载地址|string||
|abilityInvokeAddress|调用地址|string||
|abilityName|能力名称|string||
|abilityPlatformId|能力平台id|string||
|abilityPlatformName|能力平台名称|string||
|abilityType|能力类型{0API,1SDK2SaaS服务3其他}|string||
|belongId|合作伙伴id|string||
|belongName|合作伙伴名称|string||
|createBy|创建者|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|delFlag|逻辑删除0正常1删除|string||
|gatewayAbilityId|网关能力id|string||
|gatewayAbilityName|网关能力名称|string||
|id|主键|string||
|openMode|开通方式{0自动开通1人工开通}|string||
|updateBy|更新者|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
|validDate|能力有效期--结束时间|string(date-time)|string(date-time)|
|validDateBegin|能力有效期--结束时间|string(date-time)|string(date-time)|
|validStatus|能力状态0失效1有效|string||
**响应示例**:
```javascript
{
"abilityBelongTo": "",
"abilityDesc": "",
"abilityDownAddress": "",
"abilityInvokeAddress": "",
"abilityName": "",
"abilityPlatformId": "",
"abilityPlatformName": "",
"abilityType": "",
"belongId": "",
"belongName": "",
"createBy": 0,
"createTime": "",
"delFlag": "",
"gatewayAbilityId": "",
"gatewayAbilityName": "",
"id": "",
"openMode": "",
"updateBy": 0,
"updateTime": "",
"validDate": "",
"validDateBegin": "",
"validStatus": ""
}
```
## 上架
**接口地址**:`/business/ability/onShelve/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 能力查询
**接口地址**:`/business/ability/pagelist`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|abilityBelongTo|能力归属0咪咕自有1合作伙伴|query|false|string||
|abilityName|能力名称|query|false|string||
|abilityType|能力类型{0API,1SDK2SaaS服务3其他}|query|false|string||
|validStatus|能力状态0失效1有效|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«AbilityVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|AbilityVo|
|  abilityBelongTo|能力归属0咪咕自有1合作伙伴|string||
|  abilityDesc|能力平台名称|string||
|  abilityDownAddress|下载地址|string||
|  abilityInvokeAddress|调用地址|string||
|  abilityName|能力名称|string||
|  abilityPlatformId|能力平台id|string||
|  abilityPlatformName|能力平台名称|string||
|  abilityType|能力类型{0API,1SDK2SaaS服务3其他}|string||
|  belongId|合作伙伴id|string||
|  belongName|合作伙伴名称|string||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  delFlag|逻辑删除0正常1删除|string||
|  gatewayAbilityId|网关能力id|string||
|  gatewayAbilityName|网关能力名称|string||
|  id|主键|string||
|  openMode|开通方式{0自动开通1人工开通}|string||
|  updateBy|更新者|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|  validDate|能力有效期--结束时间|string(date-time)||
|  validDateBegin|能力有效期--结束时间|string(date-time)||
|  validStatus|能力状态0失效1有效|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"abilityBelongTo": "",
"abilityDesc": "",
"abilityDownAddress": "",
"abilityInvokeAddress": "",
"abilityName": "",
"abilityPlatformId": "",
"abilityPlatformName": "",
"abilityType": "",
"belongId": "",
"belongName": "",
"createBy": 0,
"createTime": "",
"delFlag": "",
"gatewayAbilityId": "",
"gatewayAbilityName": "",
"id": "",
"openMode": "",
"updateBy": 0,
"updateTime": "",
"validDate": "",
"validDateBegin": "",
"validStatus": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 关联能力选择列表
**接口地址**:`/business/ability/relateAbility/listByType`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|abilityType|能力类型|query|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«AbilitiesByTypeVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|AbilitiesByTypeVo|
|  abilityCode|编码|string||
|  abilityName|能力名称|string||
|  abilityType|能力类型{0API,1SDK2SaaS服务3其他}|string||
|  abilityTypeName|能力类型名称|string||
|  belongTo|能力归属0咪咕自有1合作伙伴|string||
|  effectTime|能力有效期开始时间|string||
|  unEffectTime|能力有效期结束时间|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"abilityCode": "",
"abilityName": "",
"abilityType": "",
"abilityTypeName": "",
"belongTo": "",
"effectTime": "",
"unEffectTime": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 下架
**接口地址**:`/business/ability/unShelve/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 修改
**接口地址**:`/business/ability/update`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"abilityBelongTo": "",
"abilityDesc": "",
"abilityDownAddress": "",
"abilityInvokeAddress": "",
"abilityName": "",
"abilityPlatformId": "",
"abilityPlatformName": "",
"abilityType": "",
"belongId": "",
"belongName": "",
"gatewayAbilityId": "",
"gatewayAbilityName": "",
"id": "",
"openMode": "",
"validDate": "",
"validDateBegin": "",
"validStatus": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|abilityAddDto|abilityAddDto|body|true|能力新增、修改请求体|能力新增、修改请求体|
|  abilityBelongTo|能力归属0咪咕自有1合作伙伴||false|string||
|  abilityDesc|能力介绍||false|string||
|  abilityDownAddress|下载地址||false|string||
|  abilityInvokeAddress|调用地址||false|string||
|  abilityName|能力名称||false|string||
|  abilityPlatformId|能力平台id||false|string||
|  abilityPlatformName|能力平台名称||false|string||
|  abilityType|能力类型{0API,1SDK2SaaS服务3其他}||false|string||
|  belongId|合作伙伴id||false|string||
|  belongName|合作伙伴名称,咪咕自营的后端手动设置为咪咕自营||false|string||
|  gatewayAbilityId|网关能力id||false|string||
|  gatewayAbilityName|网关能力名称||false|string||
|  id|主键||false|string||
|  openMode|开通方式{0自动开通1人工开通}||false|string||
|  validDate|能力有效期||false|string||
|  validDateBegin|能力有效期--开始时间||false|string||
|  validStatus|能力状态0失效1有效||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 营销门户-通知公告
## 获取通知公告列表
**接口地址**:`/business/pre/notice/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|approval|审核状态 ,1-审核(默认显示 审核中,已通过,驳回)|query|false|string||
|approvalStatus|审核状态 ,1-待审核,2-审核通过,4-审核驳回|query|false|string||
|endTime|发布时间范围止|query|false|string(date-time)||
|noticeType|公告类型1-升级公告、2-安全公告、3-备案公告、4-产品公告、5-其他公告)|query|false|string||
|startTime|发布时间范围起|query|false|string(date-time)||
|status|公告状态(新建-0,审核中-1,已上线-2,已下线-3)|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«NoticeListVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|NoticeListVo|
|  approvalId|审批id|string||
|  createBy|创建者|integer(int64)||
|  createByName|创建者name|string||
|  createTime|创建时间|string(date-time)||
|  noticeContent|公告内容|string||
|  noticeId|公告ID|integer(int64)||
|  noticeTitle|公告标题|string||
|  noticeType|公告类型1-升级公告、2-安全公告、3-备案公告、4-产品公告、5-其他公告)|string||
|  noticeTypeName|公告类型名称|string||
|  remark|备注|string||
|  status|公告状态(新建-0,审核中-1,已上线-2,已下线-3)|string||
|  statusName|公告状态name|string||
|  updateBy|更新者|integer(int64)||
|  updateByName|更新者name|string||
|  updateTime|更新时间|string(date-time)||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"approvalId": "",
"createBy": 0,
"createByName": "",
"createTime": "",
"noticeContent": "",
"noticeId": 0,
"noticeTitle": "",
"noticeType": "",
"noticeTypeName": "",
"remark": "",
"status": "",
"statusName": "",
"updateBy": 0,
"updateByName": "",
"updateTime": ""
}
],
"msg": "",
"total": 0
}
```
## 根据通知公告id获取详细信息
**接口地址**:`/business/pre/notice/{noticeId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|noticeId|noticeId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 营销门户-邀约,招募公告控制器
## 修改公告
**接口地址**:`/business/pre/inviteNotice/edit`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"enclosure": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"failureTime": "",
"id": "",
"noticeContent": "",
"noticeTitle": "",
"noticeType": "",
"serviceProviderId": [],
"sub": true,
"topping": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|editDto|editDto|body|true|InviteEditDto|InviteEditDto|
|  enclosure|附件,最多上传10个文件每个文件大小不超过20M支持pdf、doc、docx等格式||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  failureTime|失效时间||false|string(date-time)||
|  id|id||false|string||
|  noticeContent|公告内容||false|string||
|  noticeTitle|公告标题||false|string||
|  noticeType|公告类型0-邀约公告表,1-招募公告,2-结果公示信息)||false|string||
|  serviceProviderId|服务商id集合||false|array|string|
|  sub|是否发布,true-保存并发布,false-保存||false|boolean||
|  topping|是否置顶,0-不置顶,1-置顶||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取通知公告列表
**接口地址**:`/business/pre/inviteNotice/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|failureTimeEnd|失效时间止|query|false|string(date-time)||
|failureTimeStart|失效时间起|query|false|string(date-time)||
|forApproval|是否审批 true审核 null or false 所有状态|query|false|boolean||
|noticeTitle|公告标题|query|false|string||
|noticeType|公告类型0-邀约公告表,1-招募公告,2-结果公示信息|query|false|string||
|status|新建-0,审核中-1,已上线-2,3-驳回,4-失效|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«InviteListVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|InviteListVo|
|  approvalId|审批id|string||
|  createBy|创建者(发布人员)|integer(int64)||
|  createByName|创建者(发布人员)name|string||
|  createTime|创建时间|string(date-time)||
|  failureTime|失效时间|string(date-time)||
|  id|公告ID|string||
|  noticeContent|公告内容|string||
|  noticeTitle|公告标题|string||
|  noticeType|公告类型0-邀约公告表,1-招募公告,2-结果公示信息)|string||
|  noticeTypeName|公告类型name|string||
|  publicity|是否公示结果 true公示 false null 未公示|boolean||
|  status|新建-0,审核中-1,已上线-2,3-驳回,4-失效|string||
|  statusName|新建-0,审核中-1,已上线-2,3-驳回,4-失效|string||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"approvalId": "",
"createBy": 0,
"createByName": "",
"createTime": "",
"failureTime": "",
"id": "",
"noticeContent": "",
"noticeTitle": "",
"noticeType": "",
"noticeTypeName": "",
"publicity": true,
"status": "",
"statusName": ""
}
],
"msg": "",
"total": 0
}
```
## 撤销公告
**接口地址**:`/business/pre/inviteNotice/revoke/{id}`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 根据id查询公告详情
**接口地址**:`/business/pre/inviteNotice/selectOne`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|InviteVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|approvalId|审批id|string||
|createBy|创建者(发布人员)|integer(int64)|integer(int64)|
|createByName|创建者(发布人员)name|string||
|enclosure|附件,最多上传10个文件每个文件大小不超过20M支持pdf、doc、docx等格式|array|文件表返回VO|
|  dataId|数据id|string||
|  delFlag||string||
|  fileName|文件名称|string||
|  fileOriginName|文件原名称|string||
|  fileSource|文件来源|string||
|  fileUrl|文件地址|string||
|  id|文件ID|string||
|failureTime|失效时间|string(date-time)|string(date-time)|
|id|公告ID|string||
|noticeContent|公告内容|string||
|noticeTitle|公告标题|string||
|noticeType|公告类型0-邀约公告表,1-招募公告,2-结果公示信息)|string||
|noticeTypeName|公告类型name|string||
|serviceProvider|服务商信息|array|ProviderVo|
|  abilityTagIds|行业标签(能力标签)|string||
|  abilityTagName|行业标签(能力标签)|array|string|
|  id|主键|string||
|  phone|联系人电话|string||
|  serviceName|服务商名称|string||
|  serviceTypeIds|服务商类型外键集合,逗号分隔|string||
|  serviceTypeIdsName|服务商类型外键集合,逗号分隔|array|string|
|  status|合作状态0合作种 1已过期|string||
|  statusName|合作状态name|string||
|  userName|联系人姓名|string||
|status|新建-0,审核中-1,已上线-2,3-驳回,4-失效|string||
|statusName|新建-0,审核中-1,已上线-2,3-驳回,4-失效|string||
|topping|是否置顶,0-不置顶,1-置顶|string||
|toppingName|是否置顶name|string||
**响应示例**:
```javascript
{
"approvalId": "",
"createBy": 0,
"createByName": "",
"enclosure": [
{
"dataId": "",
"delFlag": "",
"fileName": "",
"fileOriginName": "",
"fileSource": "",
"fileUrl": "",
"id": ""
}
],
"failureTime": "",
"id": "",
"noticeContent": "",
"noticeTitle": "",
"noticeType": "",
"noticeTypeName": "",
"serviceProvider": [
{
"abilityTagIds": "",
"abilityTagName": [],
"id": "",
"phone": "",
"serviceName": "",
"serviceTypeIds": "",
"serviceTypeIdsName": [],
"status": "",
"statusName": "",
"userName": ""
}
],
"status": "",
"statusName": "",
"topping": "",
"toppingName": ""
}
```
## 删除公告
**接口地址**:`/business/pre/inviteNotice/{ids}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 营销门户产品相关接口
## 产品查询详情
**接口地址**:`/business/pre/product/detail`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|query|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|ProductVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|approvalId|审批id|string||
|approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|configId|营销配置id|string||
|configVo|营销配置|ConfigVo|ConfigVo|
|  bannerBackImgLink|背景链接|string||
|  bannerButtonArray|按钮jsonarray|string||
|  bannerVedioLink|视频链接|string||
|  configDesc|营销产品介绍|string||
|  configName|营销产品名称|string||
|  configType|营销配置类型0产品1解决方案|string||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  id|主键|string||
|  navigationConfigs|组件list|array|产品营销导航配置新增、修改请求体|
|    configId|配置id|string||
|    elementImg|组件图 200|string||
|    elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}|string||
|    elementVos|导航组件list|array|营销配置导航组件表|
|      childElementType|子组件类型0二维码1按钮|string||
|      createBy|创建者|integer||
|      createTime|创建时间|string||
|      delStatus|是否删除0-正常1-已删除)|string||
|      elementButtonLink|子组件按钮链接 200|string||
|      elementButtonName|子组件组件按钮名称 64|string||
|      elementDesc|组件描述 500|string||
|      elementImg|组件图片 200|string||
|      elementName|组件名称 32|string||
|      id|id|string||
|      navigationId|导航id|string||
|      qrCode|子组件二维码字符串 250|string||
|      updateBy|更新者|integer||
|      updateTime|更新时间|string||
|    id|主键|string||
|    navigationName|导航名称 30|string||
|    navigationSort|次序|string||
|    navigationType|导航类型0链接跳转1组件|string||
|    navigationdDesc|导航描述 1000|string||
|    navigationlink|导航链接|string||
|  updateBy|更新者|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|consoleUrl|管理控制台链接|string||
|createBy|创建者|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|id|主键|string||
|productAbilityVos|能力配置|array|ProductAbilityVo|
|  abilityBelongTo|能力归属0咪咕自有1合作伙伴|string||
|  abilityDownAddress|下载地址|string||
|  abilityId|能力id|string||
|  abilityInvokeAddress|调用地址|string||
|  abilityName|能力名称|string||
|  abilityPlatformId|能力平台id|string||
|  abilityPlatformName|能力平台名称|string||
|  abilityType|能力类型{0API,1SDK2SaaS服务3其他}|string||
|  belongId|能力所属生态成员id|string||
|  belongName|能力所属生态成员或自营名称|string||
|  billingRule|计费规则类型0-标准价格1-阶梯价格)|string||
|  billingType|计费方式类型0按使用量1一次性收费2周期收费|string||
|  billingUnit|计价单位0次1流量2容量3时长4人|string||
|  costing|成本价格|number||
|  cycleUnit|周期单位0年1月2季3日|string||
|  gatewayAbilityId|网关能力id|string||
|  gatewayAbilityName|网关能力名称|string||
|  id|主键|string||
|  ladderArray|阶梯计费价格|string||
|  openMode|能力开通方式|string||
|  productId|产品id|string||
|  selling|销售价格|number||
|  validDate|能力有效期结束时间|string(date-time)||
|  validDateBegin|能力有效期开始时间|string(date-time)||
|  validStatus|能力状态0失效1有效|string||
|productCatalogId|产品目录id|string||
|productCatalogName|产品目录名称|string||
|productDesc|产品介绍|string||
|productEnglishName|产品英文名|string||
|productName|产品名称|string||
|productStatus|产品状态0未提交、1审核中2审核不通过3已创建4已上架5已下架6已失效|string||
|updateBy|更新者|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
|userName|提交人名称|string||
**响应示例**:
```javascript
{
"approvalId": "",
"approvalStatus": "",
"configId": "",
"configVo": {
"bannerBackImgLink": "",
"bannerButtonArray": "",
"bannerVedioLink": "",
"configDesc": "",
"configName": "",
"configType": "",
"createBy": 0,
"createTime": "",
"id": "",
"navigationConfigs": [
{
"configId": "",
"elementImg": "",
"elementType": "",
"elementVos": [
{
"childElementType": "",
"createBy": 0,
"createTime": "",
"delStatus": "",
"elementButtonLink": "",
"elementButtonName": "",
"elementDesc": "",
"elementImg": "",
"elementName": "",
"id": "",
"navigationId": "",
"qrCode": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"navigationName": "",
"navigationSort": "",
"navigationType": "",
"navigationdDesc": "",
"navigationlink": ""
}
],
"updateBy": 0,
"updateTime": ""
},
"consoleUrl": "",
"createBy": 0,
"createTime": "",
"id": "",
"productAbilityVos": [
{
"abilityBelongTo": "",
"abilityDownAddress": "",
"abilityId": "",
"abilityInvokeAddress": "",
"abilityName": "",
"abilityPlatformId": "",
"abilityPlatformName": "",
"abilityType": "",
"belongId": "",
"belongName": "",
"billingRule": "",
"billingType": "",
"billingUnit": "",
"costing": 0,
"cycleUnit": "",
"gatewayAbilityId": "",
"gatewayAbilityName": "",
"id": "",
"ladderArray": "",
"openMode": "",
"productId": "",
"selling": 0,
"validDate": "",
"validDateBegin": "",
"validStatus": ""
}
],
"productCatalogId": "",
"productCatalogName": "",
"productDesc": "",
"productEnglishName": "",
"productName": "",
"productStatus": "",
"updateBy": 0,
"updateTime": "",
"userName": ""
}
```
## 产品列表
**接口地址**:`/business/pre/product/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|productName|productName|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|CatalogMarketVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|catalogMarketVo|该目录下的子集目录|array|CatalogMarketVo|
|  catalogMarketVo|该目录下的子集目录|array|CatalogMarketVo|
|  catalogName|目录名称|string||
|  id|导航id|string||
|  nodeVos|该目录下的产品或解决方案|array|NodeVo|
|    id||string||
|    name||string||
|  parentId|父级目录id(1级为0)|string||
|catalogName|目录名称|string||
|id|导航id|string||
|nodeVos|该目录下的产品或解决方案|array|NodeVo|
|  id||string||
|  name||string||
|parentId|父级目录id(1级为0)|string||
**响应示例**:
```javascript
[
{
"catalogMarketVo": [
{
"catalogMarketVo": [],
"catalogName": "",
"id": "",
"nodeVos": [],
"parentId": ""
}
],
"catalogName": "",
"id": "",
"nodeVos": [
{
"id": "",
"name": ""
}
],
"parentId": ""
}
]
```
## 产品推荐
**接口地址**:`/business/pre/product/recommend`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|ProductVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|approvalId|审批id|string||
|approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|configId|营销配置id|string||
|configVo|营销配置|ConfigVo|ConfigVo|
|  bannerBackImgLink|背景链接|string||
|  bannerButtonArray|按钮jsonarray|string||
|  bannerVedioLink|视频链接|string||
|  configDesc|营销产品介绍|string||
|  configName|营销产品名称|string||
|  configType|营销配置类型0产品1解决方案|string||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  id|主键|string||
|  navigationConfigs|组件list|array|产品营销导航配置新增、修改请求体|
|    configId|配置id|string||
|    elementImg|组件图 200|string||
|    elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}|string||
|    elementVos|导航组件list|array|营销配置导航组件表|
|      childElementType|子组件类型0二维码1按钮|string||
|      createBy|创建者|integer||
|      createTime|创建时间|string||
|      delStatus|是否删除0-正常1-已删除)|string||
|      elementButtonLink|子组件按钮链接 200|string||
|      elementButtonName|子组件组件按钮名称 64|string||
|      elementDesc|组件描述 500|string||
|      elementImg|组件图片 200|string||
|      elementName|组件名称 32|string||
|      id|id|string||
|      navigationId|导航id|string||
|      qrCode|子组件二维码字符串 250|string||
|      updateBy|更新者|integer||
|      updateTime|更新时间|string||
|    id|主键|string||
|    navigationName|导航名称 30|string||
|    navigationSort|次序|string||
|    navigationType|导航类型0链接跳转1组件|string||
|    navigationdDesc|导航描述 1000|string||
|    navigationlink|导航链接|string||
|  updateBy|更新者|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|consoleUrl|管理控制台链接|string||
|createBy|创建者|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|id|主键|string||
|productAbilityVos|能力配置|array|ProductAbilityVo|
|  abilityBelongTo|能力归属0咪咕自有1合作伙伴|string||
|  abilityDownAddress|下载地址|string||
|  abilityId|能力id|string||
|  abilityInvokeAddress|调用地址|string||
|  abilityName|能力名称|string||
|  abilityPlatformId|能力平台id|string||
|  abilityPlatformName|能力平台名称|string||
|  abilityType|能力类型{0API,1SDK2SaaS服务3其他}|string||
|  belongId|能力所属生态成员id|string||
|  belongName|能力所属生态成员或自营名称|string||
|  billingRule|计费规则类型0-标准价格1-阶梯价格)|string||
|  billingType|计费方式类型0按使用量1一次性收费2周期收费|string||
|  billingUnit|计价单位0次1流量2容量3时长4人|string||
|  costing|成本价格|number||
|  cycleUnit|周期单位0年1月2季3日|string||
|  gatewayAbilityId|网关能力id|string||
|  gatewayAbilityName|网关能力名称|string||
|  id|主键|string||
|  ladderArray|阶梯计费价格|string||
|  openMode|能力开通方式|string||
|  productId|产品id|string||
|  selling|销售价格|number||
|  validDate|能力有效期结束时间|string(date-time)||
|  validDateBegin|能力有效期开始时间|string(date-time)||
|  validStatus|能力状态0失效1有效|string||
|productCatalogId|产品目录id|string||
|productCatalogName|产品目录名称|string||
|productDesc|产品介绍|string||
|productEnglishName|产品英文名|string||
|productName|产品名称|string||
|productStatus|产品状态0未提交、1审核中2审核不通过3已创建4已上架5已下架6已失效|string||
|updateBy|更新者|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
|userName|提交人名称|string||
**响应示例**:
```javascript
[
{
"approvalId": "",
"approvalStatus": "",
"configId": "",
"configVo": {
"bannerBackImgLink": "",
"bannerButtonArray": "",
"bannerVedioLink": "",
"configDesc": "",
"configName": "",
"configType": "",
"createBy": 0,
"createTime": "",
"id": "",
"navigationConfigs": [
{
"configId": "",
"elementImg": "",
"elementType": "",
"elementVos": [
{
"childElementType": "",
"createBy": 0,
"createTime": "",
"delStatus": "",
"elementButtonLink": "",
"elementButtonName": "",
"elementDesc": "",
"elementImg": "",
"elementName": "",
"id": "",
"navigationId": "",
"qrCode": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"navigationName": "",
"navigationSort": "",
"navigationType": "",
"navigationdDesc": "",
"navigationlink": ""
}
],
"updateBy": 0,
"updateTime": ""
},
"consoleUrl": "",
"createBy": 0,
"createTime": "",
"id": "",
"productAbilityVos": [
{
"abilityBelongTo": "",
"abilityDownAddress": "",
"abilityId": "",
"abilityInvokeAddress": "",
"abilityName": "",
"abilityPlatformId": "",
"abilityPlatformName": "",
"abilityType": "",
"belongId": "",
"belongName": "",
"billingRule": "",
"billingType": "",
"billingUnit": "",
"costing": 0,
"cycleUnit": "",
"gatewayAbilityId": "",
"gatewayAbilityName": "",
"id": "",
"ladderArray": "",
"openMode": "",
"productId": "",
"selling": 0,
"validDate": "",
"validDateBegin": "",
"validStatus": ""
}
],
"productCatalogId": "",
"productCatalogName": "",
"productDesc": "",
"productEnglishName": "",
"productName": "",
"productStatus": "",
"updateBy": 0,
"updateTime": "",
"userName": ""
}
]
```
# 营销门户企业相关接口
## 认证
**接口地址**:`/business/pre/enterprise/auth`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"address": "",
"approvalId": "",
"approvalStatus": "",
"businessLicense": "",
"businessLicenseName": "",
"businessScope": "",
"contactNum": "",
"createBy": 0,
"createTime": "",
"delFlag": "",
"enterpriseName": "",
"enterpriseType": "",
"legalRepresent": "",
"registeredCapital": 0,
"staffSize": 0,
"templateType": "",
"updateBy": 0,
"updateTime": "",
"userId": 0
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|enterpriseAuthDto|enterpriseAuthDto|body|true|企业认证相关|企业认证相关|
|  address|地址 最大长度200||false|string||
|  approvalId|审批id||false|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核||false|string||
|  businessLicense|营业执照 最大长度200||false|string||
|  businessLicenseName|营业执照文件名称 最大长度50||false|string||
|  businessScope|营业范围 最大长度50||false|string||
|  contactNum|联系电话 最大长度16||false|string||
|  createBy|创建者||false|integer(int64)||
|  createTime|创建时间||false|string(date-time)||
|  delFlag|删除标志;0未删除1已删除||false|string||
|  enterpriseName|企业名称 长度1-200||false|string||
|  enterpriseType|企业类型 最大长度2||false|string||
|  legalRepresent|法定代表人 最大长度500||false|string||
|  registeredCapital|注册资本 最大长度14位||false|number||
|  staffSize|人员规模 最大长度4||false|integer(int32)||
|  templateType|统一社会信用代码 长度1-20||false|string||
|  updateBy|更新者||false|integer(int64)||
|  updateTime|更新时间||false|string(date-time)||
|  userId|用户id,生态成员端可以直接从登录信息种获取||false|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查看企业详情
**接口地址**:`/business/pre/enterprise/detail`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 营销门户动态消息controller
## 获取动态消息
**接口地址**:`/business/pre/dataMessage/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|createTime|生成时间|query|false|string(date-time)||
|dataId|数据id|query|false|string||
|dataSource|数据来源|query|false|string||
|id|id|query|false|string||
|messageContent|消息内容|query|false|string||
|messageType|消息类型A0新建工单A1工单流转A2工单关闭B0新建需求单B1需求单流转B2需求单关闭|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«动态信息对象Vo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|动态信息对象Vo|
|  createTime|生成时间|string(date-time)||
|  dataId|数据id|string||
|  dataSource|数据来源|string||
|  id|id|string||
|  messageContent|消息内容|string||
|  messageType|消息类型A0新建工单A1工单流转A2工单关闭B0新建需求单B1需求单流转B2需求单关闭|string||
|  messageTypeName|消息类型A0新建工单A1工单流转A2工单关闭B0新建需求单B1需求单流转B2需求单关闭|string||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"createTime": "",
"dataId": "",
"dataSource": "",
"id": "",
"messageContent": "",
"messageType": "",
"messageTypeName": ""
}
],
"msg": "",
"total": 0
}
```
# 营销门户审核
## 审批
**接口地址**:`/business/pre/approval/edit/{id}`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"approvalDesc": "",
"approvalStatus": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|审批记录修改对象dto|审批记录修改对象dto|
|  approvalDesc|审批描述||false|string||
|  approvalStatus|审批状态 2驳回 1通过||false|string||
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 审批list查询
**接口地址**:`/business/pre/approval/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|approvalDesc|审批描述|query|false|string||
|approvalStatus|审批状态 2驳回 1通过 0待审核|query|false|string||
|dataId|审批数据ID|query|false|string||
|dataSource|审批来源{A0 产品创建审核A1 产品上下架审核B0解决方案创建审核B1解决方案上下架审核C0企业认证审核D0能力注册审核E0账单核算核审F0订单审核G0租户服务开通审核}}|query|false|string||
|handerId|审批人|query|false|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«审批对象vo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|审批对象vo|
|  approvalDesc|审批描述|string||
|  approvalId|审批ID|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  approvalTime|审批时间|string(date-time)||
|  createBy|提交人|integer(int64)||
|  createByName|提交人名称|string||
|  createTime|提交时间|string(date-time)||
|  dataId|审批数据ID|string||
|  dataSource|审批来源{A0 产品创建审核A1 产品上下架审核B0解决方案创建审核B1解决方案上下架审核C0企业认证审核D0能力注册审核E0账单核算核审F0订单审核G0租户服务开通审核}}|string||
|  dataSourceName|审批来源{A0 产品创建审核A1 产品上下架审核B0解决方案创建审核B1解决方案上下架审核C0企业认证审核D0能力注册审核E0账单核算核审F0订单审核G0租户服务开通审核}}|string||
|  handerId|审批人|integer(int64)||
|  handlerName|审批人姓名|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"approvalDesc": "",
"approvalId": "",
"approvalStatus": "",
"approvalTime": "",
"createBy": 0,
"createByName": "",
"createTime": "",
"dataId": "",
"dataSource": "",
"dataSourceName": "",
"handerId": 0,
"handlerName": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 工作台list查询
**接口地址**:`/business/pre/approval/opList`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 通过审批id查看审批详情
**接口地址**:`/business/pre/approval/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 营销门户客户相关接口
## 新增
**接口地址**:`/business/pre/customer/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"avatar": "",
"email": "",
"enterpriseName": "",
"nickName": "",
"password": "",
"phonenumber": "",
"userName": "",
"userType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|customerDto|customerDto|body|true|CustomerAddDto|CustomerAddDto|
|  avatar|用户头像 长度1-100||false|string||
|  email|用户邮箱 长度1-50||false|string||
|  enterpriseName|企业名称 长度1-200||false|string||
|  nickName|用户名称 长度2-30||false|string||
|  password|密码 长度6-50||false|string||
|  phonenumber|手机号码 长度11||false|string||
|  userName|用户账号 长度2-30||false|string||
|  userType|账号类型 A0系统A1客户A2生态成员 长度6-50||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查看客户详情
**接口地址**:`/business/pre/customer/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 客户管理分页列表
**接口地址**:`/business/pre/customer/pagelist`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|avatar|用户头像 长度1-100|query|false|string||
|email|用户邮箱 长度1-50|query|false|string||
|enterpriseName|企业名称 长度1-200|query|false|string||
|nickName|用户名称 长度2-30|query|false|string||
|phonenumber|手机号码 长度11|query|false|string||
|userType|用户类型 A0系统用户,A1客户,A2团队成员|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«客户管理»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|客户管理|
|  authStatus|企业认证状态 2驳回 1通过 0待审核|string||
|  avatar|用户头像|string||
|  email|用户邮箱|string||
|  enterpriseId|企业id|string||
|  enterpriseName|企业名称|string||
|  loginDate|最后登录时间|string(date-time)||
|  nickName|用户名称|string||
|  phonenumber|手机号码|string||
|  status|帐号状态|string||
|  userId|用户ID|integer(int64)||
|  userName|登录名称|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"authStatus": "",
"avatar": "",
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"nickName": "",
"phonenumber": "",
"status": "",
"userId": 0,
"userName": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 修改客户手机或邮箱或头像
**接口地址**:`/business/pre/customer/update/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"avatar": "",
"email": "",
"phonenumber": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|customerDto|customerDto|body|true|CustomerEditDto|CustomerEditDto|
|  avatar|用户头像 长度1-100||false|string||
|  email|用户邮箱 长度1-50||false|string||
|  phonenumber|手机号码 长度11||false|string||
|id|id|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 营销门户工单
## 分配执行人
**接口地址**:`/business/pre/WorkOrder/distribution/{id}/{workerId}/{worker}`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|工单id|path|true|string||
|worker|用户昵称|path|true|string||
|workerId|用户id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取执行人列表
**接口地址**:`/business/pre/WorkOrder/executor`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|roleId|roleId|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«RoleVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|RoleVo|
|  children||array|UserVo|
|    company||string||
|    email||string||
|    telephone||string||
|    userId||string||
|    userName||string||
|  des||string||
|  roleId||string||
|  roleName||string||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"children": [
{
"company": "",
"email": "",
"telephone": "",
"userId": "",
"userName": ""
}
],
"des": "",
"roleId": "",
"roleName": ""
}
],
"msg": "",
"total": 0
}
```
## 执行人反馈工单
**接口地址**:`/business/pre/WorkOrder/feedback`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"feedback": "",
"id": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|执行人反馈工单dto|执行人反馈工单dto|
|  feedback|反馈说明||false|string||
|  id|||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 工单信息list查询
**接口地址**:`/business/pre/WorkOrder/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|createBy|创建者-16|query|false|string||
|orderId|订单id|query|false|string||
|relatedName|关联名称|query|false|string||
|relatedType|工单来源0产品1解决方案2其他订单|query|false|string||
|worker|执行人|query|false|string||
|workOrderCode|工单编号|query|false|string||
|workOrderState|工单状态(0新建,1已分配2已拒绝3已交付4已竣工)|query|false|string||
|workOrderType|工单开通类型(0表示自动开通,1人工开通)-1|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«WorkOrderListVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|WorkOrderListVo|
|  abilityName|能力名称|string||
|  createTime|提交时间|string(date-time)||
|  id|工单id|string||
|  orderId|订单id|string||
|  productDesc|其他订单-交付内容|string||
|  relatedName|订购产品名称(当类型为解决方案时存解决方案名称)-32|string||
|  relatedType|工单来源0产品1解决方案2其他订单|string||
|  relatedTypeName|工单来源Name0产品1解决方案2其他订单|string||
|  workOrderCode|工单编号|string||
|  workOrderState|工单状态|string||
|  workOrderStateName|工单状态Name|string||
|  workOrderType|工单开通类型(0表示自动开通,1人工开通)|string||
|  workOrderTypeName|工单开通类型Name(0表示自动开通,1人工开通)|string||
|  worker|执行人|string||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"abilityName": "",
"createTime": "",
"id": "",
"orderId": "",
"productDesc": "",
"relatedName": "",
"relatedType": "",
"relatedTypeName": "",
"workOrderCode": "",
"workOrderState": "",
"workOrderStateName": "",
"workOrderType": "",
"workOrderTypeName": "",
"worker": ""
}
],
"msg": "",
"total": 0
}
```
## 工作台工单信息list
**接口地址**:`/business/pre/WorkOrder/opList`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 执行人接收-拒绝
**接口地址**:`/business/pre/WorkOrder/receiveOrRefuse`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|工单id|query|false|string||
|state|状态 2-拒绝 , 1-接收|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 通过工单Id查看工单信息详情
**接口地址**:`/business/pre/WorkOrder/{workOrderId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|workOrderId|workOrderId|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 营销门户消息
## 根据登录用户查询所有未读消息,超级管理员返回所有未读消息数
**接口地址**:`/business/pre/msg/count`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 批量删除
**接口地址**:`/business/pre/msg/deletes/{ids}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 根据登录用户查询所有未读列表,超级管理员返回所有未读数据(最近的99条消息)
**接口地址**:`/business/pre/msg/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## 查询当前登录用户的所有消息或所有未读消息,如果是超级管理员,返回所有用户的
**接口地址**:`/business/pre/msg/listByReadFlag`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|msgSource|消息来源,\nA0工单已竣工 A1工单分配执行人 A2工单执行人接收工单 A3工单执行人拒绝工单 \nB0订单已完成 B1 账单已出账 B2账单待核销 B3账单已核销\nC0线上需求单已提交 C1线上需求单分配客户经理 C2线上需求单关闭 C3线下需求单关闭\nD0审核完成\nE0结算单已出账 E1结算单待结算 E2结算单已结算|query|false|string||
|msgType|消息类型 0消息通知 1待办事项|query|false|string||
|readFlag|阅读标签0未阅读1已阅|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [],
"msg": "",
"total": 0
}
```
## 设置为全部已读
**接口地址**:`/business/pre/msg/readAll`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 批量已读
**接口地址**:`/business/pre/msg/reads/{ids}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取消息详情
**接口地址**:`/business/pre/msg/selectById/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|操作通知对象Vo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|content|内容|string||
|createBy|创建人|string||
|createTime|创建时间|string(date-time)|string(date-time)|
|id|id|string||
|msgSource|消息来源,\nA0工单已竣工 A1工单分配执行人 A2工单执行人接收工单 A3工单执行人拒绝工单 \nB0订单已完成 B1 账单已出账 B2账单待核销 B3账单已核销\nC0线上需求单已提交 C1线上需求单分配客户经理 C2线上需求单关闭 C3线下需求单关闭\nD0审核完成\nE0结算单已出账 E1结算单待结算 E2结算单已结算|string||
|msgSourceName|消息来源名称|string||
|msgStatus|状态0开放1关闭|string||
|msgType|消息类型 0消息通知 1待办|string||
|msgTypeName|消息类型名称|string||
|readFlag|阅读标签0未阅读1已阅|string||
|receiveUserId|收件人id|integer(int64)|integer(int64)|
|resourceId|关联资源id|string||
|resourceType| 跳转工单详情页A0,\n 分配工单执行人A1,\n 跳转订单详情页B0,\n 跳转账单详情页C0,\n 跳转线上需求单详情页D0,\n 跳转需求单详情页D1,\n 跳转审批详情页E0,\n 跳转单据页(企业认证审核)F0,\n 跳转单据页(产品新建、上下架审核)F1,\n 跳转单据页(解决方案新建、上下架审核)F2,\n 跳转单据页(订单创建审核)F3,\n 跳转单据页(账单出账审核)F4,\n 跳转单据页(公告审核)F5|string||
|title|标题|string||
|updateBy|修改人|string||
|updateTime|修改时间|string(date-time)|string(date-time)|
**响应示例**:
```javascript
{
"content": "",
"createBy": "",
"createTime": "",
"id": "",
"msgSource": "",
"msgSourceName": "",
"msgStatus": "",
"msgType": "",
"msgTypeName": "",
"readFlag": "",
"receiveUserId": 0,
"resourceId": "",
"resourceType": "",
"title": "",
"updateBy": "",
"updateTime": ""
}
```
## 根据通知id修改通知状态为已读
**接口地址**:`/business/pre/msg/update/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 营销门户用户管理控制器
## 新增xxx
**接口地址**:`/business/marketingUser`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"avatar": "",
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"loginIp": "",
"nickName": "",
"password": "",
"phonenumber": "",
"remark": "",
"sex": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userId": 0,
"userName": "",
"userType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|user|user|body|true|营销门户用户信息表|营销门户用户信息表|
|  avatar|头像地址||false|string||
|  createBy|创建者||false|string||
|  createTime|创建时间||false|string(date-time)||
|  delFlag|删除标志0代表存在 2代表删除||false|string||
|  deptId|部门ID||false|integer(int64)||
|  email|用户邮箱||false|string||
|  enterpriseId|企业id||false|string||
|  enterpriseName|企业名称||false|string||
|  loginDate|最后登录时间||false|string(date-time)||
|  loginIp|最后登录IP||false|string||
|  nickName|用户昵称||false|string||
|  password|密码||false|string||
|  phonenumber|手机号码||false|string||
|  remark|备注||false|string||
|  sex|用户性别0男 1女 2未知||false|string||
|  status|帐号状态0正常 1停用||false|string||
|  updateBy|更新者||false|string||
|  updateTime|更新时间||false|string(date-time)||
|  userId|用户ID||false|integer(int64)||
|  userName|用户账号||false|string||
|  userType|用户类型00客户账号,01生态成员||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 修改xxx
**接口地址**:`/business/marketingUser`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"avatar": "",
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"loginIp": "",
"nickName": "",
"password": "",
"phonenumber": "",
"remark": "",
"sex": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userId": 0,
"userName": "",
"userType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|user|user|body|true|营销门户用户信息表|营销门户用户信息表|
|  avatar|头像地址||false|string||
|  createBy|创建者||false|string||
|  createTime|创建时间||false|string(date-time)||
|  delFlag|删除标志0代表存在 2代表删除||false|string||
|  deptId|部门ID||false|integer(int64)||
|  email|用户邮箱||false|string||
|  enterpriseId|企业id||false|string||
|  enterpriseName|企业名称||false|string||
|  loginDate|最后登录时间||false|string(date-time)||
|  loginIp|最后登录IP||false|string||
|  nickName|用户昵称||false|string||
|  password|密码||false|string||
|  phonenumber|手机号码||false|string||
|  remark|备注||false|string||
|  sex|用户性别0男 1女 2未知||false|string||
|  status|帐号状态0正常 1停用||false|string||
|  updateBy|更新者||false|string||
|  updateTime|更新时间||false|string(date-time)||
|  userId|用户ID||false|integer(int64)||
|  userName|用户账号||false|string||
|  userType|用户类型00客户账号,01生态成员||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## register
**接口地址**:`/business/marketingUser/register`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"avatar": "",
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"loginIp": "",
"nickName": "",
"password": "",
"phonenumber": "",
"remark": "",
"sex": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userId": 0,
"userName": "",
"userType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|user|user|body|true|营销门户用户信息表|营销门户用户信息表|
|  avatar|头像地址||false|string||
|  createBy|创建者||false|string||
|  createTime|创建时间||false|string(date-time)||
|  delFlag|删除标志0代表存在 2代表删除||false|string||
|  deptId|部门ID||false|integer(int64)||
|  email|用户邮箱||false|string||
|  enterpriseId|企业id||false|string||
|  enterpriseName|企业名称||false|string||
|  loginDate|最后登录时间||false|string(date-time)||
|  loginIp|最后登录IP||false|string||
|  nickName|用户昵称||false|string||
|  password|密码||false|string||
|  phonenumber|手机号码||false|string||
|  remark|备注||false|string||
|  sex|用户性别0男 1女 2未知||false|string||
|  status|帐号状态0正常 1停用||false|string||
|  updateBy|更新者||false|string||
|  updateTime|更新时间||false|string(date-time)||
|  userId|用户ID||false|integer(int64)||
|  userName|用户账号||false|string||
|  userType|用户类型00客户账号,01生态成员||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«boolean»|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||boolean||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": true,
"msg": ""
}
```
## selectOne
**接口地址**:`/business/marketingUser/selectByName/{username}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|username|username|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«营销门户用户信息表»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||营销门户用户信息表|营销门户用户信息表|
|  avatar|头像地址|string||
|  createBy|创建者|string||
|  createTime|创建时间|string(date-time)||
|  delFlag|删除标志0代表存在 2代表删除|string||
|  deptId|部门ID|integer(int64)||
|  email|用户邮箱|string||
|  enterpriseId|企业id|string||
|  enterpriseName|企业名称|string||
|  loginDate|最后登录时间|string(date-time)||
|  loginIp|最后登录IP|string||
|  nickName|用户昵称|string||
|  password|密码|string||
|  phonenumber|手机号码|string||
|  remark|备注|string||
|  sex|用户性别0男 1女 2未知|string||
|  status|帐号状态0正常 1停用|string||
|  updateBy|更新者|string||
|  updateTime|更新时间|string(date-time)||
|  userId|用户ID|integer(int64)||
|  userName|用户账号|string||
|  userType|用户类型00客户账号,01生态成员|string||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {
"avatar": "",
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"loginIp": "",
"nickName": "",
"password": "",
"phonenumber": "",
"remark": "",
"sex": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userId": 0,
"userName": "",
"userType": ""
},
"msg": ""
}
```
## selectOne
**接口地址**:`/business/marketingUser/selectOne`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|query|false|integer(int32)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|营销门户用户信息表|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|avatar|头像地址|string||
|createBy|创建者|string||
|createTime|创建时间|string(date-time)|string(date-time)|
|delFlag|删除标志0代表存在 2代表删除|string||
|deptId|部门ID|integer(int64)|integer(int64)|
|email|用户邮箱|string||
|enterpriseId|企业id|string||
|enterpriseName|企业名称|string||
|loginDate|最后登录时间|string(date-time)|string(date-time)|
|loginIp|最后登录IP|string||
|nickName|用户昵称|string||
|password|密码|string||
|phonenumber|手机号码|string||
|remark|备注|string||
|sex|用户性别0男 1女 2未知|string||
|status|帐号状态0正常 1停用|string||
|updateBy|更新者|string||
|updateTime|更新时间|string(date-time)|string(date-time)|
|userId|用户ID|integer(int64)|integer(int64)|
|userName|用户账号|string||
|userType|用户类型00客户账号,01生态成员|string||
**响应示例**:
```javascript
{
"avatar": "",
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"loginIp": "",
"nickName": "",
"password": "",
"phonenumber": "",
"remark": "",
"sex": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userId": 0,
"userName": "",
"userType": ""
}
```
## selectUserInfo
**接口地址**:`/business/marketingUser/selectUserInfo`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|R«营销门户用户信息表»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|data||营销门户用户信息表|营销门户用户信息表|
|  avatar|头像地址|string||
|  createBy|创建者|string||
|  createTime|创建时间|string(date-time)||
|  delFlag|删除标志0代表存在 2代表删除|string||
|  deptId|部门ID|integer(int64)||
|  email|用户邮箱|string||
|  enterpriseId|企业id|string||
|  enterpriseName|企业名称|string||
|  loginDate|最后登录时间|string(date-time)||
|  loginIp|最后登录IP|string||
|  nickName|用户昵称|string||
|  password|密码|string||
|  phonenumber|手机号码|string||
|  remark|备注|string||
|  sex|用户性别0男 1女 2未知|string||
|  status|帐号状态0正常 1停用|string||
|  updateBy|更新者|string||
|  updateTime|更新时间|string(date-time)||
|  userId|用户ID|integer(int64)||
|  userName|用户账号|string||
|  userType|用户类型00客户账号,01生态成员|string||
|msg||string||
**响应示例**:
```javascript
{
"code": 0,
"data": {
"avatar": "",
"createBy": "",
"createTime": "",
"delFlag": "",
"deptId": 0,
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"loginIp": "",
"nickName": "",
"password": "",
"phonenumber": "",
"remark": "",
"sex": "",
"status": "",
"updateBy": "",
"updateTime": "",
"userId": 0,
"userName": "",
"userType": ""
},
"msg": ""
}
```
## 删除xxx
**接口地址**:`/business/marketingUser/{ids}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 营销门户端服务商申请单相关接口
## 新增服务商申请单
**接口地址**:`/business/pre/applyInfo/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"applyName": "",
"applyUserName": "",
"approvalInfo": "",
"email": "",
"fileList": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"noticeId": "",
"userName": "",
"userPhone": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|providerApplyInfoAddDto|providerApplyInfoAddDto|body|true|新增服务商申请单|新增服务商申请单|
|  applyName|申请单名称||false|string||
|  applyUserName|申请人姓名||false|string||
|  approvalInfo|申请信息||false|string||
|  email|联系人邮箱||false|string||
|  fileList|申请文件列表||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  noticeId|公告主键||false|string||
|  userName|联系人姓名||false|string||
|  userPhone|联系人手机号||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查看服务商申请单详情
**接口地址**:`/business/pre/applyInfo/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 服务商申请单分页列表
**接口地址**:`/business/pre/applyInfo/service/pagelist`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|applyName|申请单名称|query|false|string||
|applyNum|申请单编号|query|false|string||
|applyStatus|申请状态|query|false|string||
|applyStatusList||query|false|array|string|
|applyTime|申请提交时间|query|false|string(date-time)||
|applyType|申请单类型 0服务商1调用单|query|false|string||
|applyUserName|申请人名称|query|false|string||
|endTime|结束时间|query|false|string(date-time)||
|forApproval|是否审批 true审核 null or false 所有状态|query|false|boolean||
|id|主键|query|false|string||
|noticeName|公告名称|query|false|string||
|serviceProviderId|服务商外键|query|false|string||
|startTime|开始时间|query|false|string(date-time)||
|userId|联系人id|query|false|string||
|userName|申请人姓名|query|false|string||
|userPhone|联系人手机号|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«ApplyInfoVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|ApplyInfoVo|
|  applyFileList|申请文件列表|array|文件表返回VO|
|    dataId|数据id|string||
|    delFlag||string||
|    fileName|文件名称|string||
|    fileOriginName|文件原名称|string||
|    fileSource|文件来源|string||
|    fileUrl|文件地址|string||
|    id|文件ID|string||
|  applyName|申请单名称|string||
|  applyNum|申请单编号|string||
|  applyStatus|申请状态|string||
|  applyTime|申请提交时间|string(date-time)||
|  applyUserName|申请人姓名|string||
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  decisionFilesList|决策文件列表|array|文件表返回VO|
|    dataId|数据id|string||
|    delFlag||string||
|    fileName|文件名称|string||
|    fileOriginName|文件原名称|string||
|    fileSource|文件来源|string||
|    fileUrl|文件地址|string||
|    id|文件ID|string||
|  decisionInfo|决策结果|string||
|  email|联系人邮箱|string||
|  id|主键|string||
|  noticeName|公告名称|string||
|  serviceProviderId|服务商外键|string||
|  serviceProviderTagList|服务商标签列表|array|能力标签|
|    createBy|创建者|integer||
|    createTime|创建时间|string||
|    deleteStatus|逻辑删除0正常1删除|string||
|    id|主键|string||
|    parentId|上级id|string||
|    remark|标签备注|string||
|    tagName|标签名称|string||
|    updateBy|更新者|integer||
|    updateTime|更新时间|string||
|  serviceProviderTypeList|服务商类型列表|array|服务商类型标签|
|    dictCode|类型code|integer||
|    dictLabel|类型名称|string||
|    dictType|固定值 service_provider_type|string||
|    remark|备注|string||
|    status|状态|string||
|  userId|联系人id|string||
|  userName|联系人姓名|string||
|  userPhone|联系人手机号|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"applyFileList": [
{
"dataId": "",
"delFlag": "",
"fileName": "",
"fileOriginName": "",
"fileSource": "",
"fileUrl": "",
"id": ""
}
],
"applyName": "",
"applyNum": "",
"applyStatus": "",
"applyTime": "",
"applyUserName": "",
"approvalId": "",
"approvalStatus": "",
"decisionFilesList": [
{
"dataId": "",
"delFlag": "",
"fileName": "",
"fileOriginName": "",
"fileSource": "",
"fileUrl": "",
"id": ""
}
],
"decisionInfo": "",
"email": "",
"id": "",
"noticeName": "",
"serviceProviderId": "",
"serviceProviderTagList": [
{
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"id": "",
"parentId": "",
"remark": "",
"tagName": "",
"updateBy": 0,
"updateTime": ""
}
],
"serviceProviderTypeList": [
{
"dictCode": 0,
"dictLabel": "",
"dictType": "",
"remark": "",
"status": ""
}
],
"userId": "",
"userName": "",
"userPhone": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 跳转到服务商新增页面
**接口地址**:`/business/pre/applyInfo/toAdd/{noticeId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|noticeId|noticeId|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 营销门户线索
## 新增线索
**接口地址**:`/business/pre/clue`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"createBy": 0,
"deleteStatus": "",
"desc": "",
"facilitatorId": "",
"origin": "",
"originUser": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|销售线索新增Dto|销售线索新增Dto|
|  createBy|||false|integer(int64)||
|  deleteStatus|逻辑删除0未删除1已删除||false|string||
|  desc|线索描述||false|string||
|  facilitatorId|服务商id||false|string||
|  origin|线索来源0咪咕商机线索1服务商商机线索||false|string||
|  originUser|线索提供人||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取列表
**接口地址**:`/business/pre/clue/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|beginTime|创建开始时间|query|false|string(date-time)||
|createBy||query|false|integer(int64)||
|endTime|创建开始时间|query|false|string(date-time)||
|origin|线索来源0咪咕商机线索1服务商商机线索|query|false|string||
|originUser|线索提供人|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«销售线索表»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|销售线索表|
|  clueCode|线索ID生成规则xs + 年-月-日-时-分-秒 + 创建人ID|string||
|  createBy||integer(int64)||
|  createTime||string(date-time)||
|  deleteStatus|逻辑删除0未删除1已删除|string||
|  desc|线索描述|string||
|  facilitatorId|服务商id|string||
|  id||string||
|  origin|线索来源0咪咕商机线索1服务商商机线索|string||
|  originUser|线索提供人|string||
|  updateBy||integer(int64)||
|  updateTime||string(date-time)||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"clueCode": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"desc": "",
"facilitatorId": "",
"id": "",
"origin": "",
"originUser": "",
"updateBy": 0,
"updateTime": ""
}
],
"msg": "",
"total": 0
}
```
## selectOne
**接口地址**:`/business/pre/clue/selectOne`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|销售线索表|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|clueCode|线索ID生成规则xs + 年-月-日-时-分-秒 + 创建人ID|string||
|createBy||integer(int64)|integer(int64)|
|createTime||string(date-time)|string(date-time)|
|deleteStatus|逻辑删除0未删除1已删除|string||
|desc|线索描述|string||
|facilitatorId|服务商id|string||
|id||string||
|origin|线索来源0咪咕商机线索1服务商商机线索|string||
|originUser|线索提供人|string||
|updateBy||integer(int64)|integer(int64)|
|updateTime||string(date-time)|string(date-time)|
**响应示例**:
```javascript
{
"clueCode": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"desc": "",
"facilitatorId": "",
"id": "",
"origin": "",
"originUser": "",
"updateBy": 0,
"updateTime": ""
}
```
## 修改线索
**接口地址**:`/business/pre/clue/update/{id}`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"desc": "",
"facilitatorId": "",
"origin": "",
"originUser": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|销售线索修改Dto|销售线索修改Dto|
|  desc|线索描述||false|string||
|  facilitatorId|服务商id||false|string||
|  origin|线索来源0咪咕商机线索1服务商商机线索||false|string||
|  originUser|线索提供人||false|string||
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 删除线索
**接口地址**:`/business/pre/clue/{id}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 营销门户解决方案相关接口
## 产品查询详情
**接口地址**:`/business/pre/solution/detail`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|query|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|SolutionVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|approvalId|审批id|string||
|approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|belongId|方案归属 合作伙伴id|string||
|belongName|方案归属 合作伙伴名称|string||
|configId|营销配置id|string||
|configVo|营销配置|ConfigVo|ConfigVo|
|  bannerBackImgLink|背景链接|string||
|  bannerButtonArray|按钮jsonarray|string||
|  bannerVedioLink|视频链接|string||
|  configDesc|营销产品介绍|string||
|  configName|营销产品名称|string||
|  configType|营销配置类型0产品1解决方案|string||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  id|主键|string||
|  navigationConfigs|组件list|array|产品营销导航配置新增、修改请求体|
|    configId|配置id|string||
|    elementImg|组件图 200|string||
|    elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}|string||
|    elementVos|导航组件list|array|营销配置导航组件表|
|      childElementType|子组件类型0二维码1按钮|string||
|      createBy|创建者|integer||
|      createTime|创建时间|string||
|      delStatus|是否删除0-正常1-已删除)|string||
|      elementButtonLink|子组件按钮链接 200|string||
|      elementButtonName|子组件组件按钮名称 64|string||
|      elementDesc|组件描述 500|string||
|      elementImg|组件图片 200|string||
|      elementName|组件名称 32|string||
|      id|id|string||
|      navigationId|导航id|string||
|      qrCode|子组件二维码字符串 250|string||
|      updateBy|更新者|integer||
|      updateTime|更新时间|string||
|    id|主键|string||
|    navigationName|导航名称 30|string||
|    navigationSort|次序|string||
|    navigationType|导航类型0链接跳转1组件|string||
|    navigationdDesc|导航描述 1000|string||
|    navigationlink|导航链接|string||
|  updateBy|更新者|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|createBy|创建者|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|id|主键|string||
|solutionBelong|方案归属0咪咕1合作伙伴|string||
|solutionCatalogId|解决方案目录id|string||
|solutionCatalogName|解决方案目录名称|string||
|solutionDesc|解决方案介绍|string||
|solutionEnglishName|解决方案英文名|string||
|solutionName|解决方案名称|string||
|solutionStatus|解决方案状态0未提交、1审核中2审核不通过3已创建4已上架5已下架6已失效|string||
|updateBy|更新者|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
|userName|更新者|string||
**响应示例**:
```javascript
{
"approvalId": "",
"approvalStatus": "",
"belongId": "",
"belongName": "",
"configId": "",
"configVo": {
"bannerBackImgLink": "",
"bannerButtonArray": "",
"bannerVedioLink": "",
"configDesc": "",
"configName": "",
"configType": "",
"createBy": 0,
"createTime": "",
"id": "",
"navigationConfigs": [
{
"configId": "",
"elementImg": "",
"elementType": "",
"elementVos": [
{
"childElementType": "",
"createBy": 0,
"createTime": "",
"delStatus": "",
"elementButtonLink": "",
"elementButtonName": "",
"elementDesc": "",
"elementImg": "",
"elementName": "",
"id": "",
"navigationId": "",
"qrCode": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"navigationName": "",
"navigationSort": "",
"navigationType": "",
"navigationdDesc": "",
"navigationlink": ""
}
],
"updateBy": 0,
"updateTime": ""
},
"createBy": 0,
"createTime": "",
"id": "",
"solutionBelong": "",
"solutionCatalogId": "",
"solutionCatalogName": "",
"solutionDesc": "",
"solutionEnglishName": "",
"solutionName": "",
"solutionStatus": "",
"updateBy": 0,
"updateTime": "",
"userName": ""
}
```
## 产品列表
**接口地址**:`/business/pre/solution/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|solutionName|solutionName|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|CatalogMarketVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|catalogMarketVo|该目录下的子集目录|array|CatalogMarketVo|
|  catalogMarketVo|该目录下的子集目录|array|CatalogMarketVo|
|  catalogName|目录名称|string||
|  id|导航id|string||
|  nodeVos|该目录下的产品或解决方案|array|NodeVo|
|    id||string||
|    name||string||
|  parentId|父级目录id(1级为0)|string||
|catalogName|目录名称|string||
|id|导航id|string||
|nodeVos|该目录下的产品或解决方案|array|NodeVo|
|  id||string||
|  name||string||
|parentId|父级目录id(1级为0)|string||
**响应示例**:
```javascript
[
{
"catalogMarketVo": [
{
"catalogMarketVo": [],
"catalogName": "",
"id": "",
"nodeVos": [],
"parentId": ""
}
],
"catalogName": "",
"id": "",
"nodeVos": [
{
"id": "",
"name": ""
}
],
"parentId": ""
}
]
```
# 营销门户订单
## 创建订单
**接口地址**:`/business/pre/Order/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"callIds": [],
"contractId": "",
"customerManager": "",
"customerManagerId": 0,
"demandIds": [],
"demandSideId": "",
"demandSideName": "",
"discountRate": 0,
"orderAmount": 0,
"productDesc": "",
"relatedId": "",
"relatedName": "",
"relatedType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|orderAddDto|orderAddDto|body|true|OrderAddDto|OrderAddDto|
|  callIds|申请单ids||false|array|string|
|  contractId|关联的合同id||false|string||
|  customerManager|客户经理名称||false|string||
|  customerManagerId|客户经理id||false|integer(int64)||
|  demandIds|需求单ids||false|array|string|
|  demandSideId|订单需求方id||false|string||
|  demandSideName|订单需求方name(冗余字段)||false|string||
|  discountRate|折扣率||false|number||
|  orderAmount|订单金额(单位为元,保留两位小数点)||false|number||
|  productDesc|其他订单-交付内容||false|string||
|  relatedId|产品id或者解决方案id,选其他产品无关联id||false|string||
|  relatedName|产品名称或者解决方案名称或者其他类的产品名称||false|string||
|  relatedType|订单类型(0表示产品订单,1表示解决方案订单,2表示其他订单)||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 修改订单
**接口地址**:`/business/pre/Order/edit`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"callIds": [],
"contractId": "",
"customerManager": "",
"customerManagerId": 0,
"demandIds": [],
"demandSideId": "",
"demandSideName": "",
"discountRate": 0,
"id": "",
"orderAmount": 0,
"productDesc": "",
"relatedId": "",
"relatedName": "",
"relatedType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|orderEditDto|orderEditDto|body|true|OrderEditDto|OrderEditDto|
|  callIds|申请单ids||false|array|string|
|  contractId|关联的合同id||false|string||
|  customerManager|客户经理名称||false|string||
|  customerManagerId|客户经理id||false|integer(int64)||
|  demandIds|需求单ids||false|array|string|
|  demandSideId|订单需求方id||false|string||
|  demandSideName|订单需求方name(冗余字段)||false|string||
|  discountRate|折扣率||false|number||
|  id|订单id||false|string||
|  orderAmount|订单金额(单位为元,保留两位小数点)||false|number||
|  productDesc|其他订单-交付内容||false|string||
|  relatedId|产品id或者解决方案id,选其他产品无关联id||false|string||
|  relatedName|产品名称或者解决方案名称或者其他类的产品名称||false|string||
|  relatedType|订单类型(0表示产品订单,1表示解决方案订单,2表示其他订单)||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 订单信息list查询
**接口地址**:`/business/pre/Order/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|catalogueName|产品或者解决方案的目录名称-16|query|false|string||
|createBy|创建者-16|query|false|string||
|endTime|创建时间范围止|query|false|string(date-time)||
|orderCode|订单编号-25|query|false|string||
|orderState|订单状态-1(传字典值)|query|false|string||
|relatedName|产品名称-64|query|false|string||
|relatedType|订单类型-1(传字典值)|query|false|string||
|startTime|创建时间范围起|query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«订单详情vo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|订单详情vo|
|  appId|应用id|string||
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  catalogueName|产品或者解决方案的目录名称|string||
|  createBy|创建人|integer(int64)||
|  createByName|创建人名称|string||
|  createTime|创建时间|string(date-time)||
|  demandSideId|订单需求方id|string||
|  demandSideName|订单需求方name(冗余字段)|string||
|  discountRate|产品折扣率|number||
|  effectiveTime|生效时间|string(date-time)||
|  expirationTime|到期时间|string(date-time)||
|  id|id|string||
|  orderAmount|订单金额(单位为元,保留两位小数点)|number||
|  orderCode|订单编号|string||
|  orderState|订单状态(0已提交,1审核中2已确认3订单转工单4已完成)|string||
|  orderStateName|订单状态|string||
|  relatedId|关联id(订单id或者解决方案id)|string||
|  relatedName|关联名称(订单name或者解决方案name)|string||
|  relatedType|订单类型(0表示产品订单,1表示解决方案订单,2表示其他订单)|string||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"appId": "",
"approvalId": "",
"approvalStatus": "",
"catalogueName": "",
"createBy": 0,
"createByName": "",
"createTime": "",
"demandSideId": "",
"demandSideName": "",
"discountRate": 0,
"effectiveTime": "",
"expirationTime": "",
"id": "",
"orderAmount": 0,
"orderCode": "",
"orderState": "",
"orderStateName": "",
"relatedId": "",
"relatedName": "",
"relatedType": ""
}
],
"msg": "",
"total": 0
}
```
## 查询订单状态
**接口地址**:`/business/pre/Order/status`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"callIds": [],
"contractId": "",
"customerManager": "",
"customerManagerId": 0,
"demandIds": [],
"demandSideId": "",
"demandSideName": "",
"discountRate": 0,
"id": "",
"orderAmount": 0,
"productDesc": "",
"relatedId": "",
"relatedName": "",
"relatedType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|orderEditDto|orderEditDto|body|true|OrderEditDto|OrderEditDto|
|  callIds|申请单ids||false|array|string|
|  contractId|关联的合同id||false|string||
|  customerManager|客户经理名称||false|string||
|  customerManagerId|客户经理id||false|integer(int64)||
|  demandIds|需求单ids||false|array|string|
|  demandSideId|订单需求方id||false|string||
|  demandSideName|订单需求方name(冗余字段)||false|string||
|  discountRate|折扣率||false|number||
|  id|订单id||false|string||
|  orderAmount|订单金额(单位为元,保留两位小数点)||false|number||
|  productDesc|其他订单-交付内容||false|string||
|  relatedId|产品id或者解决方案id,选其他产品无关联id||false|string||
|  relatedName|产品名称或者解决方案名称或者其他类的产品名称||false|string||
|  relatedType|订单类型(0表示产品订单,1表示解决方案订单,2表示其他订单)||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 通过orderId查看订单信息详情关联对应的信息
**接口地址**:`/business/pre/Order/{orderId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|orderId|orderId|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 营销门户配置相关接口
## 后台管理获取营销首页配置
**接口地址**:`/business/homepage/get`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|HomePageDto|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|homepageProducts|产品推荐|array|HomepageProductDto|
|  cardLab|卡片标题 50|string||
|  cardVal|卡片val|integer(int32)||
|  iconUrl|图片地址 500|string||
|  productSecondDtos||array|ProductSecondDto|
|    desc|描述|string||
|    link|链接|string||
|    title|标题|string||
|  title|一级标题 100|string||
|homepageSlideImgs|轮播图|array|营销门户首页轮播图表|
|  cardLab|卡片标题|string||
|  cardVal|卡片val|integer(int32)||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  descible|二级文字|string||
|  id|id|string||
|  imgUrl|图片地址|string||
|  link|跳转链接|string||
|  title|一级标题|string||
|homepageSolutions|解决方案|array|营销门户首页解决方案表|
|  cardLab|卡片标题|string||
|  cardVal|卡片val|integer(int32)||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  describe|说明|string||
|  iconUrl|图片地址|string||
|  id|id|string||
|  imgUrl|图片|string||
|  link|跳转链接|string||
|  secondDescribe|二级文字|string||
|  title|一级标题|string||
**响应示例**:
```javascript
{
"homepageProducts": [
{
"cardLab": "",
"cardVal": 0,
"iconUrl": "",
"productSecondDtos": [
{
"desc": "",
"link": "",
"title": ""
}
],
"title": ""
}
],
"homepageSlideImgs": [
{
"cardLab": "",
"cardVal": 0,
"createBy": 0,
"createTime": "",
"descible": "",
"id": "",
"imgUrl": "",
"link": "",
"title": ""
}
],
"homepageSolutions": [
{
"cardLab": "",
"cardVal": 0,
"createBy": 0,
"createTime": "",
"describe": "",
"iconUrl": "",
"id": "",
"imgUrl": "",
"link": "",
"secondDescribe": "",
"title": ""
}
]
}
```
## 编辑营销首页配置
**接口地址**:`/business/homepage/set`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"homepageProducts": [
{
"cardLab": "",
"cardVal": 0,
"iconUrl": "",
"productSecondDtos": [
{
"desc": "",
"link": "",
"title": ""
}
],
"title": ""
}
],
"homepageSlideImgs": [
{
"cardLab": "",
"cardVal": 0,
"createBy": 0,
"createTime": "",
"descible": "",
"id": "",
"imgUrl": "",
"link": "",
"title": ""
}
],
"homepageSolutions": [
{
"cardLab": "",
"cardVal": 0,
"createBy": 0,
"createTime": "",
"describe": "",
"iconUrl": "",
"id": "",
"imgUrl": "",
"link": "",
"secondDescribe": "",
"title": ""
}
]
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|homePageDto|营销首页配置请求体|body|true|HomePageDto|HomePageDto|
|  homepageProducts|产品推荐||false|array|HomepageProductDto|
|    cardLab|卡片标题 50||false|string||
|    cardVal|卡片val||false|integer||
|    iconUrl|图片地址 500||false|string||
|    productSecondDtos|||false|array|ProductSecondDto|
|      desc|描述||false|string||
|      link|链接||false|string||
|      title|标题||false|string||
|    title|一级标题 100||false|string||
|  homepageSlideImgs|轮播图||false|array|营销门户首页轮播图表|
|    cardLab|卡片标题||false|string||
|    cardVal|卡片val||false|integer||
|    createBy|创建者||false|integer||
|    createTime|创建时间||false|string||
|    descible|二级文字||false|string||
|    id|id||false|string||
|    imgUrl|图片地址||false|string||
|    link|跳转链接||false|string||
|    title|一级标题||false|string||
|  homepageSolutions|解决方案||false|array|营销门户首页解决方案表|
|    cardLab|卡片标题||false|string||
|    cardVal|卡片val||false|integer||
|    createBy|创建者||false|integer||
|    createTime|创建时间||false|string||
|    describe|说明||false|string||
|    iconUrl|图片地址||false|string||
|    id|id||false|string||
|    imgUrl|图片||false|string||
|    link|跳转链接||false|string||
|    secondDescribe|二级文字||false|string||
|    title|一级标题||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取营销首页配置
**接口地址**:`/business/pre/homepage/get`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|HomePageDto|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|homepageProducts|产品推荐|array|HomepageProductDto|
|  cardLab|卡片标题 50|string||
|  cardVal|卡片val|integer(int32)||
|  iconUrl|图片地址 500|string||
|  productSecondDtos||array|ProductSecondDto|
|    desc|描述|string||
|    link|链接|string||
|    title|标题|string||
|  title|一级标题 100|string||
|homepageSlideImgs|轮播图|array|营销门户首页轮播图表|
|  cardLab|卡片标题|string||
|  cardVal|卡片val|integer(int32)||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  descible|二级文字|string||
|  id|id|string||
|  imgUrl|图片地址|string||
|  link|跳转链接|string||
|  title|一级标题|string||
|homepageSolutions|解决方案|array|营销门户首页解决方案表|
|  cardLab|卡片标题|string||
|  cardVal|卡片val|integer(int32)||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  describe|说明|string||
|  iconUrl|图片地址|string||
|  id|id|string||
|  imgUrl|图片|string||
|  link|跳转链接|string||
|  secondDescribe|二级文字|string||
|  title|一级标题|string||
**响应示例**:
```javascript
{
"homepageProducts": [
{
"cardLab": "",
"cardVal": 0,
"iconUrl": "",
"productSecondDtos": [
{
"desc": "",
"link": "",
"title": ""
}
],
"title": ""
}
],
"homepageSlideImgs": [
{
"cardLab": "",
"cardVal": 0,
"createBy": 0,
"createTime": "",
"descible": "",
"id": "",
"imgUrl": "",
"link": "",
"title": ""
}
],
"homepageSolutions": [
{
"cardLab": "",
"cardVal": 0,
"createBy": 0,
"createTime": "",
"describe": "",
"iconUrl": "",
"id": "",
"imgUrl": "",
"link": "",
"secondDescribe": "",
"title": ""
}
]
}
```
# 营销门户需求单controller
## 新增需求单
**接口地址**:`/business/pre/demandOrder/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"company": "",
"demandDesc": "",
"demandName": "",
"facilitatorId": "",
"origin": "",
"phoneNum": "",
"relatedId": "",
"relatedName": "",
"relatedType": "",
"sellPredict": 0
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|门户端需求新增对象dto|门户端需求新增对象dto|
|  company|公司名称||false|string||
|  demandDesc|需求描述||false|string||
|  demandName|姓名||false|string||
|  facilitatorId|服务商id||false|string||
|  origin|0咪咕商机线索1服务商商机线索||false|string||
|  phoneNum|手机号码||false|string||
|  relatedId|关联id||false|string||
|  relatedName|关联名称||false|string||
|  relatedType|0产品1解决方案||false|string||
|  sellPredict|销售金额预测||false|number||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取数据统计列表(0线上 1线下)
**接口地址**:`/business/pre/demandOrder/count/{source}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|source|source|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|需求单数据统计Vo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|count|数据|string||
|status|0已提交1跟进中2已完成|string||
**响应示例**:
```javascript
[
{
"count": "",
"status": ""
}
]
```
## 客户经理反馈需求单
**接口地址**:`/business/pre/demandOrder/feedback`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"clueId": "",
"company": "",
"createBy": 0,
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"demandDesc": "",
"demandName": "",
"feedback": "",
"id": "",
"phoneNum": "",
"relatedId": "",
"relatedName": "",
"relatedType": "",
"remark": "",
"source": "",
"status": "",
"transactionStatus": "",
"updateBy": 0,
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|客户经理反馈需求单dto|客户经理反馈需求单dto|
|  clueId|关联线索id||false|string||
|  company|公司名称||false|string||
|  createBy|创建人||false|integer(int64)||
|  createTime|创建时间||false|string(date-time)||
|  customerManager|客户经理||false|string||
|  customerManagerId|客户经理id||false|integer(int64)||
|  deleteStatus|逻辑删除:{0不删除1删除}||false|string||
|  demandDesc|需求描述||false|string||
|  demandName|姓名||false|string||
|  feedback|反馈结果||false|string||
|  id|id||false|string||
|  phoneNum|手机号码||false|string||
|  relatedId|关联id||false|string||
|  relatedName|关联名称||false|string||
|  relatedType|0产品1解决方案||false|string||
|  remark|备注||false|string||
|  source|0营销门户创建1系统用户创建||false|string||
|  status|0已提交1跟进中2已完成||false|string||
|  transactionStatus|成交状态 0未完成1已完成||false|string||
|  updateBy|修改人||false|integer(int64)||
|  updateTime|修改时间||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取需求单列表
**接口地址**:`/business/pre/demandOrder/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|company|公司名称|query|false|string||
|createBy|创建人|query|false|string||
|customerManager|客户经理|query|false|string||
|customerManagerId|客户经理id|query|false|integer(int64)||
|demandName|姓名|query|false|string||
|endTime|创建时间范围止|query|false|string(date-time)||
|origin|0咪咕商机线索1服务商商机线索|query|false|string||
|relatedName|关联名称|query|false|string||
|relatedType|0产品1解决方案|query|false|string||
|source|0营销门户创建1系统用户创建|query|false|string||
|startTime|创建时间范围起|query|false|string(date-time)||
|status|0已提交1跟进中2已完成|query|false|string||
|transactionStatus|成交状态 0未完成1已完成|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«需求单表»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|需求单表|
|  clueId|关联线索id|string||
|  company|公司名称|string||
|  createBy|创建人|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  customerManager|客户经理|string||
|  customerManagerId|客户经理id|integer(int64)||
|  deleteStatus|逻辑删除:{0不删除1删除}|string||
|  demandCode|需求单号 用户ID + 年-月-日+三位序列号|string||
|  demandDesc|需求描述|string||
|  demandName|姓名|string||
|  facilitatorId|服务商id|string||
|  feedback|反馈结果|string||
|  id|id|string||
|  origin|0咪咕商机线索1服务商商机线索|string||
|  phoneNum|手机号码|string||
|  relatedId|关联id|string||
|  relatedName|关联名称|string||
|  relatedType|0产品1解决方案|string||
|  remark|备注|string||
|  sellPredict|销售金额预测|number||
|  source|0营销门户创建1系统用户创建|string||
|  status|0已提交1跟进中2已完成|string||
|  transactionStatus|成交状态 0未完成1已完成|string||
|  updateBy|修改人|integer(int64)||
|  updateTime|修改时间|string(date-time)||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"clueId": "",
"company": "",
"createBy": 0,
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"demandCode": "",
"demandDesc": "",
"demandName": "",
"facilitatorId": "",
"feedback": "",
"id": "",
"origin": "",
"phoneNum": "",
"relatedId": "",
"relatedName": "",
"relatedType": "",
"remark": "",
"sellPredict": 0,
"source": "",
"status": "",
"transactionStatus": "",
"updateBy": 0,
"updateTime": ""
}
],
"msg": "",
"total": 0
}
```
## 获取需求单详情
**接口地址**:`/business/pre/demandOrder/selectOne`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|需求单详情Vo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|clue|关联线索|销售线索表|销售线索表|
|  clueCode|线索ID生成规则xs + 年-月-日-时-分-秒 + 创建人ID|string||
|  createBy||integer(int64)||
|  createTime||string(date-time)||
|  deleteStatus|逻辑删除0未删除1已删除|string||
|  desc|线索描述|string||
|  facilitatorId|服务商id|string||
|  id||string||
|  origin|线索来源0咪咕商机线索1服务商商机线索|string||
|  originUser|线索提供人|string||
|  updateBy||integer(int64)||
|  updateTime||string(date-time)||
|clueId|关联线索id|string||
|cmphoneNumber||string||
|code|需求单号 用户ID + 年-月-日+三位序列号|string||
|company|公司名称|string||
|createBy|创建人|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|customerManager|客户经理|string||
|customerManagerId|客户经理id|integer(int64)|integer(int64)|
|deleteStatus|逻辑删除:{0不删除1删除}|string||
|demandDesc|需求描述|string||
|demandName|姓名|string||
|facilitatorId|服务商id|string||
|feedback|反馈结果|string||
|fileDtos|附件|array|文件表返回VO|
|  dataId|数据id|string||
|  delFlag||string||
|  fileName|文件名称|string||
|  fileOriginName|文件原名称|string||
|  fileSource|文件来源|string||
|  fileUrl|文件地址|string||
|  id|文件ID|string||
|id|id|string||
|origin|0咪咕商机线索1服务商商机线索|string||
|phoneNum|手机号码|string||
|relatedId|关联id|string||
|relatedName|关联名称|string||
|relatedType|0产品1解决方案|string||
|remark|备注|string||
|sellPredict|销售金额预测|number||
|source|0营销门户创建1系统用户创建|string||
|status|0已提交1跟进中2已完成|string||
|transactionStatus|成交状态 0未完成1已完成|string||
|updateBy|修改人|integer(int64)|integer(int64)|
|updateTime|修改时间|string(date-time)|string(date-time)|
**响应示例**:
```javascript
{
"clue": {
"clueCode": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"desc": "",
"facilitatorId": "",
"id": "",
"origin": "",
"originUser": "",
"updateBy": 0,
"updateTime": ""
},
"clueId": "",
"cmphoneNumber": "",
"code": "",
"company": "",
"createBy": 0,
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"demandDesc": "",
"demandName": "",
"facilitatorId": "",
"feedback": "",
"fileDtos": [
{
"dataId": "",
"delFlag": "",
"fileName": "",
"fileOriginName": "",
"fileSource": "",
"fileUrl": "",
"id": ""
}
],
"id": "",
"origin": "",
"phoneNum": "",
"relatedId": "",
"relatedName": "",
"relatedType": "",
"remark": "",
"sellPredict": 0,
"source": "",
"status": "",
"transactionStatus": "",
"updateBy": 0,
"updateTime": ""
}
```
## 创建人修改需求单
**接口地址**:`/business/pre/demandOrder/update`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"clueId": "",
"company": "",
"createBy": 0,
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"demandDesc": "",
"demandName": "",
"facilitatorId": "",
"feedback": "",
"fileDtos": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"id": "",
"origin": "",
"phoneNum": "",
"relatedId": "",
"relatedName": "",
"relatedType": "",
"remark": "",
"sellPredict": 0,
"source": "",
"status": "",
"transactionStatus": "",
"updateBy": 0,
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|需求单修改对象dto|需求单修改对象dto|
|  clueId|关联线索id||false|string||
|  company|公司名称||false|string||
|  createBy|创建人||false|integer(int64)||
|  createTime|创建时间||false|string(date-time)||
|  customerManager|客户经理||false|string||
|  customerManagerId|客户经理id||false|integer(int64)||
|  deleteStatus|逻辑删除:{0不删除1删除}||false|string||
|  demandDesc|需求描述||false|string||
|  demandName|姓名||false|string||
|  facilitatorId|服务商id||false|string||
|  feedback|反馈结果||false|string||
|  fileDtos|附件||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  id|id||false|string||
|  origin|0咪咕商机线索1服务商商机线索||false|string||
|  phoneNum|手机号码||false|string||
|  relatedId|关联id||false|string||
|  relatedName|关联名称||false|string||
|  relatedType|0产品1解决方案||false|string||
|  remark|备注||false|string||
|  sellPredict|销售金额预测||false|number||
|  source|0营销门户创建1系统用户创建||false|string||
|  status|0已提交1跟进中2已完成||false|string||
|  transactionStatus|成交状态 0未完成1已完成||false|string||
|  updateBy|修改人||false|integer(int64)||
|  updateTime|修改时间||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 线下需求单-客户经理编辑需求单
**接口地址**:`/business/pre/demandOrder/updateByCM`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"demandDesc": "",
"feedback": "",
"fileDtos": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"id": "",
"origin": "",
"remark": "",
"sellPredict": 0,
"status": "",
"transactionStatus": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|客户经理编辑需求单对象dto|客户经理编辑需求单对象dto|
|  demandDesc|需求描述||false|string||
|  feedback|反馈结果||false|string||
|  fileDtos|附件||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  id|id||false|string||
|  origin|0咪咕商机线索1服务商商机线索||false|string||
|  remark|备注||false|string||
|  sellPredict|销售金额预测||false|number||
|  status|0已提交1跟进中2已完成||false|string||
|  transactionStatus|成交状态 0未完成1已完成||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 分配客户经理
**接口地址**:`/business/pre/demandOrder/updateCM`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"customerManagerId": 0,
"id": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|分配客户经理dto|分配客户经理dto|
|  customerManagerId|客户经理id||false|integer(int64)||
|  id|id||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 删除需求单
**接口地址**:`/business/pre/demandOrder/{ids}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 解决方案相关接口
## 新增
**接口地址**:`/business/solution/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"belongId": "",
"changeConfig": true,
"configId": "",
"id": "",
"productConfigDto": {
"bannerBackImgLink": "",
"bannerButtonArray": "",
"bannerVedioLink": "",
"configDesc": "",
"configName": "",
"configType": "",
"id": "",
"isMould": "",
"navigationConfigs": [
{
"configId": "",
"elementImg": "",
"elementType": "",
"elementVos": [
{
"childElementType": "",
"createBy": 0,
"createTime": "",
"delStatus": "",
"elementButtonLink": "",
"elementButtonName": "",
"elementDesc": "",
"elementImg": "",
"elementName": "",
"id": "",
"navigationId": "",
"qrCode": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"navigationName": "",
"navigationSort": "",
"navigationType": "",
"navigationdDesc": "",
"navigationlink": ""
}
]
},
"solutionBelong": "",
"solutionCatalogId": "",
"solutionCatalogName": "",
"solutionDesc": "",
"solutionEnglishName": "",
"solutionName": "",
"solutionStatus": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|solutionAddDto|solutionAddDto|body|true|解决方案新增、修改请求体|解决方案新增、修改请求体|
|  belongId|方案归属 合作伙伴id||false|string||
|  changeConfig|营销配置是否修改||false|boolean||
|  configId|营销配置id||false|string||
|  id|主键||false|string||
|  productConfigDto|营销配置信息||false|产品配置营销新增、修改请求体|产品配置营销新增、修改请求体|
|    bannerBackImgLink|背景链接 500||false|string||
|    bannerButtonArray|按钮jsonarray 1000||false|string||
|    bannerVedioLink|视频链接 500||false|string||
|    configDesc|营销产品介绍 500||false|string||
|    configName|营销产品名称 32||false|string||
|    configType|营销配置类型0产品1解决方案||false|string||
|    id|主键||false|string||
|    isMould|是否模板||false|string||
|    navigationConfigs|组件list||false|array|产品营销导航配置新增、修改请求体|
|      configId|配置id||false|string||
|      elementImg|组件图 200||false|string||
|      elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}||false|string||
|      elementVos|导航组件list||false|array|营销配置导航组件表|
|        childElementType|子组件类型0二维码1按钮||false|string||
|        createBy|创建者||false|integer||
|        createTime|创建时间||false|string||
|        delStatus|是否删除0-正常1-已删除)||false|string||
|        elementButtonLink|子组件按钮链接 200||false|string||
|        elementButtonName|子组件组件按钮名称 64||false|string||
|        elementDesc|组件描述 500||false|string||
|        elementImg|组件图片 200||false|string||
|        elementName|组件名称 32||false|string||
|        id|id||false|string||
|        navigationId|导航id||false|string||
|        qrCode|子组件二维码字符串 250||false|string||
|        updateBy|更新者||false|integer||
|        updateTime|更新时间||false|string||
|      id|主键||false|string||
|      navigationName|导航名称 30||false|string||
|      navigationSort|次序||false|string||
|      navigationType|导航类型0链接跳转1组件||false|string||
|      navigationdDesc|导航描述 1000||false|string||
|      navigationlink|导航链接||false|string||
|  solutionBelong|方案归属0咪咕1合作伙伴||false|string||
|  solutionCatalogId|解决方案目录id||false|string||
|  solutionCatalogName|解决方案目录名称||false|string||
|  solutionDesc|解决方案介绍||false|string||
|  solutionEnglishName|解决方案英文名||false|string||
|  solutionName|解决方案名称||false|string||
|  solutionStatus|解决方案状态0未提交、3已创建6已上架9已下架10已失效||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查看详情
**接口地址**:`/business/solution/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|SolutionVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|approvalId|审批id|string||
|approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|belongId|方案归属 合作伙伴id|string||
|belongName|方案归属 合作伙伴名称|string||
|configId|营销配置id|string||
|configVo|营销配置|ConfigVo|ConfigVo|
|  bannerBackImgLink|背景链接|string||
|  bannerButtonArray|按钮jsonarray|string||
|  bannerVedioLink|视频链接|string||
|  configDesc|营销产品介绍|string||
|  configName|营销产品名称|string||
|  configType|营销配置类型0产品1解决方案|string||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  id|主键|string||
|  navigationConfigs|组件list|array|产品营销导航配置新增、修改请求体|
|    configId|配置id|string||
|    elementImg|组件图 200|string||
|    elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}|string||
|    elementVos|导航组件list|array|营销配置导航组件表|
|      childElementType|子组件类型0二维码1按钮|string||
|      createBy|创建者|integer||
|      createTime|创建时间|string||
|      delStatus|是否删除0-正常1-已删除)|string||
|      elementButtonLink|子组件按钮链接 200|string||
|      elementButtonName|子组件组件按钮名称 64|string||
|      elementDesc|组件描述 500|string||
|      elementImg|组件图片 200|string||
|      elementName|组件名称 32|string||
|      id|id|string||
|      navigationId|导航id|string||
|      qrCode|子组件二维码字符串 250|string||
|      updateBy|更新者|integer||
|      updateTime|更新时间|string||
|    id|主键|string||
|    navigationName|导航名称 30|string||
|    navigationSort|次序|string||
|    navigationType|导航类型0链接跳转1组件|string||
|    navigationdDesc|导航描述 1000|string||
|    navigationlink|导航链接|string||
|  updateBy|更新者|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|createBy|创建者|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|id|主键|string||
|solutionBelong|方案归属0咪咕1合作伙伴|string||
|solutionCatalogId|解决方案目录id|string||
|solutionCatalogName|解决方案目录名称|string||
|solutionDesc|解决方案介绍|string||
|solutionEnglishName|解决方案英文名|string||
|solutionName|解决方案名称|string||
|solutionStatus|解决方案状态0未提交、1审核中2审核不通过3已创建4已上架5已下架6已失效|string||
|updateBy|更新者|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
|userName|更新者|string||
**响应示例**:
```javascript
{
"approvalId": "",
"approvalStatus": "",
"belongId": "",
"belongName": "",
"configId": "",
"configVo": {
"bannerBackImgLink": "",
"bannerButtonArray": "",
"bannerVedioLink": "",
"configDesc": "",
"configName": "",
"configType": "",
"createBy": 0,
"createTime": "",
"id": "",
"navigationConfigs": [
{
"configId": "",
"elementImg": "",
"elementType": "",
"elementVos": [
{
"childElementType": "",
"createBy": 0,
"createTime": "",
"delStatus": "",
"elementButtonLink": "",
"elementButtonName": "",
"elementDesc": "",
"elementImg": "",
"elementName": "",
"id": "",
"navigationId": "",
"qrCode": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"navigationName": "",
"navigationSort": "",
"navigationType": "",
"navigationdDesc": "",
"navigationlink": ""
}
],
"updateBy": 0,
"updateTime": ""
},
"createBy": 0,
"createTime": "",
"id": "",
"solutionBelong": "",
"solutionCatalogId": "",
"solutionCatalogName": "",
"solutionDesc": "",
"solutionEnglishName": "",
"solutionName": "",
"solutionStatus": "",
"updateBy": 0,
"updateTime": "",
"userName": ""
}
```
## 上架
**接口地址**:`/business/solution/onShelve/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 解决方案查询
**接口地址**:`/business/solution/pagelist`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|approvalCode|审批产品列表查询 1 - 创建审批 2 - 上架审批 3 - 下架审批|query|false|string||
|approvalStatus|审核状态0审核中、1审核通过2审核不通过|query|false|string||
|forShelve|是否上下架操作0是1否|query|false|string||
|solutionBelong|方案归属0咪咕1合作伙伴|query|false|string||
|solutionCatalogId|解决方案目录id|query|false|string||
|solutionName|解决方案名称|query|false|string||
|solutionStatus|解决方案状态0未提交1上架审核中3已创建4上架审核中6已上架7下架审核中9已下架10已失效|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«SolutionVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|SolutionVo|
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  belongId|方案归属 合作伙伴id|string||
|  belongName|方案归属 合作伙伴名称|string||
|  configId|营销配置id|string||
|  configVo|营销配置|ConfigVo|ConfigVo|
|    bannerBackImgLink|背景链接|string||
|    bannerButtonArray|按钮jsonarray|string||
|    bannerVedioLink|视频链接|string||
|    configDesc|营销产品介绍|string||
|    configName|营销产品名称|string||
|    configType|营销配置类型0产品1解决方案|string||
|    createBy|创建者|integer||
|    createTime|创建时间|string||
|    id|主键|string||
|    navigationConfigs|组件list|array|产品营销导航配置新增、修改请求体|
|      configId|配置id|string||
|      elementImg|组件图 200|string||
|      elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}|string||
|      elementVos|导航组件list|array|营销配置导航组件表|
|        childElementType|子组件类型0二维码1按钮|string||
|        createBy|创建者|integer||
|        createTime|创建时间|string||
|        delStatus|是否删除0-正常1-已删除)|string||
|        elementButtonLink|子组件按钮链接 200|string||
|        elementButtonName|子组件组件按钮名称 64|string||
|        elementDesc|组件描述 500|string||
|        elementImg|组件图片 200|string||
|        elementName|组件名称 32|string||
|        id|id|string||
|        navigationId|导航id|string||
|        qrCode|子组件二维码字符串 250|string||
|        updateBy|更新者|integer||
|        updateTime|更新时间|string||
|      id|主键|string||
|      navigationName|导航名称 30|string||
|      navigationSort|次序|string||
|      navigationType|导航类型0链接跳转1组件|string||
|      navigationdDesc|导航描述 1000|string||
|      navigationlink|导航链接|string||
|    updateBy|更新者|integer||
|    updateTime|更新时间|string||
|  createBy|创建者|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  id|主键|string||
|  solutionBelong|方案归属0咪咕1合作伙伴|string||
|  solutionCatalogId|解决方案目录id|string||
|  solutionCatalogName|解决方案目录名称|string||
|  solutionDesc|解决方案介绍|string||
|  solutionEnglishName|解决方案英文名|string||
|  solutionName|解决方案名称|string||
|  solutionStatus|解决方案状态0未提交、1审核中2审核不通过3已创建4已上架5已下架6已失效|string||
|  updateBy|更新者|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|  userName|更新者|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"approvalId": "",
"approvalStatus": "",
"belongId": "",
"belongName": "",
"configId": "",
"configVo": {
"bannerBackImgLink": "",
"bannerButtonArray": "",
"bannerVedioLink": "",
"configDesc": "",
"configName": "",
"configType": "",
"createBy": 0,
"createTime": "",
"id": "",
"navigationConfigs": [
{
"configId": "",
"elementImg": "",
"elementType": "",
"elementVos": [
{
"childElementType": "",
"createBy": 0,
"createTime": "",
"delStatus": "",
"elementButtonLink": "",
"elementButtonName": "",
"elementDesc": "",
"elementImg": "",
"elementName": "",
"id": "",
"navigationId": "",
"qrCode": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"navigationName": "",
"navigationSort": "",
"navigationType": "",
"navigationdDesc": "",
"navigationlink": ""
}
],
"updateBy": 0,
"updateTime": ""
},
"createBy": 0,
"createTime": "",
"id": "",
"solutionBelong": "",
"solutionCatalogId": "",
"solutionCatalogName": "",
"solutionDesc": "",
"solutionEnglishName": "",
"solutionName": "",
"solutionStatus": "",
"updateBy": 0,
"updateTime": "",
"userName": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 撤回
**接口地址**:`/business/solution/recall/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 下架
**接口地址**:`/business/solution/unShelve/{id}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 修改
**接口地址**:`/business/solution/update`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"belongId": "",
"changeConfig": true,
"configId": "",
"id": "",
"productConfigDto": {
"bannerBackImgLink": "",
"bannerButtonArray": "",
"bannerVedioLink": "",
"configDesc": "",
"configName": "",
"configType": "",
"id": "",
"isMould": "",
"navigationConfigs": [
{
"configId": "",
"elementImg": "",
"elementType": "",
"elementVos": [
{
"childElementType": "",
"createBy": 0,
"createTime": "",
"delStatus": "",
"elementButtonLink": "",
"elementButtonName": "",
"elementDesc": "",
"elementImg": "",
"elementName": "",
"id": "",
"navigationId": "",
"qrCode": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"navigationName": "",
"navigationSort": "",
"navigationType": "",
"navigationdDesc": "",
"navigationlink": ""
}
]
},
"solutionBelong": "",
"solutionCatalogId": "",
"solutionCatalogName": "",
"solutionDesc": "",
"solutionEnglishName": "",
"solutionName": "",
"solutionStatus": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|solutionAddDto|solutionAddDto|body|true|解决方案新增、修改请求体|解决方案新增、修改请求体|
|  belongId|方案归属 合作伙伴id||false|string||
|  changeConfig|营销配置是否修改||false|boolean||
|  configId|营销配置id||false|string||
|  id|主键||false|string||
|  productConfigDto|营销配置信息||false|产品配置营销新增、修改请求体|产品配置营销新增、修改请求体|
|    bannerBackImgLink|背景链接 500||false|string||
|    bannerButtonArray|按钮jsonarray 1000||false|string||
|    bannerVedioLink|视频链接 500||false|string||
|    configDesc|营销产品介绍 500||false|string||
|    configName|营销产品名称 32||false|string||
|    configType|营销配置类型0产品1解决方案||false|string||
|    id|主键||false|string||
|    isMould|是否模板||false|string||
|    navigationConfigs|组件list||false|array|产品营销导航配置新增、修改请求体|
|      configId|配置id||false|string||
|      elementImg|组件图 200||false|string||
|      elementType|组件类型{A1卡片样式1A2卡片样式2A3卡片样式3A4卡片样式4,,B1应用场景1,C1组织架构1}||false|string||
|      elementVos|导航组件list||false|array|营销配置导航组件表|
|        childElementType|子组件类型0二维码1按钮||false|string||
|        createBy|创建者||false|integer||
|        createTime|创建时间||false|string||
|        delStatus|是否删除0-正常1-已删除)||false|string||
|        elementButtonLink|子组件按钮链接 200||false|string||
|        elementButtonName|子组件组件按钮名称 64||false|string||
|        elementDesc|组件描述 500||false|string||
|        elementImg|组件图片 200||false|string||
|        elementName|组件名称 32||false|string||
|        id|id||false|string||
|        navigationId|导航id||false|string||
|        qrCode|子组件二维码字符串 250||false|string||
|        updateBy|更新者||false|integer||
|        updateTime|更新时间||false|string||
|      id|主键||false|string||
|      navigationName|导航名称 30||false|string||
|      navigationSort|次序||false|string||
|      navigationType|导航类型0链接跳转1组件||false|string||
|      navigationdDesc|导航描述 1000||false|string||
|      navigationlink|导航链接||false|string||
|  solutionBelong|方案归属0咪咕1合作伙伴||false|string||
|  solutionCatalogId|解决方案目录id||false|string||
|  solutionCatalogName|解决方案目录名称||false|string||
|  solutionDesc|解决方案介绍||false|string||
|  solutionEnglishName|解决方案英文名||false|string||
|  solutionName|解决方案名称||false|string||
|  solutionStatus|解决方案状态0未提交、3已创建6已上架9已下架10已失效||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 订单信息
## 创建订单
**接口地址**:`/business/Order/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"callIds": [],
"contractId": "",
"customerManager": "",
"customerManagerId": 0,
"demandIds": [],
"demandSideId": "",
"demandSideName": "",
"discountRate": 0,
"orderAmount": 0,
"productDesc": "",
"relatedId": "",
"relatedName": "",
"relatedType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|orderAddDto|orderAddDto|body|true|OrderAddDto|OrderAddDto|
|  callIds|申请单ids||false|array|string|
|  contractId|关联的合同id||false|string||
|  customerManager|客户经理名称||false|string||
|  customerManagerId|客户经理id||false|integer(int64)||
|  demandIds|需求单ids||false|array|string|
|  demandSideId|订单需求方id||false|string||
|  demandSideName|订单需求方name(冗余字段)||false|string||
|  discountRate|折扣率||false|number||
|  orderAmount|订单金额(单位为元,保留两位小数点)||false|number||
|  productDesc|其他订单-交付内容||false|string||
|  relatedId|产品id或者解决方案id,选其他产品无关联id||false|string||
|  relatedName|产品名称或者解决方案名称或者其他类的产品名称||false|string||
|  relatedType|订单类型(0表示产品订单,1表示解决方案订单,2表示其他订单)||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 审核订单信息list查询
**接口地址**:`/business/Order/approvalList`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|catalogueName|产品或者解决方案的目录名称-16|query|false|string||
|createBy|创建者-16|query|false|string||
|endTime|创建时间范围止|query|false|string(date-time)||
|orderCode|订单编号-25|query|false|string||
|orderState|订单状态-1(传字典值)|query|false|string||
|relatedName|产品名称-64|query|false|string||
|relatedType|订单类型-1(传字典值)|query|false|string||
|startTime|创建时间范围起|query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«订单详情vo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|订单详情vo|
|  appId|应用id|string||
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  catalogueName|产品或者解决方案的目录名称|string||
|  createBy|创建人|integer(int64)||
|  createByName|创建人名称|string||
|  createTime|创建时间|string(date-time)||
|  demandSideId|订单需求方id|string||
|  demandSideName|订单需求方name(冗余字段)|string||
|  discountRate|产品折扣率|number||
|  effectiveTime|生效时间|string(date-time)||
|  expirationTime|到期时间|string(date-time)||
|  id|id|string||
|  orderAmount|订单金额(单位为元,保留两位小数点)|number||
|  orderCode|订单编号|string||
|  orderState|订单状态(0已提交,1审核中2已确认3订单转工单4已完成)|string||
|  orderStateName|订单状态|string||
|  relatedId|关联id(订单id或者解决方案id)|string||
|  relatedName|关联名称(订单name或者解决方案name)|string||
|  relatedType|订单类型(0表示产品订单,1表示解决方案订单,2表示其他订单)|string||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"appId": "",
"approvalId": "",
"approvalStatus": "",
"catalogueName": "",
"createBy": 0,
"createByName": "",
"createTime": "",
"demandSideId": "",
"demandSideName": "",
"discountRate": 0,
"effectiveTime": "",
"expirationTime": "",
"id": "",
"orderAmount": 0,
"orderCode": "",
"orderState": "",
"orderStateName": "",
"relatedId": "",
"relatedName": "",
"relatedType": ""
}
],
"msg": "",
"total": 0
}
```
## 修改订单
**接口地址**:`/business/Order/edit`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"callIds": [],
"contractId": "",
"customerManager": "",
"customerManagerId": 0,
"demandIds": [],
"demandSideId": "",
"demandSideName": "",
"discountRate": 0,
"id": "",
"orderAmount": 0,
"productDesc": "",
"relatedId": "",
"relatedName": "",
"relatedType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|orderEditDto|orderEditDto|body|true|OrderEditDto|OrderEditDto|
|  callIds|申请单ids||false|array|string|
|  contractId|关联的合同id||false|string||
|  customerManager|客户经理名称||false|string||
|  customerManagerId|客户经理id||false|integer(int64)||
|  demandIds|需求单ids||false|array|string|
|  demandSideId|订单需求方id||false|string||
|  demandSideName|订单需求方name(冗余字段)||false|string||
|  discountRate|折扣率||false|number||
|  id|订单id||false|string||
|  orderAmount|订单金额(单位为元,保留两位小数点)||false|number||
|  productDesc|其他订单-交付内容||false|string||
|  relatedId|产品id或者解决方案id,选其他产品无关联id||false|string||
|  relatedName|产品名称或者解决方案名称或者其他类的产品名称||false|string||
|  relatedType|订单类型(0表示产品订单,1表示解决方案订单,2表示其他订单)||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 订单信息list查询
**接口地址**:`/business/Order/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|catalogueName|产品或者解决方案的目录名称-16|query|false|string||
|createBy|创建者-16|query|false|string||
|endTime|创建时间范围止|query|false|string(date-time)||
|orderCode|订单编号-25|query|false|string||
|orderState|订单状态-1(传字典值)|query|false|string||
|relatedName|产品名称-64|query|false|string||
|relatedType|订单类型-1(传字典值)|query|false|string||
|startTime|创建时间范围起|query|false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«订单详情vo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|订单详情vo|
|  appId|应用id|string||
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  catalogueName|产品或者解决方案的目录名称|string||
|  createBy|创建人|integer(int64)||
|  createByName|创建人名称|string||
|  createTime|创建时间|string(date-time)||
|  demandSideId|订单需求方id|string||
|  demandSideName|订单需求方name(冗余字段)|string||
|  discountRate|产品折扣率|number||
|  effectiveTime|生效时间|string(date-time)||
|  expirationTime|到期时间|string(date-time)||
|  id|id|string||
|  orderAmount|订单金额(单位为元,保留两位小数点)|number||
|  orderCode|订单编号|string||
|  orderState|订单状态(0已提交,1审核中2已确认3订单转工单4已完成)|string||
|  orderStateName|订单状态|string||
|  relatedId|关联id(订单id或者解决方案id)|string||
|  relatedName|关联名称(订单name或者解决方案name)|string||
|  relatedType|订单类型(0表示产品订单,1表示解决方案订单,2表示其他订单)|string||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"appId": "",
"approvalId": "",
"approvalStatus": "",
"catalogueName": "",
"createBy": 0,
"createByName": "",
"createTime": "",
"demandSideId": "",
"demandSideName": "",
"discountRate": 0,
"effectiveTime": "",
"expirationTime": "",
"id": "",
"orderAmount": 0,
"orderCode": "",
"orderState": "",
"orderStateName": "",
"relatedId": "",
"relatedName": "",
"relatedType": ""
}
],
"msg": "",
"total": 0
}
```
## 查询订单状态
**接口地址**:`/business/Order/status`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"callIds": [],
"contractId": "",
"customerManager": "",
"customerManagerId": 0,
"demandIds": [],
"demandSideId": "",
"demandSideName": "",
"discountRate": 0,
"id": "",
"orderAmount": 0,
"productDesc": "",
"relatedId": "",
"relatedName": "",
"relatedType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|orderEditDto|orderEditDto|body|true|OrderEditDto|OrderEditDto|
|  callIds|申请单ids||false|array|string|
|  contractId|关联的合同id||false|string||
|  customerManager|客户经理名称||false|string||
|  customerManagerId|客户经理id||false|integer(int64)||
|  demandIds|需求单ids||false|array|string|
|  demandSideId|订单需求方id||false|string||
|  demandSideName|订单需求方name(冗余字段)||false|string||
|  discountRate|折扣率||false|number||
|  id|订单id||false|string||
|  orderAmount|订单金额(单位为元,保留两位小数点)||false|number||
|  productDesc|其他订单-交付内容||false|string||
|  relatedId|产品id或者解决方案id,选其他产品无关联id||false|string||
|  relatedName|产品名称或者解决方案名称或者其他类的产品名称||false|string||
|  relatedType|订单类型(0表示产品订单,1表示解决方案订单,2表示其他订单)||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 通过orderId查看订单信息详情关联对应的信息
**接口地址**:`/business/Order/{orderId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|orderId|orderId|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 调用申请单相关接口
## 保存提交调用申请单 提交sub=true保存sub=false
**接口地址**:`/business/transfer/applyInfo/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"applyName": "",
"applyUserName": "",
"approvalInfo": "",
"fileList": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"id": "",
"sub": true
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|transferApplyInfoAddDto|transferApplyInfoAddDto|body|true|新增调用申请单|新增调用申请单|
|  applyName|名称||false|string||
|  applyUserName|申请人姓名||false|string||
|  approvalInfo|申请信息||false|string||
|  fileList|申请文件列表||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  id|申请单id||false|string||
|  sub|是否提交||false|boolean||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 查看调用申请单详情
**接口地址**:`/business/transfer/applyInfo/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 编辑调用申请单
**接口地址**:`/business/transfer/applyInfo/edit`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"applyName": "",
"applyUserName": "",
"approvalInfo": "",
"fileList": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"id": "",
"sub": true
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|transferApplyInfoAddDto|transferApplyInfoAddDto|body|true|新增调用申请单|新增调用申请单|
|  applyName|名称||false|string||
|  applyUserName|申请人姓名||false|string||
|  approvalInfo|申请信息||false|string||
|  fileList|申请文件列表||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  id|申请单id||false|string||
|  sub|是否提交||false|boolean||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 编辑调用单决策结果
**接口地址**:`/business/transfer/applyInfo/editDecision`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"applyStatus": "",
"decisionInfo": "",
"fileList": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"id": "",
"serviceProviderId": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|applyInfoDecisionDto|applyInfoDecisionDto|body|true|TransferApplyInfoDecisionDto|TransferApplyInfoDecisionDto|
|  applyStatus|申请单状态 ||false|string||
|  decisionInfo|决策说明||false|string||
|  fileList|决策文件列表列表||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  id|申请单id||false|string||
|  serviceProviderId|服务商id||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 调用申请单分页列表
**接口地址**:`/business/transfer/applyInfo/pagelist`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|applyName|申请单名称|query|false|string||
|applyNum|申请单编号|query|false|string||
|applyStatus|申请状态|query|false|string||
|applyStatusList||query|false|array|string|
|applyTime|申请提交时间|query|false|string(date-time)||
|applyType|申请单类型 0服务商1调用单|query|false|string||
|applyUserName|申请人名称|query|false|string||
|endTime|结束时间|query|false|string(date-time)||
|forApproval|是否审批 true审核 null or false 所有状态|query|false|boolean||
|id|主键|query|false|string||
|noticeName|公告名称|query|false|string||
|serviceProviderId|服务商外键|query|false|string||
|startTime|开始时间|query|false|string(date-time)||
|userId|联系人id|query|false|string||
|userName|申请人姓名|query|false|string||
|userPhone|联系人手机号|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«ApplyInfoVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|ApplyInfoVo|
|  applyFileList|申请文件列表|array|文件表返回VO|
|    dataId|数据id|string||
|    delFlag||string||
|    fileName|文件名称|string||
|    fileOriginName|文件原名称|string||
|    fileSource|文件来源|string||
|    fileUrl|文件地址|string||
|    id|文件ID|string||
|  applyName|申请单名称|string||
|  applyNum|申请单编号|string||
|  applyStatus|申请状态|string||
|  applyTime|申请提交时间|string(date-time)||
|  applyUserName|申请人姓名|string||
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  decisionFilesList|决策文件列表|array|文件表返回VO|
|    dataId|数据id|string||
|    delFlag||string||
|    fileName|文件名称|string||
|    fileOriginName|文件原名称|string||
|    fileSource|文件来源|string||
|    fileUrl|文件地址|string||
|    id|文件ID|string||
|  decisionInfo|决策结果|string||
|  email|联系人邮箱|string||
|  id|主键|string||
|  noticeName|公告名称|string||
|  serviceProviderId|服务商外键|string||
|  serviceProviderTagList|服务商标签列表|array|能力标签|
|    createBy|创建者|integer||
|    createTime|创建时间|string||
|    deleteStatus|逻辑删除0正常1删除|string||
|    id|主键|string||
|    parentId|上级id|string||
|    remark|标签备注|string||
|    tagName|标签名称|string||
|    updateBy|更新者|integer||
|    updateTime|更新时间|string||
|  serviceProviderTypeList|服务商类型列表|array|服务商类型标签|
|    dictCode|类型code|integer||
|    dictLabel|类型名称|string||
|    dictType|固定值 service_provider_type|string||
|    remark|备注|string||
|    status|状态|string||
|  userId|联系人id|string||
|  userName|联系人姓名|string||
|  userPhone|联系人手机号|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"applyFileList": [
{
"dataId": "",
"delFlag": "",
"fileName": "",
"fileOriginName": "",
"fileSource": "",
"fileUrl": "",
"id": ""
}
],
"applyName": "",
"applyNum": "",
"applyStatus": "",
"applyTime": "",
"applyUserName": "",
"approvalId": "",
"approvalStatus": "",
"decisionFilesList": [
{
"dataId": "",
"delFlag": "",
"fileName": "",
"fileOriginName": "",
"fileSource": "",
"fileUrl": "",
"id": ""
}
],
"decisionInfo": "",
"email": "",
"id": "",
"noticeName": "",
"serviceProviderId": "",
"serviceProviderTagList": [
{
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"id": "",
"parentId": "",
"remark": "",
"tagName": "",
"updateBy": 0,
"updateTime": ""
}
],
"serviceProviderTypeList": [
{
"dictCode": 0,
"dictLabel": "",
"dictType": "",
"remark": "",
"status": ""
}
],
"userId": "",
"userName": "",
"userPhone": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 撤回申请单 审核中可以撤回
**接口地址**:`/business/transfer/applyInfo/revoke/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 上传调用单决策结果
**接口地址**:`/business/transfer/applyInfo/upDecision`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"applyStatus": "",
"decisionInfo": "",
"fileList": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"id": "",
"serviceProviderId": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|applyInfoDecisionDto|applyInfoDecisionDto|body|true|TransferApplyInfoDecisionDto|TransferApplyInfoDecisionDto|
|  applyStatus|申请单状态 ||false|string||
|  decisionInfo|决策说明||false|string||
|  fileList|决策文件列表列表||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  id|申请单id||false|string||
|  serviceProviderId|服务商id||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 删除申请单
**接口地址**:`/business/transfer/applyInfo/{id}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 账单controller
## 新增账单
**接口地址**:`/business/bill`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"approvalId": "",
"approvalStatus": "",
"billCode": "",
"billMoney": 0,
"billName": "",
"billTime": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"demandSideId": "",
"demandSideName": "",
"id": "",
"orderId": "",
"relatedType": "",
"status": "",
"updateBy": 0,
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|bill|bill|body|true|账单表|账单表|
|  approvalId|审批id||false|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核||false|string||
|  billCode|账单编号||false|string||
|  billMoney|账单金额||false|number||
|  billName|租户id||false|string||
|  billTime|出账日期||false|string(date-time)||
|  createBy|创建人||false|integer(int64)||
|  createTime|创建时间||false|string(date-time)||
|  deleteStatus|逻辑删除:{0不删除1删除}||false|string||
|  demandSideId|订单需求方id||false|string||
|  demandSideName|订单需求方name(冗余字段)||false|string||
|  id|id||false|string||
|  orderId|订单id||false|string||
|  relatedType|账单类型0产品、1解决方案2其他订单||false|string||
|  status|状态:{0已出账2待核销3驳回1已核销}||false|string||
|  updateBy|修改人||false|integer(int64)||
|  updateTime|修改时间||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 修改账单
**接口地址**:`/business/bill`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
[
{
"billDetailId": "",
"billId": "",
"billMoney": 0,
"relatedType": "",
"totalPrice": 0
}
]
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|billEditDto|billEditDto|body|true|array|BillEditDto|
|  billDetailId|账单明细id||false|string||
|  billId|账单id||false|string||
|  billMoney|账单明细金额||false|number(double)||
|  relatedType|账单类型||false|string||
|  totalPrice|账单总金额||false|number(double)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 账单核销
**接口地址**:`/business/bill/check/{billId}`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|billId|billId|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 客户中心列表查询
**接口地址**:`/business/bill/customerList`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|billMoney|账单总金额|query|false|number||
|billTime|出账日期|query|false|string(date-time)||
|customerManager|客户经理(账单核销人)|query|false|string||
|productName|产品名称|query|false|string||
|status|账单状态|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«账单对象VO»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|账单对象VO|
|  approvalId|审批id|string||
|  billCode|账单编号|string||
|  billTime|出账日期|string(date-time)||
|  customerManager|客户经理(账单核销人)|string||
|  demandSideName|客户名称|string||
|  id|账单ID|string||
|  orderId|订单id|string||
|  productName|产品名称|string||
|  relatedType|账单类型|string||
|  relatedTypeName|账单类型name|string||
|  status|账单状态:{0已出账1已核销}|string||
|  statusName|账单状态name|string||
|  totalPrice|账单总金额|string||
|  userId|账单所属账号(反显用户名)|integer(int64)||
|  userName|账单所属账号(反显用户名)|string||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"approvalId": "",
"billCode": "",
"billTime": "",
"customerManager": "",
"demandSideName": "",
"id": "",
"orderId": "",
"productName": "",
"relatedType": "",
"relatedTypeName": "",
"status": "",
"statusName": "",
"totalPrice": "",
"userId": 0,
"userName": ""
}
],
"msg": "",
"total": 0
}
```
## 导出单账单信息
**接口地址**:`/business/bill/export`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|approval|审批 1-查审批数据|query|false|integer(int32)||
|billIds|billIds|query|false|array|string|
|billMoney|账单总金额|query|false|number(double)||
|demandSideName|客户名称|query|false|string||
|endTime|发布时间范围止|query|false|string(date-time)||
|productName|产品名称|query|false|string||
|relatedType|账单类型0产品、1解决方案2其他订单|query|false|string||
|startTime|发布时间范围起|query|false|string(date-time)||
|status|账单状态|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取账单列表
**接口地址**:`/business/bill/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|approval|审批 1-查审批数据|query|false|integer(int32)||
|billMoney|账单总金额|query|false|number(double)||
|demandSideName|客户名称|query|false|string||
|endTime|发布时间范围止|query|false|string(date-time)||
|productName|产品名称|query|false|string||
|relatedType|账单类型0产品、1解决方案2其他订单|query|false|string||
|startTime|发布时间范围起|query|false|string(date-time)||
|status|账单状态|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«账单对象VO»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|账单对象VO|
|  approvalId|审批id|string||
|  billCode|账单编号|string||
|  billTime|出账日期|string(date-time)||
|  customerManager|客户经理(账单核销人)|string||
|  demandSideName|客户名称|string||
|  id|账单ID|string||
|  orderId|订单id|string||
|  productName|产品名称|string||
|  relatedType|账单类型|string||
|  relatedTypeName|账单类型name|string||
|  status|账单状态:{0已出账1已核销}|string||
|  statusName|账单状态name|string||
|  totalPrice|账单总金额|string||
|  userId|账单所属账号(反显用户名)|integer(int64)||
|  userName|账单所属账号(反显用户名)|string||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"approvalId": "",
"billCode": "",
"billTime": "",
"customerManager": "",
"demandSideName": "",
"id": "",
"orderId": "",
"productName": "",
"relatedType": "",
"relatedTypeName": "",
"status": "",
"statusName": "",
"totalPrice": "",
"userId": 0,
"userName": ""
}
],
"msg": "",
"total": 0
}
```
## 工作台账单待核销列表
**接口地址**:`/business/bill/opList`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
暂无
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 根据订单id获取账单详情
**接口地址**:`/business/bill/selectByOrderId/{orderId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|orderId|orderId|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 根据账单id获取账单详情
**接口地址**:`/business/bill/selectOne/{billId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|billId|billId|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 删除账单
**接口地址**:`/business/bill/{ids}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 通知公告
## 新增通知公告
**接口地址**:`/business/notice/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"noticeContent": "",
"noticeId": 0,
"noticeTitle": "",
"noticeType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|noticeAddDto|noticeAddDto|body|true|NoticeAddDto|NoticeAddDto|
|  noticeContent|公告内容||false|string||
|  noticeId|公告ID||false|integer(int64)||
|  noticeTitle|公告标题||false|string||
|  noticeType|公告类型1-升级公告、2-安全公告、3-备案公告、4-产品公告、5-其他公告)||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 修改通知公告
**接口地址**:`/business/notice/edit`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"noticeContent": "",
"noticeId": 0,
"noticeTitle": "",
"noticeType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|noticeEditDto|noticeEditDto|body|true|NoticeEditDto|NoticeEditDto|
|  noticeContent|公告内容||false|string||
|  noticeId|公告标题||false|integer(int64)||
|  noticeTitle|公告标题||false|string||
|  noticeType|公告类型1-升级公告、2-安全公告、3-备案公告、4-产品公告、5-其他公告)||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取通知公告列表
**接口地址**:`/business/notice/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|approval|审核状态 ,1-审核(默认显示 审核中,已通过,驳回)|query|false|string||
|approvalStatus|审核状态 ,1-待审核,2-审核通过,4-审核驳回|query|false|string||
|endTime|发布时间范围止|query|false|string(date-time)||
|noticeType|公告类型1-升级公告、2-安全公告、3-备案公告、4-产品公告、5-其他公告)|query|false|string||
|startTime|发布时间范围起|query|false|string(date-time)||
|status|公告状态(新建-0,审核中-1,已上线-2,已下线-3)|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«NoticeListVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|NoticeListVo|
|  approvalId|审批id|string||
|  createBy|创建者|integer(int64)||
|  createByName|创建者name|string||
|  createTime|创建时间|string(date-time)||
|  noticeContent|公告内容|string||
|  noticeId|公告ID|integer(int64)||
|  noticeTitle|公告标题|string||
|  noticeType|公告类型1-升级公告、2-安全公告、3-备案公告、4-产品公告、5-其他公告)|string||
|  noticeTypeName|公告类型名称|string||
|  remark|备注|string||
|  status|公告状态(新建-0,审核中-1,已上线-2,已下线-3)|string||
|  statusName|公告状态name|string||
|  updateBy|更新者|integer(int64)||
|  updateByName|更新者name|string||
|  updateTime|更新时间|string(date-time)||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"approvalId": "",
"createBy": 0,
"createByName": "",
"createTime": "",
"noticeContent": "",
"noticeId": 0,
"noticeTitle": "",
"noticeType": "",
"noticeTypeName": "",
"remark": "",
"status": "",
"statusName": "",
"updateBy": 0,
"updateByName": "",
"updateTime": ""
}
],
"msg": "",
"total": 0
}
```
## 撤回通知公告
**接口地址**:`/business/notice/revoke/{noticeId}`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|noticeId|noticeId|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 保存通知公告
**接口地址**:`/business/notice/save`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"noticeContent": "",
"noticeId": 0,
"noticeTitle": "",
"noticeType": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|noticeAddDto|noticeAddDto|body|true|NoticeAddDto|NoticeAddDto|
|  noticeContent|公告内容||false|string||
|  noticeId|公告ID||false|integer(int64)||
|  noticeTitle|公告标题||false|string||
|  noticeType|公告类型1-升级公告、2-安全公告、3-备案公告、4-产品公告、5-其他公告)||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 下架-上架通知公告
**接口地址**:`/business/notice/shelf`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"noticeId": 0,
"operation": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|noticeShelf|noticeShelf|body|true|NoticeShelf|NoticeShelf|
|  noticeId|公告ID||false|integer(int64)||
|  operation|操作(0-下架,1上架)||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 删除通知公告
**接口地址**:`/business/notice/{ids}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 根据通知公告id获取详细信息
**接口地址**:`/business/notice/{noticeId}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|noticeId|noticeId|path|true|integer(int64)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 邀约,招募公告控制器
## 获取通知公告列表
**接口地址**:`/business/inviteNotice/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|failureTimeEnd|失效时间止|query|false|string(date-time)||
|failureTimeStart|失效时间起|query|false|string(date-time)||
|forApproval|是否审批 true审核 null or false 所有状态|query|false|boolean||
|noticeTitle|公告标题|query|false|string||
|noticeType|公告类型0-邀约公告表,1-招募公告,2-结果公示信息|query|false|string||
|status|新建-0,审核中-1,已上线-2,3-驳回,4-失效|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«InviteListVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|InviteListVo|
|  approvalId|审批id|string||
|  createBy|创建者(发布人员)|integer(int64)||
|  createByName|创建者(发布人员)name|string||
|  createTime|创建时间|string(date-time)||
|  failureTime|失效时间|string(date-time)||
|  id|公告ID|string||
|  noticeContent|公告内容|string||
|  noticeTitle|公告标题|string||
|  noticeType|公告类型0-邀约公告表,1-招募公告,2-结果公示信息)|string||
|  noticeTypeName|公告类型name|string||
|  publicity|是否公示结果 true公示 false null 未公示|boolean||
|  status|新建-0,审核中-1,已上线-2,3-驳回,4-失效|string||
|  statusName|新建-0,审核中-1,已上线-2,3-驳回,4-失效|string||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"approvalId": "",
"createBy": 0,
"createByName": "",
"createTime": "",
"failureTime": "",
"id": "",
"noticeContent": "",
"noticeTitle": "",
"noticeType": "",
"noticeTypeName": "",
"publicity": true,
"status": "",
"statusName": ""
}
],
"msg": "",
"total": 0
}
```
## 发布公告
**接口地址**:`/business/inviteNotice/publish`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"enclosure": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"failureTime": "",
"id": "",
"noticeContent": "",
"noticeTitle": "",
"noticeType": "",
"originalNoticeId": "",
"serviceProviderIdList": [],
"sub": true,
"topping": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|inviteAddDto|inviteAddDto|body|true|InviteAddDto|InviteAddDto|
|  enclosure|附件,最多上传10个文件每个文件大小不超过20M支持pdf、doc、docx等格式||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  failureTime|失效时间||false|string(date-time)||
|  id|id||false|string||
|  noticeContent|公告内容||false|string||
|  noticeTitle|公告标题||false|string||
|  noticeType|公告类型0-邀约公告表,1-招募公告,2-结果公示信息)||false|string||
|  originalNoticeId|公示公告原始公告id||false|string||
|  serviceProviderIdList|服务商id集合||false|array|string|
|  sub|是否发布,true-保存并发布,false-保存||false|boolean||
|  topping|是否置顶,0-不置顶,1-置顶||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 撤销公告
**接口地址**:`/business/inviteNotice/revoke/{id}`
**请求方式**:`PUT`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 保存公告
**接口地址**:`/business/inviteNotice/save`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"enclosure": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"failureTime": "",
"id": "",
"noticeContent": "",
"noticeTitle": "",
"noticeType": "",
"originalNoticeId": "",
"serviceProviderIdList": [],
"sub": true,
"topping": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|inviteAddDto|inviteAddDto|body|true|InviteAddDto|InviteAddDto|
|  enclosure|附件,最多上传10个文件每个文件大小不超过20M支持pdf、doc、docx等格式||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  failureTime|失效时间||false|string(date-time)||
|  id|id||false|string||
|  noticeContent|公告内容||false|string||
|  noticeTitle|公告标题||false|string||
|  noticeType|公告类型0-邀约公告表,1-招募公告,2-结果公示信息)||false|string||
|  originalNoticeId|公示公告原始公告id||false|string||
|  serviceProviderIdList|服务商id集合||false|array|string|
|  sub|是否发布,true-保存并发布,false-保存||false|boolean||
|  topping|是否置顶,0-不置顶,1-置顶||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 根据id查询公告详情
**接口地址**:`/business/inviteNotice/selectOne`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|InviteVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|approvalId|审批id|string||
|createBy|创建者(发布人员)|integer(int64)|integer(int64)|
|createByName|创建者(发布人员)name|string||
|enclosure|附件,最多上传10个文件每个文件大小不超过20M支持pdf、doc、docx等格式|array|文件表返回VO|
|  dataId|数据id|string||
|  delFlag||string||
|  fileName|文件名称|string||
|  fileOriginName|文件原名称|string||
|  fileSource|文件来源|string||
|  fileUrl|文件地址|string||
|  id|文件ID|string||
|failureTime|失效时间|string(date-time)|string(date-time)|
|id|公告ID|string||
|noticeContent|公告内容|string||
|noticeTitle|公告标题|string||
|noticeType|公告类型0-邀约公告表,1-招募公告,2-结果公示信息)|string||
|noticeTypeName|公告类型name|string||
|serviceProvider|服务商信息|array|ProviderVo|
|  abilityTagIds|行业标签(能力标签)|string||
|  abilityTagName|行业标签(能力标签)|array|string|
|  id|主键|string||
|  phone|联系人电话|string||
|  serviceName|服务商名称|string||
|  serviceTypeIds|服务商类型外键集合,逗号分隔|string||
|  serviceTypeIdsName|服务商类型外键集合,逗号分隔|array|string|
|  status|合作状态0合作种 1已过期|string||
|  statusName|合作状态name|string||
|  userName|联系人姓名|string||
|status|新建-0,审核中-1,已上线-2,3-驳回,4-失效|string||
|statusName|新建-0,审核中-1,已上线-2,3-驳回,4-失效|string||
|topping|是否置顶,0-不置顶,1-置顶|string||
|toppingName|是否置顶name|string||
**响应示例**:
```javascript
{
"approvalId": "",
"createBy": 0,
"createByName": "",
"enclosure": [
{
"dataId": "",
"delFlag": "",
"fileName": "",
"fileOriginName": "",
"fileSource": "",
"fileUrl": "",
"id": ""
}
],
"failureTime": "",
"id": "",
"noticeContent": "",
"noticeTitle": "",
"noticeType": "",
"noticeTypeName": "",
"serviceProvider": [
{
"abilityTagIds": "",
"abilityTagName": [],
"id": "",
"phone": "",
"serviceName": "",
"serviceTypeIds": "",
"serviceTypeIdsName": [],
"status": "",
"statusName": "",
"userName": ""
}
],
"status": "",
"statusName": "",
"topping": "",
"toppingName": ""
}
```
## 删除公告
**接口地址**:`/business/inviteNotice/{ids}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```
# 门户我的合同管理
## 查询我的合同
**接口地址**:`/business/pre/contract/mylist`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|amount|合同金额|query|false|string||
|contractCode|合同编码|query|false|string||
|contractName|合同名称|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«ContractVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|ContractVo|
|  amount|合同金额|string||
|  belongUser|归属客户|string||
|  belongUserId|归属客户id|integer(int64)||
|  businessType|商机获取方式1线下 0线上|string||
|  contractCode|合同编码|string||
|  contractFile|合同文件|string||
|  contractFileName|合同文件名称|string||
|  contractName|合同名称|string||
|  contractType|合同类型1客户型2合作型|string||
|  createBy|创建人id|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  creator||string||
|  customerManager|客户经理|string||
|  customerManagerId|客户经理id|integer(int64)||
|  deleteStatus|逻辑删除0正常1删除|string||
|  id||string||
|  purchasingAgent|甲方|string||
|  remark|备注|string||
|  signTime|合同签订日期|string||
|  supplier|乙方|string||
|  updateBy|修改人id|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|  updator||string||
|  userContractId|关联客户合同id|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"amount": "",
"belongUser": "",
"belongUserId": 0,
"businessType": "",
"contractCode": "",
"contractFile": "",
"contractFileName": "",
"contractName": "",
"contractType": "",
"createBy": 0,
"createTime": "",
"creator": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"id": "",
"purchasingAgent": "",
"remark": "",
"signTime": "",
"supplier": "",
"updateBy": 0,
"updateTime": "",
"updator": "",
"userContractId": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## 查询合同详细信息
**接口地址**:`/business/pre/contract/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|ContractDetailVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|amount|合同金额|string||
|belongUser|归属客户|string||
|belongUserId|归属客户id|integer(int64)|integer(int64)|
|businessType|商机获取方式1线下 0线上|string||
|contractCode|合同编码|string||
|contractFile|合同文件|string||
|contractFileName|合同文件名称|string||
|contractName|合同名称|string||
|contractType|合同类型1客户型2合作型|string||
|contracts|关联用户合同|array|Contract|
|  amount|合同金额|string||
|  belongUser|归属客户|string||
|  belongUserId|归属客户id|integer(int64)||
|  businessType|商机获取方式1线下 0线上|string||
|  contractCode|合同编码|string||
|  contractFile|合同文件|string||
|  contractFileName|合同文件名称|string||
|  contractName|合同名称|string||
|  contractType|合同类型1客户型2合作型|string||
|  createBy|创建人id|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  customerManager|客户经理|string||
|  customerManagerId|客户经理id|integer(int64)||
|  deleteStatus|逻辑删除0正常1删除|string||
|  id|主键|string||
|  purchasingAgent|甲方|string||
|  remark|备注|string||
|  signTime|合同签订日期|string||
|  supplier|乙方|string||
|  updateBy|修改人id|integer(int64)||
|  updateTime|更新时间|string(date-time)||
|  userContractId|关联客户合同id|string||
|createBy|创建人id|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|customerManager|客户经理|string||
|customerManagerId|客户经理id|integer(int64)|integer(int64)|
|customerVo|归属客户企业信息|客户管理|客户管理|
|  authStatus|企业认证状态 2驳回 1通过 0待审核|string||
|  avatar|用户头像|string||
|  email|用户邮箱|string||
|  enterpriseId|企业id|string||
|  enterpriseName|企业名称|string||
|  loginDate|最后登录时间|string(date-time)||
|  nickName|用户名称|string||
|  phonenumber|手机号码|string||
|  status|帐号状态|string||
|  userId|用户ID|integer(int64)||
|  userName|登录名称|string||
|deleteStatus|逻辑删除0正常1删除|string||
|demand|关联需求单|array|需求单表|
|  clueId|关联线索id|string||
|  company|公司名称|string||
|  createBy|创建人|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  customerManager|客户经理|string||
|  customerManagerId|客户经理id|integer(int64)||
|  deleteStatus|逻辑删除:{0不删除1删除}|string||
|  demandCode|需求单号 用户ID + 年-月-日+三位序列号|string||
|  demandDesc|需求描述|string||
|  demandName|姓名|string||
|  facilitatorId|服务商id|string||
|  feedback|反馈结果|string||
|  id|id|string||
|  origin|0咪咕商机线索1服务商商机线索|string||
|  phoneNum|手机号码|string||
|  relatedId|关联id|string||
|  relatedName|关联名称|string||
|  relatedType|0产品1解决方案|string||
|  remark|备注|string||
|  sellPredict|销售金额预测|number||
|  source|0营销门户创建1系统用户创建|string||
|  status|0已提交1跟进中2已完成|string||
|  transactionStatus|成交状态 0未完成1已完成|string||
|  updateBy|修改人|integer(int64)||
|  updateTime|修改时间|string(date-time)||
|id||string||
|order|关联订单|array|订单表|
|  appId|应用id|string||
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  catalogueName|产品或者解决方案的目录名称|string||
|  contractId|关联的合同id|string||
|  createBy|创建人|integer(int64)||
|  createByName|创建人姓名|string||
|  createTime|创建时间|string(date-time)||
|  customerManager|客户经理|string||
|  customerManagerId|客户经理id|integer(int64)||
|  deleteStatus|逻辑删除:{0不删除1删除}|string||
|  demandSideId|订单需求方id|string||
|  demandSideName|订单需求方name(冗余字段)|string||
|  discountRate|折扣率|number||
|  effectiveTime|生效时间|string(date-time)||
|  expirationTime|到期时间|string(date-time)||
|  id|id|string||
|  orderAmount|订单金额(单位为元,保留两位小数点)|number||
|  orderCode|订单编号,生成规则 DD+年月日时分秒+客户ID|string||
|  orderState|订单状态(0已提交,1审核中2已确认3订单转工单4已完成)|string||
|  productDesc|其他订单-交付内容|string||
|  relatedId|关联id|string||
|  relatedName|关联名称|string||
|  relatedType|订单类型(0表示产品订单,1表示解决方案订单,2表示其他订单)|string||
|  updateBy|修改人|integer(int64)||
|  updateTime|修改时间|string(date-time)||
|purchasingAgent|甲方|string||
|remark|备注|string||
|signTime|合同签订日期|string||
|supplier|乙方|string||
|updateBy|修改人id|integer(int64)|integer(int64)|
|updateTime|更新时间|string(date-time)|string(date-time)|
|userContractId|关联客户合同id|string||
**响应示例**:
```javascript
{
"amount": "",
"belongUser": "",
"belongUserId": 0,
"businessType": "",
"contractCode": "",
"contractFile": "",
"contractFileName": "",
"contractName": "",
"contractType": "",
"contracts": [
{
"amount": "",
"belongUser": "",
"belongUserId": 0,
"businessType": "",
"contractCode": "",
"contractFile": "",
"contractFileName": "",
"contractName": "",
"contractType": "",
"createBy": 0,
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"id": "",
"purchasingAgent": "",
"remark": "",
"signTime": "",
"supplier": "",
"updateBy": 0,
"updateTime": "",
"userContractId": ""
}
],
"createBy": 0,
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"customerVo": {
"authStatus": "",
"avatar": "",
"email": "",
"enterpriseId": "",
"enterpriseName": "",
"loginDate": "",
"nickName": "",
"phonenumber": "",
"status": "",
"userId": 0,
"userName": ""
},
"deleteStatus": "",
"demand": [
{
"clueId": "",
"company": "",
"createBy": 0,
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"demandCode": "",
"demandDesc": "",
"demandName": "",
"facilitatorId": "",
"feedback": "",
"id": "",
"origin": "",
"phoneNum": "",
"relatedId": "",
"relatedName": "",
"relatedType": "",
"remark": "",
"sellPredict": 0,
"source": "",
"status": "",
"transactionStatus": "",
"updateBy": 0,
"updateTime": ""
}
],
"id": "",
"order": [
{
"appId": "",
"approvalId": "",
"approvalStatus": "",
"catalogueName": "",
"contractId": "",
"createBy": 0,
"createByName": "",
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"demandSideId": "",
"demandSideName": "",
"discountRate": 0,
"effectiveTime": "",
"expirationTime": "",
"id": "",
"orderAmount": 0,
"orderCode": "",
"orderState": "",
"productDesc": "",
"relatedId": "",
"relatedName": "",
"relatedType": "",
"updateBy": 0,
"updateTime": ""
}
],
"purchasingAgent": "",
"remark": "",
"signTime": "",
"supplier": "",
"updateBy": 0,
"updateTime": "",
"userContractId": ""
}
```
# 门户目录
## 查询所有目录(门户展示)
**接口地址**:`/business/pre/catalog/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|catalogName|目录名称|query|false|string||
|catalogType|导航类型0产品1解决方案|query|false|string||
|parentId|父级目录id(1级为0)|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«CatalogListVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|CatalogListVo|
|  catalogName|目录名称|string||
|  catalogType|导航类型0产品1解决方案|string||
|  childrenList|该目录下的子集目录|array|CatalogVo|
|    catalogName|目录名称|string||
|    catalogType|导航类型0产品1解决方案|string||
|    createBy|创建人id|integer||
|    createTime|创建时间|string||
|    deleteStatus||string||
|    displayNot|是否展示0否1是|string||
|    id||string||
|    nodeList|该目录下的产品或解决方案|array|NodeVo|
|      id||string||
|      name||string||
|    parentId|父级目录id(1级为0)|string||
|    remark|目录说明|string||
|    updateBy|修改人id|integer||
|    updateTime|更新时间|string||
|  displayNot|是否展示0否1是|string||
|  id||string||
|  parentId|父级目录id(1级为0)|string||
|  remark|目录说明|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"catalogName": "",
"catalogType": "",
"childrenList": [
{
"catalogName": "",
"catalogType": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"displayNot": "",
"id": "",
"nodeList": [
{
"id": "",
"name": ""
}
],
"parentId": "",
"remark": "",
"updateBy": 0,
"updateTime": ""
}
],
"displayNot": "",
"id": "",
"parentId": "",
"remark": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
# 门户端结算单相关接口
## 结算单详情---客户中心
**接口地址**:`/business/pre/settle/custom/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|SettleVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|approvalId|审批id|string||
|approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|billCode|结算单编号|string||
|billMoney|结算单金额|number||
|billTime|结算单出账日期|string||
|createBy|创建人|integer(int64)|integer(int64)|
|createTime|创建时间|string||
|demandSideId|订单需求方id|string||
|demandSideName|订单需求方name(冗余字段)|string||
|id|id|string||
|orderId|订单id|string||
|relatedBelongId|结算单关联主体关联合作伙伴id|string||
|relatedBelongName|结算单关联主体名称关联合作伙伴名称(咪咕自营-》咪咕自营)|string||
|relatedId|结算单关联主体id能力名称或解决方案名称或产品id|string||
|relatedName|结算单关联主体名称(能力名称或解决方案名称或产品名称)|string||
|relatedProType|结算单关联能力类型|string||
|relatedType|结算单类型0产品、1解决方案2其他订单|string||
|settleBelong|结算单关联主体归属0-咪咕自营1-合作伙伴)|string||
|settleVoList|当前结算单能力关联产品列表|array|SettleVo|
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  billCode|结算单编号|string||
|  billMoney|结算单金额|number||
|  billTime|结算单出账日期|string||
|  createBy|创建人|integer(int64)||
|  createTime|创建时间|string||
|  demandSideId|订单需求方id|string||
|  demandSideName|订单需求方name(冗余字段)|string||
|  id|id|string||
|  orderId|订单id|string||
|  relatedBelongId|结算单关联主体关联合作伙伴id|string||
|  relatedBelongName|结算单关联主体名称关联合作伙伴名称(咪咕自营-》咪咕自营)|string||
|  relatedId|结算单关联主体id能力名称或解决方案名称或产品id|string||
|  relatedName|结算单关联主体名称(能力名称或解决方案名称或产品名称)|string||
|  relatedProType|结算单关联能力类型|string||
|  relatedType|结算单类型0产品、1解决方案2其他订单|string||
|  settleBelong|结算单关联主体归属0-咪咕自营1-合作伙伴)|string||
|  settleVoList|当前结算单能力关联产品列表|array|SettleVo|
|  status|状态:{0已出账2待结算1已结算,3驳回}|string||
|  statusName|状态:{0已出账2待结算1已结算,3驳回}|string||
|  updateBy|修改人|integer(int64)||
|  updateTime|修改时间|string||
|status|状态:{0已出账2待结算1已结算,3驳回}|string||
|statusName|状态:{0已出账2待结算1已结算,3驳回}|string||
|updateBy|修改人|integer(int64)|integer(int64)|
|updateTime|修改时间|string||
**响应示例**:
```javascript
{
"approvalId": "",
"approvalStatus": "",
"billCode": "",
"billMoney": 0,
"billTime": "",
"createBy": 0,
"createTime": "",
"demandSideId": "",
"demandSideName": "",
"id": "",
"orderId": "",
"relatedBelongId": "",
"relatedBelongName": "",
"relatedId": "",
"relatedName": "",
"relatedProType": "",
"relatedType": "",
"settleBelong": "",
"settleVoList": [
{
"approvalId": "",
"approvalStatus": "",
"billCode": "",
"billMoney": 0,
"billTime": "",
"createBy": 0,
"createTime": "",
"demandSideId": "",
"demandSideName": "",
"id": "",
"orderId": "",
"relatedBelongId": "",
"relatedBelongName": "",
"relatedId": "",
"relatedName": "",
"relatedProType": "",
"relatedType": "",
"settleBelong": "",
"settleVoList": [],
"status": "",
"statusName": "",
"updateBy": 0,
"updateTime": ""
}
],
"status": "",
"statusName": "",
"updateBy": 0,
"updateTime": ""
}
```
## 结算单查询---客户中心
**接口地址**:`/business/pre/settle/custom/pageList`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|approvalStatus|审批状态|query|false|string||
|forApproval|是否审批|query|false|string||
|relateBelong|归属咪咕自营 或xxx生态成员|query|false|string||
|relateName|结算单主体名称|query|false|string||
|relateType|结算单类型 0产品、1解决方案2其他订单|query|false|string||
|settleEndTime|出账结束日期|query|false|string(date-time)||
|settleStartTime|出账开始日期|query|false|string(date-time)||
|settleStatus|结算单状态{0已出账1待结算2已结算}|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«SettleVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|SettleVo|
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  billCode|结算单编号|string||
|  billMoney|结算单金额|number||
|  billTime|结算单出账日期|string||
|  createBy|创建人|integer(int64)||
|  createTime|创建时间|string||
|  demandSideId|订单需求方id|string||
|  demandSideName|订单需求方name(冗余字段)|string||
|  id|id|string||
|  orderId|订单id|string||
|  relatedBelongId|结算单关联主体关联合作伙伴id|string||
|  relatedBelongName|结算单关联主体名称关联合作伙伴名称(咪咕自营-》咪咕自营)|string||
|  relatedId|结算单关联主体id能力名称或解决方案名称或产品id|string||
|  relatedName|结算单关联主体名称(能力名称或解决方案名称或产品名称)|string||
|  relatedProType|结算单关联能力类型|string||
|  relatedType|结算单类型0产品、1解决方案2其他订单|string||
|  settleBelong|结算单关联主体归属0-咪咕自营1-合作伙伴)|string||
|  settleVoList|当前结算单能力关联产品列表|array|SettleVo|
|  status|状态:{0已出账2待结算1已结算,3驳回}|string||
|  statusName|状态:{0已出账2待结算1已结算,3驳回}|string||
|  updateBy|修改人|integer(int64)||
|  updateTime|修改时间|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"approvalId": "",
"approvalStatus": "",
"billCode": "",
"billMoney": 0,
"billTime": "",
"createBy": 0,
"createTime": "",
"demandSideId": "",
"demandSideName": "",
"id": "",
"orderId": "",
"relatedBelongId": "",
"relatedBelongName": "",
"relatedId": "",
"relatedName": "",
"relatedProType": "",
"relatedType": "",
"settleBelong": "",
"settleVoList": [],
"status": "",
"statusName": "",
"updateBy": 0,
"updateTime": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
## export
**接口地址**:`/business/pre/settle/export`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
|approvalStatus|审批状态|query|false|string||
|forApproval|是否审批|query|false|string||
|relateBelong|归属咪咕自营 或xxx生态成员|query|false|string||
|relateName|结算单主体名称|query|false|string||
|relateType|结算单类型 0产品、1解决方案2其他订单|query|false|string||
|settleEndTime|出账结束日期|query|false|string(date-time)||
|settleStartTime|出账开始日期|query|false|string(date-time)||
|settleStatus|结算单状态{0已出账1待结算2已结算}|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## export
**接口地址**:`/business/pre/settle/export/{ids}`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
|approvalStatus|审批状态|query|false|string||
|forApproval|是否审批|query|false|string||
|relateBelong|归属咪咕自营 或xxx生态成员|query|false|string||
|relateName|结算单主体名称|query|false|string||
|relateType|结算单类型 0产品、1解决方案2其他订单|query|false|string||
|settleEndTime|出账结束日期|query|false|string(date-time)||
|settleStartTime|出账开始日期|query|false|string(date-time)||
|settleStatus|结算单状态{0已出账1待结算2已结算}|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 结算单详情----生态成员
**接口地址**:`/business/pre/settle/forBelong/detail/{id}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|SettleVo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|approvalId|审批id|string||
|approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|billCode|结算单编号|string||
|billMoney|结算单金额|number||
|billTime|结算单出账日期|string||
|createBy|创建人|integer(int64)|integer(int64)|
|createTime|创建时间|string||
|demandSideId|订单需求方id|string||
|demandSideName|订单需求方name(冗余字段)|string||
|id|id|string||
|orderId|订单id|string||
|relatedBelongId|结算单关联主体关联合作伙伴id|string||
|relatedBelongName|结算单关联主体名称关联合作伙伴名称(咪咕自营-》咪咕自营)|string||
|relatedId|结算单关联主体id能力名称或解决方案名称或产品id|string||
|relatedName|结算单关联主体名称(能力名称或解决方案名称或产品名称)|string||
|relatedProType|结算单关联能力类型|string||
|relatedType|结算单类型0产品、1解决方案2其他订单|string||
|settleBelong|结算单关联主体归属0-咪咕自营1-合作伙伴)|string||
|settleVoList|当前结算单能力关联产品列表|array|SettleVo|
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  billCode|结算单编号|string||
|  billMoney|结算单金额|number||
|  billTime|结算单出账日期|string||
|  createBy|创建人|integer(int64)||
|  createTime|创建时间|string||
|  demandSideId|订单需求方id|string||
|  demandSideName|订单需求方name(冗余字段)|string||
|  id|id|string||
|  orderId|订单id|string||
|  relatedBelongId|结算单关联主体关联合作伙伴id|string||
|  relatedBelongName|结算单关联主体名称关联合作伙伴名称(咪咕自营-》咪咕自营)|string||
|  relatedId|结算单关联主体id能力名称或解决方案名称或产品id|string||
|  relatedName|结算单关联主体名称(能力名称或解决方案名称或产品名称)|string||
|  relatedProType|结算单关联能力类型|string||
|  relatedType|结算单类型0产品、1解决方案2其他订单|string||
|  settleBelong|结算单关联主体归属0-咪咕自营1-合作伙伴)|string||
|  settleVoList|当前结算单能力关联产品列表|array|SettleVo|
|  status|状态:{0已出账2待结算1已结算,3驳回}|string||
|  statusName|状态:{0已出账2待结算1已结算,3驳回}|string||
|  updateBy|修改人|integer(int64)||
|  updateTime|修改时间|string||
|status|状态:{0已出账2待结算1已结算,3驳回}|string||
|statusName|状态:{0已出账2待结算1已结算,3驳回}|string||
|updateBy|修改人|integer(int64)|integer(int64)|
|updateTime|修改时间|string||
**响应示例**:
```javascript
{
"approvalId": "",
"approvalStatus": "",
"billCode": "",
"billMoney": 0,
"billTime": "",
"createBy": 0,
"createTime": "",
"demandSideId": "",
"demandSideName": "",
"id": "",
"orderId": "",
"relatedBelongId": "",
"relatedBelongName": "",
"relatedId": "",
"relatedName": "",
"relatedProType": "",
"relatedType": "",
"settleBelong": "",
"settleVoList": [
{
"approvalId": "",
"approvalStatus": "",
"billCode": "",
"billMoney": 0,
"billTime": "",
"createBy": 0,
"createTime": "",
"demandSideId": "",
"demandSideName": "",
"id": "",
"orderId": "",
"relatedBelongId": "",
"relatedBelongName": "",
"relatedId": "",
"relatedName": "",
"relatedProType": "",
"relatedType": "",
"settleBelong": "",
"settleVoList": [],
"status": "",
"statusName": "",
"updateBy": 0,
"updateTime": ""
}
],
"status": "",
"statusName": "",
"updateBy": 0,
"updateTime": ""
}
```
## 结算单查询----生态成员
**接口地址**:`/business/pre/settle/forBelong/pageList`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|approvalStatus|审批状态|query|false|string||
|forApproval|是否审批|query|false|string||
|relateBelong|归属咪咕自营 或xxx生态成员|query|false|string||
|relateName|结算单主体名称|query|false|string||
|relateType|结算单类型 0产品、1解决方案2其他订单|query|false|string||
|settleEndTime|出账结束日期|query|false|string(date-time)||
|settleStartTime|出账开始日期|query|false|string(date-time)||
|settleStatus|结算单状态{0已出账1待结算2已结算}|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|PageInfo«SettleVo»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|endRow||integer(int64)|integer(int64)|
|hasNextPage||boolean||
|hasPreviousPage||boolean||
|isFirstPage||boolean||
|isLastPage||boolean||
|list||array|SettleVo|
|  approvalId|审批id|string||
|  approvalStatus|审批状态 2驳回 1通过 0待审核|string||
|  billCode|结算单编号|string||
|  billMoney|结算单金额|number||
|  billTime|结算单出账日期|string||
|  createBy|创建人|integer(int64)||
|  createTime|创建时间|string||
|  demandSideId|订单需求方id|string||
|  demandSideName|订单需求方name(冗余字段)|string||
|  id|id|string||
|  orderId|订单id|string||
|  relatedBelongId|结算单关联主体关联合作伙伴id|string||
|  relatedBelongName|结算单关联主体名称关联合作伙伴名称(咪咕自营-》咪咕自营)|string||
|  relatedId|结算单关联主体id能力名称或解决方案名称或产品id|string||
|  relatedName|结算单关联主体名称(能力名称或解决方案名称或产品名称)|string||
|  relatedProType|结算单关联能力类型|string||
|  relatedType|结算单类型0产品、1解决方案2其他订单|string||
|  settleBelong|结算单关联主体归属0-咪咕自营1-合作伙伴)|string||
|  settleVoList|当前结算单能力关联产品列表|array|SettleVo|
|  status|状态:{0已出账2待结算1已结算,3驳回}|string||
|  statusName|状态:{0已出账2待结算1已结算,3驳回}|string||
|  updateBy|修改人|integer(int64)||
|  updateTime|修改时间|string||
|navigateFirstPage||integer(int32)|integer(int32)|
|navigateLastPage||integer(int32)|integer(int32)|
|navigatePages||integer(int32)|integer(int32)|
|navigatepageNums||array||
|nextPage||integer(int32)|integer(int32)|
|pageNum||integer(int32)|integer(int32)|
|pageSize||integer(int32)|integer(int32)|
|pages||integer(int32)|integer(int32)|
|prePage||integer(int32)|integer(int32)|
|size||integer(int32)|integer(int32)|
|startRow||integer(int64)|integer(int64)|
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"approvalId": "",
"approvalStatus": "",
"billCode": "",
"billMoney": 0,
"billTime": "",
"createBy": 0,
"createTime": "",
"demandSideId": "",
"demandSideName": "",
"id": "",
"orderId": "",
"relatedBelongId": "",
"relatedBelongName": "",
"relatedId": "",
"relatedName": "",
"relatedProType": "",
"relatedType": "",
"settleBelong": "",
"settleVoList": [],
"status": "",
"statusName": "",
"updateBy": 0,
"updateTime": ""
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
}
```
# 需求单controller
## 新增需求单
**接口地址**:`/business/demandOrder/add`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"clueId": "",
"company": "",
"createBy": 0,
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"demandDesc": "",
"demandName": "",
"facilitatorId": "",
"feedback": "",
"fileDtos": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"id": "",
"origin": "",
"phoneNum": "",
"relatedId": "",
"relatedName": "",
"relatedType": "",
"remark": "",
"sellPredict": 0,
"source": "",
"status": "",
"transactionStatus": "",
"updateBy": 0,
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|需求新增对象dto|需求新增对象dto|
|  clueId|关联线索id||false|string||
|  company|公司名称||false|string||
|  createBy|创建人||false|integer(int64)||
|  createTime|创建时间||false|string(date-time)||
|  customerManager|客户经理||false|string||
|  customerManagerId|客户经理id||false|integer(int64)||
|  deleteStatus|逻辑删除:{0不删除1删除}||false|string||
|  demandDesc|需求描述||false|string||
|  demandName|姓名||false|string||
|  facilitatorId|服务商id||false|string||
|  feedback|反馈结果||false|string||
|  fileDtos|附件||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  id|id||false|string||
|  origin|0咪咕商机线索1服务商商机线索||false|string||
|  phoneNum|手机号码||false|string||
|  relatedId|关联id||false|string||
|  relatedName|关联名称||false|string||
|  relatedType|0产品1解决方案||false|string||
|  remark|备注||false|string||
|  sellPredict|销售金额预测||false|number||
|  source|0营销门户创建1系统用户创建||false|string||
|  status|0已提交1跟进中2已完成||false|string||
|  transactionStatus|成交状态 0未完成1已完成||false|string||
|  updateBy|修改人||false|integer(int64)||
|  updateTime|修改时间||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取数据统计列表(0线上 1线下)
**接口地址**:`/business/demandOrder/count/{source}`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|source|source|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|需求单数据统计Vo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|count|数据|string||
|status|0已提交1跟进中2已完成|string||
**响应示例**:
```javascript
[
{
"count": "",
"status": ""
}
]
```
## 客户经理反馈需求单
**接口地址**:`/business/demandOrder/feedback`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"clueId": "",
"company": "",
"createBy": 0,
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"demandDesc": "",
"demandName": "",
"feedback": "",
"id": "",
"phoneNum": "",
"relatedId": "",
"relatedName": "",
"relatedType": "",
"remark": "",
"source": "",
"status": "",
"transactionStatus": "",
"updateBy": 0,
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|客户经理反馈需求单dto|客户经理反馈需求单dto|
|  clueId|关联线索id||false|string||
|  company|公司名称||false|string||
|  createBy|创建人||false|integer(int64)||
|  createTime|创建时间||false|string(date-time)||
|  customerManager|客户经理||false|string||
|  customerManagerId|客户经理id||false|integer(int64)||
|  deleteStatus|逻辑删除:{0不删除1删除}||false|string||
|  demandDesc|需求描述||false|string||
|  demandName|姓名||false|string||
|  feedback|反馈结果||false|string||
|  id|id||false|string||
|  phoneNum|手机号码||false|string||
|  relatedId|关联id||false|string||
|  relatedName|关联名称||false|string||
|  relatedType|0产品1解决方案||false|string||
|  remark|备注||false|string||
|  source|0营销门户创建1系统用户创建||false|string||
|  status|0已提交1跟进中2已完成||false|string||
|  transactionStatus|成交状态 0未完成1已完成||false|string||
|  updateBy|修改人||false|integer(int64)||
|  updateTime|修改时间||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 获取需求单列表
**接口地址**:`/business/demandOrder/list`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|company|公司名称|query|false|string||
|createBy|创建人|query|false|string||
|customerManager|客户经理|query|false|string||
|customerManagerId|客户经理id|query|false|integer(int64)||
|demandName|姓名|query|false|string||
|endTime|创建时间范围止|query|false|string(date-time)||
|origin|0咪咕商机线索1服务商商机线索|query|false|string||
|relatedName|关联名称|query|false|string||
|relatedType|0产品1解决方案|query|false|string||
|source|0营销门户创建1系统用户创建|query|false|string||
|startTime|创建时间范围起|query|false|string(date-time)||
|status|0已提交1跟进中2已完成|query|false|string||
|transactionStatus|成交状态 0未完成1已完成|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|TableDataInfo«需求单表»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|code||integer(int32)|integer(int32)|
|list||array|需求单表|
|  clueId|关联线索id|string||
|  company|公司名称|string||
|  createBy|创建人|integer(int64)||
|  createTime|创建时间|string(date-time)||
|  customerManager|客户经理|string||
|  customerManagerId|客户经理id|integer(int64)||
|  deleteStatus|逻辑删除:{0不删除1删除}|string||
|  demandCode|需求单号 用户ID + 年-月-日+三位序列号|string||
|  demandDesc|需求描述|string||
|  demandName|姓名|string||
|  facilitatorId|服务商id|string||
|  feedback|反馈结果|string||
|  id|id|string||
|  origin|0咪咕商机线索1服务商商机线索|string||
|  phoneNum|手机号码|string||
|  relatedId|关联id|string||
|  relatedName|关联名称|string||
|  relatedType|0产品1解决方案|string||
|  remark|备注|string||
|  sellPredict|销售金额预测|number||
|  source|0营销门户创建1系统用户创建|string||
|  status|0已提交1跟进中2已完成|string||
|  transactionStatus|成交状态 0未完成1已完成|string||
|  updateBy|修改人|integer(int64)||
|  updateTime|修改时间|string(date-time)||
|msg||string||
|total||integer(int64)|integer(int64)|
**响应示例**:
```javascript
{
"code": 0,
"list": [
{
"clueId": "",
"company": "",
"createBy": 0,
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"demandCode": "",
"demandDesc": "",
"demandName": "",
"facilitatorId": "",
"feedback": "",
"id": "",
"origin": "",
"phoneNum": "",
"relatedId": "",
"relatedName": "",
"relatedType": "",
"remark": "",
"sellPredict": 0,
"source": "",
"status": "",
"transactionStatus": "",
"updateBy": 0,
"updateTime": ""
}
],
"msg": "",
"total": 0
}
```
## 获取需求单详情
**接口地址**:`/business/demandOrder/selectOne`
**请求方式**:`GET`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|id|query|false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK|需求单详情Vo|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- |
|clue|关联线索|销售线索表|销售线索表|
|  clueCode|线索ID生成规则xs + 年-月-日-时-分-秒 + 创建人ID|string||
|  createBy||integer(int64)||
|  createTime||string(date-time)||
|  deleteStatus|逻辑删除0未删除1已删除|string||
|  desc|线索描述|string||
|  facilitatorId|服务商id|string||
|  id||string||
|  origin|线索来源0咪咕商机线索1服务商商机线索|string||
|  originUser|线索提供人|string||
|  updateBy||integer(int64)||
|  updateTime||string(date-time)||
|clueId|关联线索id|string||
|cmphoneNumber||string||
|code|需求单号 用户ID + 年-月-日+三位序列号|string||
|company|公司名称|string||
|createBy|创建人|integer(int64)|integer(int64)|
|createTime|创建时间|string(date-time)|string(date-time)|
|customerManager|客户经理|string||
|customerManagerId|客户经理id|integer(int64)|integer(int64)|
|deleteStatus|逻辑删除:{0不删除1删除}|string||
|demandDesc|需求描述|string||
|demandName|姓名|string||
|facilitatorId|服务商id|string||
|feedback|反馈结果|string||
|fileDtos|附件|array|文件表返回VO|
|  dataId|数据id|string||
|  delFlag||string||
|  fileName|文件名称|string||
|  fileOriginName|文件原名称|string||
|  fileSource|文件来源|string||
|  fileUrl|文件地址|string||
|  id|文件ID|string||
|id|id|string||
|origin|0咪咕商机线索1服务商商机线索|string||
|phoneNum|手机号码|string||
|relatedId|关联id|string||
|relatedName|关联名称|string||
|relatedType|0产品1解决方案|string||
|remark|备注|string||
|sellPredict|销售金额预测|number||
|source|0营销门户创建1系统用户创建|string||
|status|0已提交1跟进中2已完成|string||
|transactionStatus|成交状态 0未完成1已完成|string||
|updateBy|修改人|integer(int64)|integer(int64)|
|updateTime|修改时间|string(date-time)|string(date-time)|
**响应示例**:
```javascript
{
"clue": {
"clueCode": "",
"createBy": 0,
"createTime": "",
"deleteStatus": "",
"desc": "",
"facilitatorId": "",
"id": "",
"origin": "",
"originUser": "",
"updateBy": 0,
"updateTime": ""
},
"clueId": "",
"cmphoneNumber": "",
"code": "",
"company": "",
"createBy": 0,
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"demandDesc": "",
"demandName": "",
"facilitatorId": "",
"feedback": "",
"fileDtos": [
{
"dataId": "",
"delFlag": "",
"fileName": "",
"fileOriginName": "",
"fileSource": "",
"fileUrl": "",
"id": ""
}
],
"id": "",
"origin": "",
"phoneNum": "",
"relatedId": "",
"relatedName": "",
"relatedType": "",
"remark": "",
"sellPredict": 0,
"source": "",
"status": "",
"transactionStatus": "",
"updateBy": 0,
"updateTime": ""
}
```
## 创建人修改需求单
**接口地址**:`/business/demandOrder/update`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"clueId": "",
"company": "",
"createBy": 0,
"createTime": "",
"customerManager": "",
"customerManagerId": 0,
"deleteStatus": "",
"demandDesc": "",
"demandName": "",
"facilitatorId": "",
"feedback": "",
"fileDtos": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"id": "",
"origin": "",
"phoneNum": "",
"relatedId": "",
"relatedName": "",
"relatedType": "",
"remark": "",
"sellPredict": 0,
"source": "",
"status": "",
"transactionStatus": "",
"updateBy": 0,
"updateTime": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|需求单修改对象dto|需求单修改对象dto|
|  clueId|关联线索id||false|string||
|  company|公司名称||false|string||
|  createBy|创建人||false|integer(int64)||
|  createTime|创建时间||false|string(date-time)||
|  customerManager|客户经理||false|string||
|  customerManagerId|客户经理id||false|integer(int64)||
|  deleteStatus|逻辑删除:{0不删除1删除}||false|string||
|  demandDesc|需求描述||false|string||
|  demandName|姓名||false|string||
|  facilitatorId|服务商id||false|string||
|  feedback|反馈结果||false|string||
|  fileDtos|附件||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  id|id||false|string||
|  origin|0咪咕商机线索1服务商商机线索||false|string||
|  phoneNum|手机号码||false|string||
|  relatedId|关联id||false|string||
|  relatedName|关联名称||false|string||
|  relatedType|0产品1解决方案||false|string||
|  remark|备注||false|string||
|  sellPredict|销售金额预测||false|number||
|  source|0营销门户创建1系统用户创建||false|string||
|  status|0已提交1跟进中2已完成||false|string||
|  transactionStatus|成交状态 0未完成1已完成||false|string||
|  updateBy|修改人||false|integer(int64)||
|  updateTime|修改时间||false|string(date-time)||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 线下需求单-客户经理编辑需求单
**接口地址**:`/business/demandOrder/updateByCM`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"demandDesc": "",
"feedback": "",
"fileDtos": [
{
"fileName": "",
"fileOriginName": "",
"fileUrl": ""
}
],
"id": "",
"origin": "",
"remark": "",
"sellPredict": 0,
"status": "",
"transactionStatus": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|客户经理编辑需求单对象dto|客户经理编辑需求单对象dto|
|  demandDesc|需求描述||false|string||
|  feedback|反馈结果||false|string||
|  fileDtos|附件||false|array|MiguFileDTO|
|    fileName|文件名称||false|string||
|    fileOriginName|文件原名称||false|string||
|    fileUrl|文件地址||false|string||
|  id|id||false|string||
|  origin|0咪咕商机线索1服务商商机线索||false|string||
|  remark|备注||false|string||
|  sellPredict|销售金额预测||false|number||
|  status|0已提交1跟进中2已完成||false|string||
|  transactionStatus|成交状态 0未完成1已完成||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 分配客户经理
**接口地址**:`/business/demandOrder/updateCM`
**请求方式**:`POST`
**请求数据类型**:`application/json`
**响应数据类型**:`*/*`
**接口描述**:
**请求示例**:
```javascript
{
"customerManagerId": 0,
"id": ""
}
```
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|dto|dto|body|true|分配客户经理dto|分配客户经理dto|
|  customerManagerId|客户经理id||false|integer(int64)||
|  id|id||false|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||
**响应参数**:
暂无
**响应示例**:
```javascript
```
## 删除需求单
**接口地址**:`/business/demandOrder/{ids}`
**请求方式**:`DELETE`
**请求数据类型**:`application/x-www-form-urlencoded`
**响应数据类型**:`*/*`
**接口描述**:
**请求参数**:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|ids|path|true|string||
**响应状态**:
| 状态码 | 说明 | schema |
| -------- | -------- | ----- |
|200|OK||
|204|No Content||
|401|Unauthorized||
|403|Forbidden||
**响应参数**:
暂无
**响应示例**:
```javascript
```