Version | Update Time | Status | Author | Description |
---|---|---|---|---|
v2021-10-18 15:49:47 | 2021-10-18 15:49:47 | auto | @pc | Created by smart-doc |
1. 电力告警
1.1. 查询电力告警总数
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查询电力告警总数
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int32 | 站点id | false | - |
startTime | string | No comments found. | false | - |
endTime | string | No comments found. | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─count | int32 | 电力告警总数 | - |
└─unCount | int32 | 未处理告警总数 | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "2edrpg",
"data": {
"count": 48,
"unCount": 958
},
"exception": "vq1tx9"
}
1.2. 告警趋势图
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 告警趋势图
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
startTime | string | 天数 | true | - |
endTime | string | 结束时间 | true | - |
siteId | int32 | 站点id | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─name | string | 名称 | - |
└─list | object | 数据 | - |
└─any object | object | any object. | - |
└─listDate | object | 时间 | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "vd8zkd",
"data": [
{
"name": "钰轩.彭",
"list": {
"object": "any object"
},
"listDate": {
"object": "any object"
}
}
],
"exception": "8uq9y1"
}
1.3. 分页
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 分页
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
startTime | string | 开始时间 | false | - |
endTime | string | 结束时间 | false | - |
status | int32 | 状态 | false | - |
siteId | int32 | 站点 | false | - |
current | int32 | 页数 | true | - |
size | int32 | 条数 | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int32 | 电力告警表ID | - |
└─deviceCode | string | 阿里云平台设备名称 | - |
└─alarmName | string | 告警名称 | - |
└─sendingTime | string | 发送时间 | - |
└─alarmType | string | 告警类型(alert 告警) | - |
└─measName | string | 测点名称 | - |
└─digitalValue | int32 | 遥信值(0 正常 1 告警) | - |
└─measDesc | string | 测点描述 | - |
└─soeTime | string | 发生时间 | - |
└─handler | string | 处理人 | - |
└─handlingTime | string | 处理时间 | - |
└─handlingContent | string | 处理内容 | - |
└─handlerPhone | string | 联系电话 | - |
└─handlingStatus | int32 | 处理状态(0 未处理,1 已处理) | - |
└─siteId | int32 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─size | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "e9qkoc",
"data": {
"records": [
{
"id": 159,
"deviceCode": "22631",
"alarmName": "钰轩.彭",
"sendingTime": "2021-10-18",
"alarmType": "8cysfo",
"measName": "钰轩.彭",
"digitalValue": 240,
"measDesc": "8s7dqd",
"soeTime": "2021-10-18",
"handler": "0u6l9d",
"handlingTime": "2021-10-18",
"handlingContent": "ddlmoa",
"handlerPhone": "17653999375",
"handlingStatus": 659,
"siteId": 841
}
],
"total": 672,
"size": 618,
"current": 753
},
"exception": "k2rl03"
}
1.4.
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int32 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "2azv5e",
"data": [
{
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
],
"exception": "birz3b"
}
1.5. 导出
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 导出
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
startTime | string | 开始时间 | false | - |
endTime | string | 结束时间 | false | - |
status | int32 | 状态 | false | - |
siteId | int32 | 站点 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "i1qd3y",
"data": "nd2eiw",
"exception": "nwdss7"
}
1.6. 运行状态
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 运行状态
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
startTime | string | 开始时间 | true | - |
endTime | string | 结束时间 | true | - |
siteId | int32 | 站点 | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─name | string | 名称 | - |
└─list | object | 数据 | - |
└─any object | object | any object. | - |
└─listDate | object | 时间 | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "fx06k3",
"data": [
{
"name": "钰轩.彭",
"list": {
"object": "any object"
},
"listDate": {
"object": "any object"
}
}
],
"exception": "jmwlqq"
}
3. 设备
3.1. 查询设备总数
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查询设备总数
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
startTime | string | No comments found. | true | - |
endTime | string | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─normalCount | int32 | 正常 | - |
└─offLineCount | int32 | 离线 | - |
└─faultCount | int32 | 故障 | - |
└─deviceCount | int32 | 告警 | - |
└─count | int32 | 站点数量/设备数量 | - |
└─epCount | int32 | 用电量 | - |
└─videoCount | int32 | 视频量 | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "68h2x4",
"data": {
"normalCount": 850,
"offLineCount": 262,
"faultCount": 340,
"deviceCount": 491,
"count": 13,
"epCount": 921,
"videoCount": 566
},
"exception": "4un0dk"
}
3.2. 查询不同类型的设备数量
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查询不同类型的设备数量
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
site | int32 | 站点id | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─normalCount | int32 | 正常 | - |
└─offLineCount | int32 | 离线 | - |
└─faultCount | int32 | 故障 | - |
└─deviceCount | int32 | 告警 | - |
└─count | int32 | 站点数量/设备数量 | - |
└─epCount | int32 | 用电量 | - |
└─videoCount | int32 | 视频量 | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "xczq74",
"data": {
"normalCount": 306,
"offLineCount": 305,
"faultCount": 627,
"deviceCount": 572,
"count": 714,
"epCount": 467,
"videoCount": 976
},
"exception": "umi90l"
}
3.3.
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Response-example:
[
"yi0wnr",
"urt4vm"
]
3.4.
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | string | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─id | int32 | 设备信息表ID | - |
└─deviceCode | string | 设备编号 | - |
└─deviceName | string | 设备名称 | - |
└─siteId | int32 | 所属站点 | - |
└─deviceAddress | string | 设备安装位置 | - |
└─deviceType | string | 1:183用电设备,2:视频监控设备,3:171用电设备,4:173用电设备,5:158智能网关,6:其他 | - |
└─installTime | string | 安装时间 | - |
└─creator | string | 创建人 | - |
└─enable | int32 | 使能标识(0 不生效,1生效) | - |
└─deviceStatus | int32 | No comments found. | - |
└─installedCapacity | string | 站点里面字段信息 | - |
└─loopMeterAddress | int32 | 回路表计地址 | - |
└─ratedVoltage | double | 额定电压(kv) | - |
└─ratedCurrent | double | 额定电流(A) | - |
└─currentLoadRate | double | 电流负载率门限 | - |
└─monitoringEquipmentNo | string | 监控设备编号 | - |
└─variableListId | int32 | 变量列表id | - |
└─qualityAnalysis | string | 电能质量分析 | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "e89zt8",
"data": [
{
"id": 551,
"deviceCode": "22631",
"deviceName": "钰轩.彭",
"siteId": 625,
"deviceAddress": "黎路5356号, 芜湖, 赣 895892",
"deviceType": "zfbvyi",
"installTime": "2021-10-18",
"creator": "h5qwei",
"enable": 257,
"deviceStatus": 490,
"installedCapacity": "9trcim",
"loopMeterAddress": 406,
"ratedVoltage": 85.73,
"ratedCurrent": 41.12,
"currentLoadRate": 13.00,
"monitoringEquipmentNo": "2j5svo",
"variableListId": 807,
"qualityAnalysis": "fw9zvn"
}
],
"exception": "ogyjsh"
}
5.
5.1.
Type: GET
Author: yq
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Response-example:
Doesn't return a value.
5.2.
Type: GET
Author: yq
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Response-example:
{
}
5.3.
Type: GET
Author: yq
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Response-example:
Doesn't return a value.
5.4.
Type: GET
Author: yq
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
startTime | string | No comments found. | false | - |
endTime | string | No comments found. | false | - |
Response-example:
Doesn't return a value.
5.5.
Type: GET
Author: yq
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
userId | int32 | No comments found. | false | - |
startTime | string | No comments found. | false | - |
endTime | string | No comments found. | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
id | int32 | No comments found. | - |
deviceName | string | 阿里云平台设备名称 | - |
Busot | int32 | 母线停电次数 | - |
cos | double | 三相功率因数 | - |
COSa | double | A相功率因数 | - |
COSb | double | B相功率因数 | - |
COSc | double | C相功率因数 | - |
Demand | double | 实时有功需量 | - |
DevResetTimes | int32 | 设备复位次数 | - |
DeviceTemp | double | 设备温度 | - |
Epn | double | 三相反向有功电度 | - |
Epn1 | double | 尖段反向有功电度 | - |
Epn2 | double | 峰段反向有功电度 | - |
Epn3 | double | 平段反向有功电度 | - |
Epn4 | double | 谷段反向有功电度 | - |
Epp | double | 三相正向有功电度 | - |
Epp1 | double | 尖段正向有功电度 | - |
Epp2 | double | 峰段正向有功电度 | - |
Epp3 | double | 平段正向有功电度 | - |
Epp4 | double | 谷段正向有功电度 | - |
Eqn | double | 三相反向无功电度 | - |
Eqp | double | 三相正向无功电度 | - |
f | double | 频率 | - |
i0 | double | 零序电流 | - |
i2 | double | 负序电流 | - |
IHa | double | A相总谐波电流 | - |
IHb | double | B相总谐波电流 | - |
IHc | double | C相总谐波电流 | - |
Ia | double | A相电流 | - |
Ib | double | B相电流 | - |
Ic | double | C相电流 | - |
Ir | double | 剩余电流 | - |
LastDayMD | double | 昨日有功最大需量 | - |
LastDayMDt | double | 昨日有功最大需量发生时间 | - |
p | double | 三相总有功功率 | - |
Pa | double | A相有功功率 | - |
Pb | double | B相有功功率 | - |
Pc | double | C相有功功率 | - |
q | double | 三相总无功功率 | - |
Qa | double | A相无功功率 | - |
Qb | double | B相无功功率 | - |
Qc | double | C相无功功率 | - |
SignalIntensity | double | 信号强度 | - |
t1 | double | 第1路温度 | - |
t2 | double | 第2路温度 | - |
t3 | double | 第3路温度 | - |
t4 | double | 第4路温度 | - |
THDUa | double | A相电压THD | - |
THDUb | double | B相电压THD | - |
THDUc | double | C相电压THD | - |
Ua | double | A相电压 | - |
Uab | double | AB线电压 | - |
Ub | double | B相电压 | - |
Ubc | double | BC线电压 | - |
UblU0 | double | 零序电压不平衡度 | - |
UblU2 | double | 负序电压不平衡度 | - |
Uc | double | C相电压 | - |
Uca | double | CA线电压 | - |
Udt | int32 | 电压暂降次数 | - |
Ul | double | 线路侧电压 | - |
Upt | int32 | 电压暂升次数 | - |
Ust | int32 | 电压短时中断次数 | - |
freezingTime | string | 冻结时间 | - |
dataTime | string | 上报时间 | - |
Response-example:
[
{
"id": 189,
"deviceName": "钰轩.彭",
"Busot": 467,
"cos": 95.37,
"COSa": 23.05,
"COSb": 0.52,
"COSc": 62.18,
"Demand": 15.43,
"DevResetTimes": 637,
"DeviceTemp": 58.62,
"Epn": 77.67,
"Epn1": 8.07,
"Epn2": 42.91,
"Epn3": 97.45,
"Epn4": 95.08,
"Epp": 25.39,
"Epp1": 39.44,
"Epp2": 97.21,
"Epp3": 1.06,
"Epp4": 8.38,
"Eqn": 81.03,
"Eqp": 58.17,
"f": 22.15,
"i0": 29.79,
"i2": 66.82,
"IHa": 55.37,
"IHb": 71.74,
"IHc": 62.11,
"Ia": 69.16,
"Ib": 28.44,
"Ic": 89.19,
"Ir": 79.98,
"LastDayMD": 56.74,
"LastDayMDt": 13.99,
"p": 60.49,
"Pa": 46.75,
"Pb": 36.67,
"Pc": 50.66,
"q": 81.87,
"Qa": 53.41,
"Qb": 85.32,
"Qc": 57.43,
"SignalIntensity": 71.10,
"t1": 49.71,
"t2": 45.60,
"t3": 84.35,
"t4": 27.12,
"THDUa": 57.90,
"THDUb": 77.91,
"THDUc": 61.31,
"Ua": 88.20,
"Uab": 87.29,
"Ub": 65.91,
"Ubc": 25.56,
"UblU0": 41.17,
"UblU2": 74.43,
"Uc": 94.45,
"Uca": 91.28,
"Udt": 124,
"Ul": 64.48,
"Upt": 742,
"Ust": 381,
"freezingTime": "2021-10-18",
"dataTime": "2021-10-18"
}
]
5.6.
Type: GET
Author: yq
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
id | int32 | No comments found. | - |
deviceName | string | 阿里云平台设备名称 | - |
Busot | int32 | 母线停电次数 | - |
cos | double | 三相功率因数 | - |
COSa | double | A相功率因数 | - |
COSb | double | B相功率因数 | - |
COSc | double | C相功率因数 | - |
Demand | double | 实时有功需量 | - |
DevResetTimes | int32 | 设备复位次数 | - |
DeviceTemp | double | 设备温度 | - |
Epn | double | 三相反向有功电度 | - |
Epn1 | double | 尖段反向有功电度 | - |
Epn2 | double | 峰段反向有功电度 | - |
Epn3 | double | 平段反向有功电度 | - |
Epn4 | double | 谷段反向有功电度 | - |
Epp | double | 三相正向有功电度 | - |
Epp1 | double | 尖段正向有功电度 | - |
Epp2 | double | 峰段正向有功电度 | - |
Epp3 | double | 平段正向有功电度 | - |
Epp4 | double | 谷段正向有功电度 | - |
Eqn | double | 三相反向无功电度 | - |
Eqp | double | 三相正向无功电度 | - |
f | double | 频率 | - |
i0 | double | 零序电流 | - |
i2 | double | 负序电流 | - |
IHa | double | A相总谐波电流 | - |
IHb | double | B相总谐波电流 | - |
IHc | double | C相总谐波电流 | - |
Ia | double | A相电流 | - |
Ib | double | B相电流 | - |
Ic | double | C相电流 | - |
Ir | double | 剩余电流 | - |
LastDayMD | double | 昨日有功最大需量 | - |
LastDayMDt | double | 昨日有功最大需量发生时间 | - |
p | double | 三相总有功功率 | - |
Pa | double | A相有功功率 | - |
Pb | double | B相有功功率 | - |
Pc | double | C相有功功率 | - |
q | double | 三相总无功功率 | - |
Qa | double | A相无功功率 | - |
Qb | double | B相无功功率 | - |
Qc | double | C相无功功率 | - |
SignalIntensity | double | 信号强度 | - |
t1 | double | 第1路温度 | - |
t2 | double | 第2路温度 | - |
t3 | double | 第3路温度 | - |
t4 | double | 第4路温度 | - |
THDUa | double | A相电压THD | - |
THDUb | double | B相电压THD | - |
THDUc | double | C相电压THD | - |
Ua | double | A相电压 | - |
Uab | double | AB线电压 | - |
Ub | double | B相电压 | - |
Ubc | double | BC线电压 | - |
UblU0 | double | 零序电压不平衡度 | - |
UblU2 | double | 负序电压不平衡度 | - |
Uc | double | C相电压 | - |
Uca | double | CA线电压 | - |
Udt | int32 | 电压暂降次数 | - |
Ul | double | 线路侧电压 | - |
Upt | int32 | 电压暂升次数 | - |
Ust | int32 | 电压短时中断次数 | - |
freezingTime | string | 冻结时间 | - |
dataTime | string | 上报时间 | - |
Response-example:
[
{
"id": 926,
"deviceName": "钰轩.彭",
"Busot": 991,
"cos": 78.22,
"COSa": 62.78,
"COSb": 53.00,
"COSc": 98.99,
"Demand": 70.64,
"DevResetTimes": 603,
"DeviceTemp": 48.34,
"Epn": 16.23,
"Epn1": 60.65,
"Epn2": 2.04,
"Epn3": 6.43,
"Epn4": 76.00,
"Epp": 65.32,
"Epp1": 89.24,
"Epp2": 32.12,
"Epp3": 48.37,
"Epp4": 32.87,
"Eqn": 60.03,
"Eqp": 12.61,
"f": 52.72,
"i0": 24.29,
"i2": 24.34,
"IHa": 68.00,
"IHb": 64.40,
"IHc": 16.35,
"Ia": 92.04,
"Ib": 93.24,
"Ic": 33.55,
"Ir": 26.11,
"LastDayMD": 0.61,
"LastDayMDt": 72.31,
"p": 73.31,
"Pa": 83.94,
"Pb": 9.49,
"Pc": 55.45,
"q": 96.70,
"Qa": 29.14,
"Qb": 6.95,
"Qc": 76.46,
"SignalIntensity": 65.20,
"t1": 39.85,
"t2": 72.71,
"t3": 0.79,
"t4": 48.40,
"THDUa": 24.45,
"THDUb": 40.79,
"THDUc": 37.90,
"Ua": 84.79,
"Uab": 95.95,
"Ub": 10.76,
"Ubc": 21.45,
"UblU0": 76.03,
"UblU2": 22.29,
"Uc": 62.81,
"Uca": 59.74,
"Udt": 367,
"Ul": 65.39,
"Upt": 675,
"Ust": 568,
"freezingTime": "2021-10-18",
"dataTime": "2021-10-18"
}
]
6. object
6.1. 查询不同设备的数量
Type: GET
Author: yq
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查询不同设备的数量
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int32 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─name | string | 名称(箱变,杆变,配电) | - |
└─count | int32 | 数量 | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "4gn4be",
"data": [
{
"name": "钰轩.彭",
"count": 614
}
],
"exception": "nd6472"
}
8. 历史消费组模拟量
8.1. 首页日/月/年用电量
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 首页日/月/年用电量
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─dayCount | double | 日用电量 | - |
└─monthCount | double | 月用电量 | - |
└─yearCount | double | 年用电量 | - |
└─lastDayCount | double | 昨天用电量 | - |
└─lastMonthCount | double | 上月用电量 | - |
└─lastYearCount | double | 年用电量 | - |
└─dayRadio | double | 日期比例 | - |
└─monthRadio | double | 月比例 | - |
└─yearRadio | double | 年比例 | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "367t7g",
"data": {
"dayCount": 74.72,
"monthCount": 22.32,
"yearCount": 61.35,
"lastDayCount": 71.23,
"lastMonthCount": 12.33,
"lastYearCount": 98.43,
"dayRadio": 93.04,
"monthRadio": 82.60,
"yearRadio": 28.92
},
"exception": "x3pzax"
}
8.2. 今日/昨日用电趋势
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 今日/昨日用电趋势
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int32 | 站点id | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─name | string | 名称 | - |
└─list | object | 数据 | - |
└─any object | object | any object. | - |
└─listDate | object | 时间 | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "311r90",
"data": [
{
"name": "钰轩.彭",
"list": {
"object": "any object"
},
"listDate": {
"object": "any object"
}
}
],
"exception": "fvkhca"
}
8.3. 当月用电趋势图
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 当月用电趋势图
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─name | string | 名称 | - |
└─list | object | 数据 | - |
└─any object | object | any object. | - |
└─listDate | object | 时间 | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "id8ezy",
"data": [
{
"name": "钰轩.彭",
"list": {
"object": "any object"
},
"listDate": {
"object": "any object"
}
}
],
"exception": "82gq1v"
}
8.4. 站点日/月/年用电量
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 站点日/月/年用电量
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int32 | 站点id | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─dayCount | double | 日用电量 | - |
└─monthCount | double | 月用电量 | - |
└─yearCount | double | 年用电量 | - |
└─lastDayCount | double | 昨天用电量 | - |
└─lastMonthCount | double | 上月用电量 | - |
└─lastYearCount | double | 年用电量 | - |
└─dayRadio | double | 日期比例 | - |
└─monthRadio | double | 月比例 | - |
└─yearRadio | double | 年比例 | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "r1ebmy",
"data": {
"dayCount": 87.24,
"monthCount": 85.34,
"yearCount": 6.34,
"lastDayCount": 75.68,
"lastMonthCount": 22.49,
"lastYearCount": 70.15,
"dayRadio": 32.63,
"monthRadio": 19.06,
"yearRadio": 19.26
},
"exception": "qygl52"
}
8.5. 分时电量
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 分时电量
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int32 | 站点id | true | - |
type | int32 | 时间 | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─need | double | 尖 | - |
└─peak | double | 峰 | - |
└─grain | double | 谷 | - |
└─flat | double | 平 | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "ryo5i4",
"data": {
"need": 78.74,
"peak": 95.02,
"grain": 73.77,
"flat": 23.86
},
"exception": "ru4xi0"
}
8.6. 需量趋势图
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 需量趋势图
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int32 | 站点id | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─name | string | 名称 | - |
└─list | object | 数据 | - |
└─any object | object | any object. | - |
└─listDate | object | 时间 | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "gcrgf1",
"data": [
{
"name": "钰轩.彭",
"list": {
"object": "any object"
},
"listDate": {
"object": "any object"
}
}
],
"exception": "c9gdqp"
}
8.7. 历史记录电流电压
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 历史记录电流电压
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int32 | 站点id | true | - |
date | string | 时间 | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─name | string | 名称 | - |
└─list | object | 数据 | - |
└─any object | object | any object. | - |
└─listDate | object | 时间 | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "01n6hh",
"data": [
{
"name": "钰轩.彭",
"list": {
"object": "any object"
},
"listDate": {
"object": "any object"
}
}
],
"exception": "qvmv0o"
}
10.
10.1.
Type: GET
Author: yq
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
startTime | string | No comments found. | false | - |
endTime | string | No comments found. | false | - |
Response-example:
Doesn't return a value.
11. 人员信息
11.1. 查询不同种类的人员信息
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查询不同种类的人员信息
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─maintain | int32 | 维护人员 | - |
└─power | int32 | 供电 | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "8ovckf",
"data": {
"maintain": 527,
"power": 286
},
"exception": "ujx2of"
}
13. 实时消费组模拟量
13.1. 重载/轻载/正常
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 重载/轻载/正常
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─heavyLoad | double | 重载运行 | - |
└─easyLoad | double | 轻载运行 | - |
└─norMalLoad | double | 正常运行 | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "agb51s",
"data": {
"heavyLoad": 39.01,
"easyLoad": 41.76,
"norMalLoad": 30.49
},
"exception": "ls44lp"
}
13.2. 查看实时数据详情
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查看实时数据详情
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int32 | 站点id | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "ff6yv0",
"data": [
{
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
],
"exception": "dxsum6"
}
13.3. 实时负荷
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 实时负荷
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int32 | 站点id | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "o8ol4g",
"data": "90.00",
"exception": "dv38t5"
}
13.4.
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int32 | No comments found. | true | - |
startTime | string | No comments found. | false | - |
endTime | string | No comments found. | false | - |
queryType | string | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "labqap",
"data": [
{
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
],
"exception": "zxdau3"
}
13.5.
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int32 | No comments found. | true | - |
startTime | string | No comments found. | false | - |
endTime | string | No comments found. | false | - |
queryType | string | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "qi3wwi",
"data": [
{
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
],
"exception": "kses8g"
}
13.6.
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int32 | No comments found. | true | - |
startTime | string | No comments found. | false | - |
endTime | string | No comments found. | false | - |
queryType | string | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "ncdhmw",
"data": "lhn7c3",
"exception": "jxnkld"
}
14. 实时消费组开关
14.1. 查看单个信息
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查看单个信息
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int32 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "lnirbm",
"data": [
{
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
],
"exception": "ykema3"
}
14.2.
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int32 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "nch973",
"data": [
{
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
],
"exception": "bod41s"
}
15. 站点
15.1. 查看不同状态的站点数量
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查看不同状态的站点数量
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─normalCount | int32 | 正常 | - |
└─offLineCount | int32 | 离线 | - |
└─faultCount | int32 | 故障 | - |
└─deviceCount | int32 | 告警 | - |
└─count | int32 | 站点数量/设备数量 | - |
└─epCount | int32 | 用电量 | - |
└─videoCount | int32 | 视频量 | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "pzjkml",
"data": {
"normalCount": 1,
"offLineCount": 571,
"faultCount": 548,
"deviceCount": 983,
"count": 694,
"epCount": 933,
"videoCount": 521
},
"exception": "ws1ppa"
}
15.2. 查看站点列表
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查看站点列表
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
name | string | 名称 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─id | int32 | 站点表ID | - |
└─siteName | string | 站点名称 | - |
└─siteAddress | string | 站点位置 | - |
└─companyCode | int32 | 所属单位 | - |
└─userName | string | 联系人 | - |
└─phone | string | 手机号码 | - |
└─stationAreaId | int32 | 所属台区 | - |
└─routeId | int32 | 所属线路 | - |
└─longitude | string | 经度 | - |
└─latitude | string | 纬度 | - |
└─region | int32 | 所属区域(1 宝山,2 嘉定) | - |
└─createTime | string | 创建时间 | - |
└─creator | string | 创建人 | - |
└─enable | int32 | 使能标识(0 不生效,1 生效) | - |
└─installedCapacity | string | No comments found. | - |
└─groupingId | int32 | 分组ID | - |
└─rheologicalChange | string | 流变变化 | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "kxxwy5",
"data": [
{
"id": 532,
"siteName": "钰轩.彭",
"siteAddress": "黎路5356号, 芜湖, 赣 895892",
"companyCode": 114,
"userName": "钰轩.彭",
"phone": "17653999375",
"stationAreaId": 812,
"routeId": 376,
"longitude": "4yc8b4",
"latitude": "63nggv",
"region": 98,
"createTime": "2021-10-18",
"creator": "rtfc5k",
"enable": 909,
"installedCapacity": "zmqq5n",
"groupingId": 421,
"rheologicalChange": "z87t08"
}
],
"exception": "nuqm8f"
}
15.3.
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
name | string | 站点名称 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─id | int32 | 站点表ID | - |
└─siteName | string | 站点名称 | - |
└─siteAddress | string | 站点位置 | - |
└─companyCode | int32 | 所属单位 | - |
└─userName | string | 联系人 | - |
└─phone | string | 手机号码 | - |
└─stationAreaId | int32 | 所属台区 | - |
└─routeId | int32 | 所属线路 | - |
└─longitude | string | 经度 | - |
└─latitude | string | 纬度 | - |
└─region | int32 | 所属区域(1 宝山,2 嘉定) | - |
└─createTime | string | 创建时间 | - |
└─creator | string | 创建人 | - |
└─enable | int32 | 使能标识(0 不生效,1 生效) | - |
└─deviceCount | int32 | 设备数量 | - |
└─alarmPowerCount | int32 | 告警数 | - |
└─status | string | 站点状态 | - |
└─deviceType | array | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "s0urca",
"data": [
{
"id": 612,
"siteName": "钰轩.彭",
"siteAddress": "黎路5356号, 芜湖, 赣 895892",
"companyCode": 828,
"userName": "钰轩.彭",
"phone": "17653999375",
"stationAreaId": 413,
"routeId": 762,
"longitude": "j8caxc",
"latitude": "ucb3ki",
"region": 132,
"createTime": "2021-10-18",
"creator": "6qt7ne",
"enable": 851,
"deviceCount": 564,
"alarmPowerCount": 623,
"status": "ze9tlf",
"deviceType": [
"qxxsh9"
]
}
],
"exception": "k7y3ta"
}
15.4. 查看站点详情
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查看站点详情
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
siteId | int64 | 站点id | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─id | int32 | 站点表ID | - |
└─siteName | string | 站点名称 | - |
└─siteAddress | string | 站点位置 | - |
└─companyCode | int32 | 所属单位 | - |
└─userName | string | 联系人 | - |
└─phone | string | 手机号码 | - |
└─stationAreaId | int32 | 所属台区 | - |
└─routeId | int32 | 所属线路 | - |
└─longitude | string | 经度 | - |
└─latitude | string | 纬度 | - |
└─region | int32 | 所属区域(1 宝山,2 嘉定) | - |
└─createTime | string | 创建时间 | - |
└─creator | string | 创建人 | - |
└─enable | int32 | 使能标识(0 不生效,1 生效) | - |
└─deviceCount | int32 | 设备数量 | - |
└─alarmPowerCount | int32 | 告警数 | - |
└─status | string | 站点状态 | - |
└─deviceType | array | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "ljpcnc",
"data": {
"id": 713,
"siteName": "钰轩.彭",
"siteAddress": "黎路5356号, 芜湖, 赣 895892",
"companyCode": 76,
"userName": "钰轩.彭",
"phone": "17653999375",
"stationAreaId": 295,
"routeId": 857,
"longitude": "o4cheq",
"latitude": "dhgn9n",
"region": 982,
"createTime": "2021-10-18",
"creator": "4gxqfj",
"enable": 584,
"deviceCount": 408,
"alarmPowerCount": 999,
"status": "qt2bms",
"deviceType": [
"86xl03"
]
},
"exception": "k1x42b"
}
15.5. 查看站点列表
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查看站点列表
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
name | string | 站点名称 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "qscsgg",
"data": [
{
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
],
"exception": "btchrx"
}
15.6.
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id | string | 站点ID | false | - |
siteName | string | 站点名称 | false | - |
siteAddress | string | 站点地址 | false | - |
userName | string | No comments found. | false | - |
phone | string | No comments found. | false | - |
stationAreaId | string | No comments found. | false | - |
routeId | string | No comments found. | false | - |
installedCapacity | string | No comments found. | false | - |
rheologicalChange | string | No comments found. | false | - |
longitude | string | No comments found. | false | - |
latitude | string | No comments found. | false | - |
region | string | No comments found. | false | - |
groupingId | string | No comments found. | false | - |
faultStatus | string | No comments found. | false | - |
realTimeLoad | string | No comments found. | false | - |
totalElectricity | string | No comments found. | false | - |
powerFactor | string | No comments found. | false | - |
siteType | string | No comments found. | false | - |
userCompany | string | No comments found. | false | - |
operationTime | string | No comments found. | false | - |
serviceDeadline | string | No comments found. | false | - |
powerSupplyType | string | No comments found. | false | - |
voltageLevel | string | No comments found. | false | - |
demolitionStandardCoal | string | No comments found. | false | - |
demolitionStandardCoal1 | string | No comments found. | false | - |
sitePictureOne | string | No comments found. | false | - |
sitePictureTwo | string | No comments found. | false | - |
sitePictureThree | string | No comments found. | false | - |
templateId | string | No comments found. | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "q9j8d4",
"data": "",
"exception": "0e168v"
}
15.7.
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id | string | No comments found. | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "ub2kkp",
"data": "",
"exception": "xyxw9u"
}
15.8.
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id | string | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─id | int32 | 站点表ID | - |
└─faultStatus | string | 故障状态 | - |
└─realTimeLoad | string | 实时负荷 | - |
└─totalElectricity | string | 总电量 | - |
└─powerFactor | string | 功率因数 | - |
└─siteId | int32 | 站点id | - |
└─siteType | int32 | 站点类型 | - |
└─userCompany | string | 用户公司 | - |
└─operationTime | string | 投运时间 | - |
└─serviceDeadline | string | 服务截止 | - |
└─powerSupplyType | int32 | 供电类型:1\单路、2\双路 | - |
└─voltageLevel | string | 电压等级 | - |
└─demolitionStandardCoal | int32 | 拆标准煤:1\电力(等价)、2\电力(当量) | - |
└─demolitionStandardCoal1 | string | 拆标准煤 | - |
└─sitePictureOne | string | 站点图片一 | - |
└─sitePictureTwo | string | 站点图片二 | - |
└─sitePictureThree | string | 站点图片三 | - |
└─siteName | string | 站点名称 | - |
└─siteAddress | string | 站点位置 | - |
└─companyCode | int32 | 所属单位 | - |
└─userName | string | 联系人 | - |
└─phone | string | 手机号码 | - |
└─stationAreaId | int32 | 所属台区 | - |
└─routeId | int32 | 所属线路 | - |
└─longitude | string | 经度 | - |
└─latitude | string | 纬度 | - |
└─region | int32 | 所属区域(1 宝山,2 嘉定) | - |
└─enable | int32 | 使能标识(0 不生效,1 生效) | - |
└─installedCapacity | string | No comments found. | - |
└─groupingId | int32 | 分组ID | - |
└─rheologicalChange | string | 流变变化 | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "ng21b7",
"data": [
{
"id": 165,
"faultStatus": "2a3i8r",
"realTimeLoad": "evwkl2",
"totalElectricity": "n8sp18",
"powerFactor": "ur6xyv",
"siteId": 86,
"siteType": 582,
"userCompany": "侯-冯",
"operationTime": "2021-10-18",
"serviceDeadline": "2021-10-18",
"powerSupplyType": 309,
"voltageLevel": "mrir7e",
"demolitionStandardCoal": 825,
"demolitionStandardCoal1": "kda7d0",
"sitePictureOne": "6l30hs",
"sitePictureTwo": "nw1vz3",
"sitePictureThree": "loe124",
"siteName": "钰轩.彭",
"siteAddress": "黎路5356号, 芜湖, 赣 895892",
"companyCode": 959,
"userName": "钰轩.彭",
"phone": "17653999375",
"stationAreaId": 2,
"routeId": 349,
"longitude": "3cyfkf",
"latitude": "j4ldhl",
"region": 628,
"enable": 225,
"installedCapacity": "05z2rv",
"groupingId": 653,
"rheologicalChange": "75bbg1"
}
],
"exception": "ngkbz2"
}
15.9.
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Response-example:
string
18. <p> 前端控制器</p>
18.1.
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
groupingName | string | 站点分组名称 | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "uv562k",
"data": "",
"exception": "agszbw"
}
18.2.
Type: GET
Author: ya
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
groupingName | string | No comments found. | true | - |
id | int32 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "v6hi9z",
"data": "",
"exception": "lavm6m"
}
21. 验证码操作处理
21.1. 生成验证码
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 生成验证码
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "3uom7g",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "nimqmr"
}
22. 参数配置 信息操作处理
22.1. 获取参数配置列表
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取参数配置列表
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
configId | int64 | 参数主键 | false | - |
configName | string | 参数名称 | false | - |
configKey | string | 参数键名 | false | - |
configValue | string | 参数键值 | false | - |
configType | string | 系统内置(Y是 N否) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
total | int64 | 总记录数 | - |
rows | array | 列表数据 | - |
code | int32 | 消息状态码 | - |
msg | string | 消息内容 | - |
Response-example:
{
"total": 152,
"rows": [
{
"object": "any object"
}
],
"code": 660,
"msg": "vevtpb"
}
22.2. 根据参数编号获取详细信息
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 根据参数编号获取详细信息
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
configId | int64 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "hy9obl",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "q4v4x9"
}
22.3. 根据参数键名查询参数值
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 根据参数键名查询参数值
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
configKey | string | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "vjjox6",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "hzvrqf"
}
22.4. 新增参数配置
Type: POST
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 新增参数配置
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
configId | int64 | 参数主键 | false | - |
configName | string | 参数名称 | false | - |
configKey | string | 参数键名 | false | - |
configValue | string | 参数键值 | false | - |
configType | string | 系统内置(Y是 N否) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "s2oskt",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "34b2ap"
}
22.5. 修改参数配置
Type: PUT
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 修改参数配置
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
configId | int64 | 参数主键 | false | - |
configName | string | 参数名称 | false | - |
configKey | string | 参数键名 | false | - |
configValue | string | 参数键值 | false | - |
configType | string | 系统内置(Y是 N否) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "o3e1ua",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "xi0ow0"
}
22.6. 删除参数配置
Type: DELETE
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除参数配置
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
configIds | array | No comments found.,[array of int64] | true |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "togyet",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "17tdxo"
}
22.7. 刷新参数缓存
Type: DELETE
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 刷新参数缓存
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "zghkky",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "lu94j1"
}
23. 部门信息
23.1. 获取部门列表
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取部门列表
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
deptId | int64 | 部门ID | false | - |
parentId | int64 | 父部门ID | false | - |
ancestors | string | 祖级列表 | false | - |
deptName | string | 部门名称 | false | - |
orderNum | string | 显示顺序 | false | - |
leader | string | 负责人 | false | - |
phone | string | 联系电话 | false | - |
string | 邮箱 | false | - | |
status | string | 部门状态:0正常,1停用 | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
parentName | string | 父部门名称 | false | - |
children | array | 子部门 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "69tu0r",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "owop36"
}
23.2. 查询部门列表(排除节点)
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查询部门列表(排除节点)
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
deptId | int64 | No comments found. | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "iwoz0j",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "xww1mh"
}
23.3. 根据部门编号获取详细信息
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 根据部门编号获取详细信息
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
deptId | int64 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "eol4vv",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "8f862q"
}
23.4. 获取部门下拉树列表
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取部门下拉树列表
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
deptId | int64 | 部门ID | false | - |
parentId | int64 | 父部门ID | false | - |
ancestors | string | 祖级列表 | false | - |
deptName | string | 部门名称 | false | - |
orderNum | string | 显示顺序 | false | - |
leader | string | 负责人 | false | - |
phone | string | 联系电话 | false | - |
string | 邮箱 | false | - | |
status | string | 部门状态:0正常,1停用 | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
parentName | string | 父部门名称 | false | - |
children | array | 子部门 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "lhyv06",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "b7iema"
}
23.5. 加载对应角色部门列表树
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 加载对应角色部门列表树
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
roleId | int64 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "3mdwlq",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "0icbyd"
}
23.6. 新增部门
Type: POST
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 新增部门
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
deptId | int64 | 部门ID | false | - |
parentId | int64 | 父部门ID | false | - |
ancestors | string | 祖级列表 | false | - |
deptName | string | 部门名称 | false | - |
orderNum | string | 显示顺序 | false | - |
leader | string | 负责人 | false | - |
phone | string | 联系电话 | false | - |
string | 邮箱 | false | - | |
status | string | 部门状态:0正常,1停用 | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
parentName | string | 父部门名称 | false | - |
children | array | 子部门 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "7viw30",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "39l7c6"
}
23.7. 修改部门
Type: PUT
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 修改部门
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
deptId | int64 | 部门ID | false | - |
parentId | int64 | 父部门ID | false | - |
ancestors | string | 祖级列表 | false | - |
deptName | string | 部门名称 | false | - |
orderNum | string | 显示顺序 | false | - |
leader | string | 负责人 | false | - |
phone | string | 联系电话 | false | - |
string | 邮箱 | false | - | |
status | string | 部门状态:0正常,1停用 | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
parentName | string | 父部门名称 | false | - |
children | array | 子部门 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "mgtebj",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "dbb6hk"
}
23.8. 删除部门
Type: DELETE
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除部门
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
deptId | int64 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "4v4mil",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "9z41mh"
}
24. 数据字典信息
24.1.
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
dictCode | int64 | 字典编码 | false | - |
dictSort | int64 | 字典排序 | false | - |
dictLabel | string | 字典标签 | false | - |
dictValue | string | 字典键值 | false | - |
dictType | string | 字典类型 | false | - |
cssClass | string | 样式属性(其他样式扩展) | false | - |
listClass | string | 表格字典样式 | false | - |
isDefault | string | 是否默认(Y是 N否) | false | - |
status | string | 状态(0正常 1停用) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
total | int64 | 总记录数 | - |
rows | array | 列表数据 | - |
code | int32 | 消息状态码 | - |
msg | string | 消息内容 | - |
Response-example:
{
"total": 641,
"rows": [
{
"object": "any object"
}
],
"code": 48,
"msg": "q72mvq"
}
24.2. 查询字典数据详细
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查询字典数据详细
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
dictCode | int64 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "eo9unr",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "9whsuz"
}
24.3. 根据字典类型查询字典数据信息
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 根据字典类型查询字典数据信息
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
dictType | string | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "q6xrff",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "bkhsaz"
}
24.4. 新增字典类型
Type: POST
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 新增字典类型
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
dictCode | int64 | 字典编码 | false | - |
dictSort | int64 | 字典排序 | false | - |
dictLabel | string | 字典标签 | false | - |
dictValue | string | 字典键值 | false | - |
dictType | string | 字典类型 | false | - |
cssClass | string | 样式属性(其他样式扩展) | false | - |
listClass | string | 表格字典样式 | false | - |
isDefault | string | 是否默认(Y是 N否) | false | - |
status | string | 状态(0正常 1停用) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "6f9bga",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "sqnt4f"
}
24.5. 修改保存字典类型
Type: PUT
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 修改保存字典类型
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
dictCode | int64 | 字典编码 | false | - |
dictSort | int64 | 字典排序 | false | - |
dictLabel | string | 字典标签 | false | - |
dictValue | string | 字典键值 | false | - |
dictType | string | 字典类型 | false | - |
cssClass | string | 样式属性(其他样式扩展) | false | - |
listClass | string | 表格字典样式 | false | - |
isDefault | string | 是否默认(Y是 N否) | false | - |
status | string | 状态(0正常 1停用) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "k1vr6j",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "thfsp1"
}
24.6. 删除字典类型
Type: DELETE
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除字典类型
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
dictCodes | array | No comments found.,[array of int64] | true |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "ggqbr9",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "6nm8jo"
}
25. 数据字典信息
25.1.
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
dictId | int64 | 字典主键 | false | - |
dictName | string | 字典名称 | false | - |
dictType | string | 字典类型 | false | - |
status | string | 状态(0正常 1停用) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
total | int64 | 总记录数 | - |
rows | array | 列表数据 | - |
code | int32 | 消息状态码 | - |
msg | string | 消息内容 | - |
Response-example:
{
"total": 137,
"rows": [
{
"object": "any object"
}
],
"code": 253,
"msg": "33vumk"
}
25.2. 查询字典类型详细
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查询字典类型详细
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
dictId | int64 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "yh57pr",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "o5fpcx"
}
25.3. 新增字典类型
Type: POST
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 新增字典类型
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
dictId | int64 | 字典主键 | false | - |
dictName | string | 字典名称 | false | - |
dictType | string | 字典类型 | false | - |
status | string | 状态(0正常 1停用) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "lyx35a",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "0kmfit"
}
25.4. 修改字典类型
Type: PUT
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 修改字典类型
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
dictId | int64 | 字典主键 | false | - |
dictName | string | 字典名称 | false | - |
dictType | string | 字典类型 | false | - |
status | string | 状态(0正常 1停用) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "ywctge",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "f4ul22"
}
25.5. 删除字典类型
Type: DELETE
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除字典类型
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
dictIds | array | No comments found.,[array of int64] | true |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "gpgn7j",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "hm6e8q"
}
25.6. 刷新字典缓存
Type: DELETE
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 刷新字典缓存
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "6lifsm",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "f9x7es"
}
25.7. 获取字典选择框列表
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取字典选择框列表
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "15g026",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "2w3tb1"
}
26. 登录验证
26.1. 登录方法
Type: POST
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 登录方法
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
username | string | 用户名 | false | - |
password | string | 用户密码 | false | - |
code | string | 验证码 | false | - |
uuid | string | 唯一标识 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "cox870",
"data": "n9je5t",
"exception": "pzj67h"
}
26.2. 获取用户信息
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取用户信息
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "dbsyg2",
"data": {
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
},
"exception": "s4tdtq"
}
26.3. 获取路由信息
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取路由信息
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─name | string | 路由名字 | - |
└─path | string | 路由地址 | - |
└─hidden | boolean | 是否隐藏路由,当设置 true 的时候该路由不会再侧边栏出现 | - |
└─redirect | string | 重定向地址,当设置 noRedirect 的时候该路由在面包屑导航中不可被点击 | - |
└─component | string | 组件地址 | - |
└─alwaysShow | boolean | 当你一个路由下面的 children 声明的路由大于1个时,自动会变成嵌套的模式--如组件页面 | - |
└─meta | object | 其他元素 | - |
└─title | string | 设置该路由在侧边栏和面包屑中展示的名字 | - |
└─icon | string | 设置该路由的图标,对应路径src/assets/icons/svg | - |
└─noCache | boolean | 设置为true,则不会被 | - |
└─link | string | 内链地址(http(s)://开头) | - |
└─children | array | 子路由 | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "k9cf0u",
"data": [
{
"name": "钰轩.彭",
"path": "8gept6",
"hidden": true,
"redirect": "ingihb",
"component": "osdo9n",
"alwaysShow": true,
"meta": {
"title": "5fae1d",
"icon": "kqp30u",
"noCache": true,
"link": "4ikocy"
},
"children": [
{
"$ref": ".."
}
]
}
],
"exception": "c8tmoy"
}
27. 菜单信息
27.1. 获取菜单列表
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取菜单列表
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
menuId | int64 | 菜单ID | false | - |
menuName | string | 菜单名称 | false | - |
parentName | string | 父菜单名称 | false | - |
parentId | int64 | 父菜单ID | false | - |
orderNum | string | 显示顺序 | false | - |
path | string | 路由地址 | false | - |
component | string | 组件路径 | false | - |
isFrame | string | 是否为外链(0是 1否) | false | - |
isCache | string | 是否缓存(0缓存 1不缓存) | false | - |
menuType | string | 类型(M目录 C菜单 F按钮) | false | - |
visible | string | 显示状态(0显示 1隐藏) | false | - |
status | string | 菜单状态(0显示 1隐藏) | false | - |
perms | string | 权限字符串 | false | - |
icon | string | 菜单图标 | false | - |
children | array | 子菜单 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "m8xvfa",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "7c12s2"
}
27.2. 根据菜单编号获取详细信息
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 根据菜单编号获取详细信息
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
menuId | int64 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "y8ee80",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "v2rcpj"
}
27.3. 获取菜单下拉树列表
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取菜单下拉树列表
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
menuId | int64 | 菜单ID | false | - |
menuName | string | 菜单名称 | false | - |
parentName | string | 父菜单名称 | false | - |
parentId | int64 | 父菜单ID | false | - |
orderNum | string | 显示顺序 | false | - |
path | string | 路由地址 | false | - |
component | string | 组件路径 | false | - |
isFrame | string | 是否为外链(0是 1否) | false | - |
isCache | string | 是否缓存(0缓存 1不缓存) | false | - |
menuType | string | 类型(M目录 C菜单 F按钮) | false | - |
visible | string | 显示状态(0显示 1隐藏) | false | - |
status | string | 菜单状态(0显示 1隐藏) | false | - |
perms | string | 权限字符串 | false | - |
icon | string | 菜单图标 | false | - |
children | array | 子菜单 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "nhj5e4",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "wg5ct1"
}
27.4. 加载对应角色菜单列表树
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 加载对应角色菜单列表树
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
roleId | int64 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "r0x9ri",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "74illj"
}
27.5. 新增菜单
Type: POST
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 新增菜单
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
menuId | int64 | 菜单ID | false | - |
menuName | string | 菜单名称 | false | - |
parentName | string | 父菜单名称 | false | - |
parentId | int64 | 父菜单ID | false | - |
orderNum | string | 显示顺序 | false | - |
path | string | 路由地址 | false | - |
component | string | 组件路径 | false | - |
isFrame | string | 是否为外链(0是 1否) | false | - |
isCache | string | 是否缓存(0缓存 1不缓存) | false | - |
menuType | string | 类型(M目录 C菜单 F按钮) | false | - |
visible | string | 显示状态(0显示 1隐藏) | false | - |
status | string | 菜单状态(0显示 1隐藏) | false | - |
perms | string | 权限字符串 | false | - |
icon | string | 菜单图标 | false | - |
children | array | 子菜单 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "y93l4v",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "n7s3oi"
}
27.6. 修改菜单
Type: PUT
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 修改菜单
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
menuId | int64 | 菜单ID | false | - |
menuName | string | 菜单名称 | false | - |
parentName | string | 父菜单名称 | false | - |
parentId | int64 | 父菜单ID | false | - |
orderNum | string | 显示顺序 | false | - |
path | string | 路由地址 | false | - |
component | string | 组件路径 | false | - |
isFrame | string | 是否为外链(0是 1否) | false | - |
isCache | string | 是否缓存(0缓存 1不缓存) | false | - |
menuType | string | 类型(M目录 C菜单 F按钮) | false | - |
visible | string | 显示状态(0显示 1隐藏) | false | - |
status | string | 菜单状态(0显示 1隐藏) | false | - |
perms | string | 权限字符串 | false | - |
icon | string | 菜单图标 | false | - |
children | array | 子菜单 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "hqwhc5",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "482qap"
}
27.7. 删除菜单
Type: DELETE
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除菜单
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
menuId | int64 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "d7m976",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "5kgsac"
}
28. 公告 信息操作处理
28.1. 获取通知公告列表
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取通知公告列表
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
noticeId | int64 | 公告ID | false | - |
noticeTitle | string | 公告标题 | false | - |
noticeType | string | 公告类型(1通知 2公告) | false | - |
noticeContent | string | 公告内容 | false | - |
status | string | 公告状态(0正常 1关闭) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
total | int64 | 总记录数 | - |
rows | array | 列表数据 | - |
code | int32 | 消息状态码 | - |
msg | string | 消息内容 | - |
Response-example:
{
"total": 824,
"rows": [
{
"object": "any object"
}
],
"code": 951,
"msg": "obuc2n"
}
28.2. 根据通知公告编号获取详细信息
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 根据通知公告编号获取详细信息
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
noticeId | int64 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "6iava1",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "9kptf6"
}
28.3. 新增通知公告
Type: POST
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 新增通知公告
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
noticeId | int64 | 公告ID | false | - |
noticeTitle | string | 公告标题 | false | - |
noticeType | string | 公告类型(1通知 2公告) | false | - |
noticeContent | string | 公告内容 | false | - |
status | string | 公告状态(0正常 1关闭) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "e0hm74",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "ld95r3"
}
28.4. 修改通知公告
Type: PUT
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 修改通知公告
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
noticeId | int64 | 公告ID | false | - |
noticeTitle | string | 公告标题 | false | - |
noticeType | string | 公告类型(1通知 2公告) | false | - |
noticeContent | string | 公告内容 | false | - |
status | string | 公告状态(0正常 1关闭) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "krse9w",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "xtdk94"
}
28.5. 删除通知公告
Type: DELETE
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除通知公告
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
noticeIds | array | No comments found.,[array of int64] | true |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "fge95j",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "tqr567"
}
29. 岗位信息操作处理
29.1. 获取岗位列表
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取岗位列表
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
postId | int64 | 岗位序号 | false | - |
postCode | string | 岗位编码 | false | - |
postName | string | 岗位名称 | false | - |
postSort | string | 岗位排序 | false | - |
status | string | 状态(0正常 1停用) | false | - |
flag | boolean | 用户是否存在此岗位标识 默认不存在 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
total | int64 | 总记录数 | - |
rows | array | 列表数据 | - |
code | int32 | 消息状态码 | - |
msg | string | 消息内容 | - |
Response-example:
{
"total": 188,
"rows": [
{
"object": "any object"
}
],
"code": 362,
"msg": "vpsdhh"
}
29.2. 根据岗位编号获取详细信息
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 根据岗位编号获取详细信息
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
postId | int64 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "hiue3c",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "704ltt"
}
29.3. 新增岗位
Type: POST
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 新增岗位
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
postId | int64 | 岗位序号 | false | - |
postCode | string | 岗位编码 | false | - |
postName | string | 岗位名称 | false | - |
postSort | string | 岗位排序 | false | - |
status | string | 状态(0正常 1停用) | false | - |
flag | boolean | 用户是否存在此岗位标识 默认不存在 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "f355ur",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "sm5cfo"
}
29.4. 修改岗位
Type: PUT
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 修改岗位
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
postId | int64 | 岗位序号 | false | - |
postCode | string | 岗位编码 | false | - |
postName | string | 岗位名称 | false | - |
postSort | string | 岗位排序 | false | - |
status | string | 状态(0正常 1停用) | false | - |
flag | boolean | 用户是否存在此岗位标识 默认不存在 | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "ktpofj",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "tark4l"
}
29.5. 删除岗位
Type: DELETE
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除岗位
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
postIds | array | No comments found.,[array of int64] | true |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "jiwtwn",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "arm4a5"
}
29.6. 获取岗位选择框列表
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取岗位选择框列表
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "yr9bhy",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "zr187p"
}
30. 个人信息 业务处理
30.1. 个人信息
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 个人信息
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "zcahno",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "k7pxbz"
}
30.2. 修改用户
Type: PUT
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 修改用户
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
userId | int64 | 用户ID | false | - |
deptId | int64 | 部门ID | false | - |
userName | string | 用户账号 | false | - |
nickName | string | 用户昵称 | false | - |
string | 用户邮箱 | false | - | |
phonenumber | string | 手机号码 | false | - |
sex | string | 用户性别 | false | - |
avatar | string | 用户头像 | false | - |
password | string | 密码 | false | - |
salt | string | 盐加密 | false | - |
status | string | 帐号状态(0正常 1停用) | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
loginIp | string | 最后登录IP | false | - |
loginDate | string | 最后登录时间 | false | - |
dept | object | 部门对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─deptId | int64 | 部门ID | false | - |
└─parentId | int64 | 父部门ID | false | - |
└─ancestors | string | 祖级列表 | false | - |
└─deptName | string | 部门名称 | false | - |
└─orderNum | string | 显示顺序 | false | - |
└─leader | string | 负责人 | false | - |
└─phone | string | 联系电话 | false | - |
string | 邮箱 | false | - | |
└─status | string | 部门状态:0正常,1停用 | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─parentName | string | 父部门名称 | false | - |
└─children | array | 子部门 | false | - |
roles | array | 角色对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─roleId | int64 | 角色ID | false | - |
└─roleName | string | 角色名称 | false | - |
└─roleKey | string | 角色权限 | false | - |
└─roleSort | string | 角色排序 | false | - |
└─dataScope | string | 数据范围(1:所有数据权限;2:自定义数据权限;3:本部门数据权限;4:本部门及以下数据权限;5:仅本人数据权限) | false | - |
└─menuCheckStrictly | boolean | 菜单树选择项是否关联显示( 0:父子不互相关联显示 1:父子互相关联显示) | false | - |
└─deptCheckStrictly | boolean | 部门树选择项是否关联显示(0:父子不互相关联显示 1:父子互相关联显示 ) | false | - |
└─status | string | 角色状态(0正常 1停用) | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─flag | boolean | 用户是否存在此角色标识 默认不存在 | false | - |
└─menuIds | array | 菜单组 | false | - |
└─deptIds | array | 部门组(数据权限) | false | - |
roleIds | array | 角色组 | false | - |
postIds | array | 岗位组 | false | - |
roleId | int64 | 角色ID | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "iwvdmu",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "a8vu23"
}
30.3. 重置密码
Type: PUT
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 重置密码
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
oldPassword | string | No comments found. | false | - |
newPassword | string | No comments found. | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "p6bn99",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "gjah45"
}
31. 角色信息
31.1.
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
roleId | int64 | 角色ID | false | - |
roleName | string | 角色名称 | false | - |
roleKey | string | 角色权限 | false | - |
roleSort | string | 角色排序 | false | - |
dataScope | string | 数据范围(1:所有数据权限;2:自定义数据权限;3:本部门数据权限;4:本部门及以下数据权限;5:仅本人数据权限) | false | - |
menuCheckStrictly | boolean | 菜单树选择项是否关联显示( 0:父子不互相关联显示 1:父子互相关联显示) | false | - |
deptCheckStrictly | boolean | 部门树选择项是否关联显示(0:父子不互相关联显示 1:父子互相关联显示 ) | false | - |
status | string | 角色状态(0正常 1停用) | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
flag | boolean | 用户是否存在此角色标识 默认不存在 | false | - |
menuIds | array | 菜单组 | false | - |
deptIds | array | 部门组(数据权限) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
total | int64 | 总记录数 | - |
rows | array | 列表数据 | - |
code | int32 | 消息状态码 | - |
msg | string | 消息内容 | - |
Response-example:
{
"total": 682,
"rows": [
{
"object": "any object"
}
],
"code": 192,
"msg": "5n3ej3"
}
31.2. 根据角色编号获取详细信息
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 根据角色编号获取详细信息
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
roleId | int64 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "e24uw1",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "girjpl"
}
31.3. 新增角色
Type: POST
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 新增角色
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
roleId | int64 | 角色ID | false | - |
roleName | string | 角色名称 | false | - |
roleKey | string | 角色权限 | false | - |
roleSort | string | 角色排序 | false | - |
dataScope | string | 数据范围(1:所有数据权限;2:自定义数据权限;3:本部门数据权限;4:本部门及以下数据权限;5:仅本人数据权限) | false | - |
menuCheckStrictly | boolean | 菜单树选择项是否关联显示( 0:父子不互相关联显示 1:父子互相关联显示) | false | - |
deptCheckStrictly | boolean | 部门树选择项是否关联显示(0:父子不互相关联显示 1:父子互相关联显示 ) | false | - |
status | string | 角色状态(0正常 1停用) | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
flag | boolean | 用户是否存在此角色标识 默认不存在 | false | - |
menuIds | array | 菜单组 | false | - |
deptIds | array | 部门组(数据权限) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "vr0xrj",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "pvfx69"
}
31.4. 修改保存角色
Type: PUT
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 修改保存角色
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
roleId | int64 | 角色ID | false | - |
roleName | string | 角色名称 | false | - |
roleKey | string | 角色权限 | false | - |
roleSort | string | 角色排序 | false | - |
dataScope | string | 数据范围(1:所有数据权限;2:自定义数据权限;3:本部门数据权限;4:本部门及以下数据权限;5:仅本人数据权限) | false | - |
menuCheckStrictly | boolean | 菜单树选择项是否关联显示( 0:父子不互相关联显示 1:父子互相关联显示) | false | - |
deptCheckStrictly | boolean | 部门树选择项是否关联显示(0:父子不互相关联显示 1:父子互相关联显示 ) | false | - |
status | string | 角色状态(0正常 1停用) | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
flag | boolean | 用户是否存在此角色标识 默认不存在 | false | - |
menuIds | array | 菜单组 | false | - |
deptIds | array | 部门组(数据权限) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "wb769z",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "avgl9c"
}
31.5. 修改保存数据权限
Type: PUT
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 修改保存数据权限
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
roleId | int64 | 角色ID | false | - |
roleName | string | 角色名称 | false | - |
roleKey | string | 角色权限 | false | - |
roleSort | string | 角色排序 | false | - |
dataScope | string | 数据范围(1:所有数据权限;2:自定义数据权限;3:本部门数据权限;4:本部门及以下数据权限;5:仅本人数据权限) | false | - |
menuCheckStrictly | boolean | 菜单树选择项是否关联显示( 0:父子不互相关联显示 1:父子互相关联显示) | false | - |
deptCheckStrictly | boolean | 部门树选择项是否关联显示(0:父子不互相关联显示 1:父子互相关联显示 ) | false | - |
status | string | 角色状态(0正常 1停用) | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
flag | boolean | 用户是否存在此角色标识 默认不存在 | false | - |
menuIds | array | 菜单组 | false | - |
deptIds | array | 部门组(数据权限) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "6l9sz9",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "gdlgcj"
}
31.6. 状态修改
Type: PUT
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 状态修改
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
roleId | int64 | 角色ID | false | - |
roleName | string | 角色名称 | false | - |
roleKey | string | 角色权限 | false | - |
roleSort | string | 角色排序 | false | - |
dataScope | string | 数据范围(1:所有数据权限;2:自定义数据权限;3:本部门数据权限;4:本部门及以下数据权限;5:仅本人数据权限) | false | - |
menuCheckStrictly | boolean | 菜单树选择项是否关联显示( 0:父子不互相关联显示 1:父子互相关联显示) | false | - |
deptCheckStrictly | boolean | 部门树选择项是否关联显示(0:父子不互相关联显示 1:父子互相关联显示 ) | false | - |
status | string | 角色状态(0正常 1停用) | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
flag | boolean | 用户是否存在此角色标识 默认不存在 | false | - |
menuIds | array | 菜单组 | false | - |
deptIds | array | 部门组(数据权限) | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "y6pb23",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "apcvun"
}
31.7. 删除角色
Type: DELETE
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除角色
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
roleIds | array | No comments found.,[array of int64] | true |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "d49zsc",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "wx2boo"
}
31.8. 获取角色选择框列表
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取角色选择框列表
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "i7wtax",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "o6nnnz"
}
31.9. 查询已分配用户角色列表
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查询已分配用户角色列表
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
userId | int64 | 用户ID | false | - |
deptId | int64 | 部门ID | false | - |
userName | string | 用户账号 | false | - |
nickName | string | 用户昵称 | false | - |
string | 用户邮箱 | false | - | |
phonenumber | string | 手机号码 | false | - |
sex | string | 用户性别 | false | - |
avatar | string | 用户头像 | false | - |
password | string | 密码 | false | - |
salt | string | 盐加密 | false | - |
status | string | 帐号状态(0正常 1停用) | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
loginIp | string | 最后登录IP | false | - |
loginDate | string | 最后登录时间 | false | - |
dept | object | 部门对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─deptId | int64 | 部门ID | false | - |
└─parentId | int64 | 父部门ID | false | - |
└─ancestors | string | 祖级列表 | false | - |
└─deptName | string | 部门名称 | false | - |
└─orderNum | string | 显示顺序 | false | - |
└─leader | string | 负责人 | false | - |
└─phone | string | 联系电话 | false | - |
string | 邮箱 | false | - | |
└─status | string | 部门状态:0正常,1停用 | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─parentName | string | 父部门名称 | false | - |
└─children | array | 子部门 | false | - |
roles | array | 角色对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─roleId | int64 | 角色ID | false | - |
└─roleName | string | 角色名称 | false | - |
└─roleKey | string | 角色权限 | false | - |
└─roleSort | string | 角色排序 | false | - |
└─dataScope | string | 数据范围(1:所有数据权限;2:自定义数据权限;3:本部门数据权限;4:本部门及以下数据权限;5:仅本人数据权限) | false | - |
└─menuCheckStrictly | boolean | 菜单树选择项是否关联显示( 0:父子不互相关联显示 1:父子互相关联显示) | false | - |
└─deptCheckStrictly | boolean | 部门树选择项是否关联显示(0:父子不互相关联显示 1:父子互相关联显示 ) | false | - |
└─status | string | 角色状态(0正常 1停用) | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─flag | boolean | 用户是否存在此角色标识 默认不存在 | false | - |
└─menuIds | array | 菜单组 | false | - |
└─deptIds | array | 部门组(数据权限) | false | - |
roleIds | array | 角色组 | false | - |
postIds | array | 岗位组 | false | - |
roleId | int64 | 角色ID | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
total | int64 | 总记录数 | - |
rows | array | 列表数据 | - |
code | int32 | 消息状态码 | - |
msg | string | 消息内容 | - |
Response-example:
{
"total": 129,
"rows": [
{
"object": "any object"
}
],
"code": 276,
"msg": "50qxdv"
}
31.10. 查询未分配用户角色列表
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查询未分配用户角色列表
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
userId | int64 | 用户ID | false | - |
deptId | int64 | 部门ID | false | - |
userName | string | 用户账号 | false | - |
nickName | string | 用户昵称 | false | - |
string | 用户邮箱 | false | - | |
phonenumber | string | 手机号码 | false | - |
sex | string | 用户性别 | false | - |
avatar | string | 用户头像 | false | - |
password | string | 密码 | false | - |
salt | string | 盐加密 | false | - |
status | string | 帐号状态(0正常 1停用) | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
loginIp | string | 最后登录IP | false | - |
loginDate | string | 最后登录时间 | false | - |
dept | object | 部门对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─deptId | int64 | 部门ID | false | - |
└─parentId | int64 | 父部门ID | false | - |
└─ancestors | string | 祖级列表 | false | - |
└─deptName | string | 部门名称 | false | - |
└─orderNum | string | 显示顺序 | false | - |
└─leader | string | 负责人 | false | - |
└─phone | string | 联系电话 | false | - |
string | 邮箱 | false | - | |
└─status | string | 部门状态:0正常,1停用 | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─parentName | string | 父部门名称 | false | - |
└─children | array | 子部门 | false | - |
roles | array | 角色对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─roleId | int64 | 角色ID | false | - |
└─roleName | string | 角色名称 | false | - |
└─roleKey | string | 角色权限 | false | - |
└─roleSort | string | 角色排序 | false | - |
└─dataScope | string | 数据范围(1:所有数据权限;2:自定义数据权限;3:本部门数据权限;4:本部门及以下数据权限;5:仅本人数据权限) | false | - |
└─menuCheckStrictly | boolean | 菜单树选择项是否关联显示( 0:父子不互相关联显示 1:父子互相关联显示) | false | - |
└─deptCheckStrictly | boolean | 部门树选择项是否关联显示(0:父子不互相关联显示 1:父子互相关联显示 ) | false | - |
└─status | string | 角色状态(0正常 1停用) | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─flag | boolean | 用户是否存在此角色标识 默认不存在 | false | - |
└─menuIds | array | 菜单组 | false | - |
└─deptIds | array | 部门组(数据权限) | false | - |
roleIds | array | 角色组 | false | - |
postIds | array | 岗位组 | false | - |
roleId | int64 | 角色ID | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
total | int64 | 总记录数 | - |
rows | array | 列表数据 | - |
code | int32 | 消息状态码 | - |
msg | string | 消息内容 | - |
Response-example:
{
"total": 81,
"rows": [
{
"object": "any object"
}
],
"code": 788,
"msg": "69vpr2"
}
31.11. 取消授权用户
Type: PUT
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 取消授权用户
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
userId | int64 | 用户ID | false | - |
roleId | int64 | 角色ID | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "tdk3ez",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "fr9iek"
}
31.12. 批量取消授权用户
Type: PUT
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 批量取消授权用户
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
roleId | int64 | No comments found. | false | - |
userIds | array | No comments found.,[array of int64] | false |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "izj8bt",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "v06nlm"
}
31.13. 批量选择用户授权
Type: PUT
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 批量选择用户授权
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
roleId | int64 | No comments found. | false | - |
userIds | array | No comments found.,[array of int64] | false |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "26wjo5",
"data": {
"waring": "You may have used non-display generics."
},
"exception": "ygeudk"
}
32. 用户信息
32.1. 获取用户列表
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取用户列表
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
userId | int64 | 用户ID | false | - |
deptId | int64 | 部门ID | false | - |
userName | string | 用户账号 | false | - |
nickName | string | 用户昵称 | false | - |
string | 用户邮箱 | false | - | |
phonenumber | string | 手机号码 | false | - |
sex | string | 用户性别 | false | - |
avatar | string | 用户头像 | false | - |
password | string | 密码 | false | - |
salt | string | 盐加密 | false | - |
status | string | 帐号状态(0正常 1停用) | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
loginIp | string | 最后登录IP | false | - |
loginDate | string | 最后登录时间 | false | - |
dept | object | 部门对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─deptId | int64 | 部门ID | false | - |
└─parentId | int64 | 父部门ID | false | - |
└─ancestors | string | 祖级列表 | false | - |
└─deptName | string | 部门名称 | false | - |
└─orderNum | string | 显示顺序 | false | - |
└─leader | string | 负责人 | false | - |
└─phone | string | 联系电话 | false | - |
string | 邮箱 | false | - | |
└─status | string | 部门状态:0正常,1停用 | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─parentName | string | 父部门名称 | false | - |
└─children | array | 子部门 | false | - |
roles | array | 角色对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─roleId | int64 | 角色ID | false | - |
└─roleName | string | 角色名称 | false | - |
└─roleKey | string | 角色权限 | false | - |
└─roleSort | string | 角色排序 | false | - |
└─dataScope | string | 数据范围(1:所有数据权限;2:自定义数据权限;3:本部门数据权限;4:本部门及以下数据权限;5:仅本人数据权限) | false | - |
└─menuCheckStrictly | boolean | 菜单树选择项是否关联显示( 0:父子不互相关联显示 1:父子互相关联显示) | false | - |
└─deptCheckStrictly | boolean | 部门树选择项是否关联显示(0:父子不互相关联显示 1:父子互相关联显示 ) | false | - |
└─status | string | 角色状态(0正常 1停用) | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─flag | boolean | 用户是否存在此角色标识 默认不存在 | false | - |
└─menuIds | array | 菜单组 | false | - |
└─deptIds | array | 部门组(数据权限) | false | - |
roleIds | array | 角色组 | false | - |
postIds | array | 岗位组 | false | - |
roleId | int64 | 角色ID | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─total | int64 | 总记录数 | - |
└─rows | array | 列表数据 | - |
└─code | int32 | 消息状态码 | - |
└─msg | string | 消息内容 | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "r9hbx4",
"data": {
"total": 564,
"rows": [
{
"object": "any object"
}
],
"code": 407,
"msg": "io1hw9"
},
"exception": "ab0nf6"
}
32.2. 根据用户编号获取详细信息
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 根据用户编号获取详细信息
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
userId | int64 | No comments found. | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "u4gqj1",
"data": {
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
},
"exception": "5yoxka"
}
32.3. 新增用户
Type: POST
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 新增用户
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
userId | int64 | 用户ID | false | - |
deptId | int64 | 部门ID | false | - |
userName | string | 用户账号 | false | - |
nickName | string | 用户昵称 | false | - |
string | 用户邮箱 | false | - | |
phonenumber | string | 手机号码 | false | - |
sex | string | 用户性别 | false | - |
avatar | string | 用户头像 | false | - |
password | string | 密码 | false | - |
salt | string | 盐加密 | false | - |
status | string | 帐号状态(0正常 1停用) | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
loginIp | string | 最后登录IP | false | - |
loginDate | string | 最后登录时间 | false | - |
dept | object | 部门对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─deptId | int64 | 部门ID | false | - |
└─parentId | int64 | 父部门ID | false | - |
└─ancestors | string | 祖级列表 | false | - |
└─deptName | string | 部门名称 | false | - |
└─orderNum | string | 显示顺序 | false | - |
└─leader | string | 负责人 | false | - |
└─phone | string | 联系电话 | false | - |
string | 邮箱 | false | - | |
└─status | string | 部门状态:0正常,1停用 | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─parentName | string | 父部门名称 | false | - |
└─children | array | 子部门 | false | - |
roles | array | 角色对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─roleId | int64 | 角色ID | false | - |
└─roleName | string | 角色名称 | false | - |
└─roleKey | string | 角色权限 | false | - |
└─roleSort | string | 角色排序 | false | - |
└─dataScope | string | 数据范围(1:所有数据权限;2:自定义数据权限;3:本部门数据权限;4:本部门及以下数据权限;5:仅本人数据权限) | false | - |
└─menuCheckStrictly | boolean | 菜单树选择项是否关联显示( 0:父子不互相关联显示 1:父子互相关联显示) | false | - |
└─deptCheckStrictly | boolean | 部门树选择项是否关联显示(0:父子不互相关联显示 1:父子互相关联显示 ) | false | - |
└─status | string | 角色状态(0正常 1停用) | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─flag | boolean | 用户是否存在此角色标识 默认不存在 | false | - |
└─menuIds | array | 菜单组 | false | - |
└─deptIds | array | 部门组(数据权限) | false | - |
roleIds | array | 角色组 | false | - |
postIds | array | 岗位组 | false | - |
roleId | int64 | 角色ID | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "svga2p",
"data": "",
"exception": "ekbjxn"
}
32.4. 修改用户
Type: PUT
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 修改用户
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
userId | int64 | 用户ID | false | - |
deptId | int64 | 部门ID | false | - |
userName | string | 用户账号 | false | - |
nickName | string | 用户昵称 | false | - |
string | 用户邮箱 | false | - | |
phonenumber | string | 手机号码 | false | - |
sex | string | 用户性别 | false | - |
avatar | string | 用户头像 | false | - |
password | string | 密码 | false | - |
salt | string | 盐加密 | false | - |
status | string | 帐号状态(0正常 1停用) | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
loginIp | string | 最后登录IP | false | - |
loginDate | string | 最后登录时间 | false | - |
dept | object | 部门对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─deptId | int64 | 部门ID | false | - |
└─parentId | int64 | 父部门ID | false | - |
└─ancestors | string | 祖级列表 | false | - |
└─deptName | string | 部门名称 | false | - |
└─orderNum | string | 显示顺序 | false | - |
└─leader | string | 负责人 | false | - |
└─phone | string | 联系电话 | false | - |
string | 邮箱 | false | - | |
└─status | string | 部门状态:0正常,1停用 | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─parentName | string | 父部门名称 | false | - |
└─children | array | 子部门 | false | - |
roles | array | 角色对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─roleId | int64 | 角色ID | false | - |
└─roleName | string | 角色名称 | false | - |
└─roleKey | string | 角色权限 | false | - |
└─roleSort | string | 角色排序 | false | - |
└─dataScope | string | 数据范围(1:所有数据权限;2:自定义数据权限;3:本部门数据权限;4:本部门及以下数据权限;5:仅本人数据权限) | false | - |
└─menuCheckStrictly | boolean | 菜单树选择项是否关联显示( 0:父子不互相关联显示 1:父子互相关联显示) | false | - |
└─deptCheckStrictly | boolean | 部门树选择项是否关联显示(0:父子不互相关联显示 1:父子互相关联显示 ) | false | - |
└─status | string | 角色状态(0正常 1停用) | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─flag | boolean | 用户是否存在此角色标识 默认不存在 | false | - |
└─menuIds | array | 菜单组 | false | - |
└─deptIds | array | 部门组(数据权限) | false | - |
roleIds | array | 角色组 | false | - |
postIds | array | 岗位组 | false | - |
roleId | int64 | 角色ID | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "7wmpc4",
"data": "",
"exception": "87rsht"
}
32.5. 删除用户
Type: DELETE
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除用户
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
userIds | array | No comments found.,[array of int64] | true |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "zog8s8",
"data": "",
"exception": "3b5lcv"
}
32.6. 重置密码
Type: PUT
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 重置密码
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
userId | int64 | 用户ID | false | - |
deptId | int64 | 部门ID | false | - |
userName | string | 用户账号 | false | - |
nickName | string | 用户昵称 | false | - |
string | 用户邮箱 | false | - | |
phonenumber | string | 手机号码 | false | - |
sex | string | 用户性别 | false | - |
avatar | string | 用户头像 | false | - |
password | string | 密码 | false | - |
salt | string | 盐加密 | false | - |
status | string | 帐号状态(0正常 1停用) | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
loginIp | string | 最后登录IP | false | - |
loginDate | string | 最后登录时间 | false | - |
dept | object | 部门对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─deptId | int64 | 部门ID | false | - |
└─parentId | int64 | 父部门ID | false | - |
└─ancestors | string | 祖级列表 | false | - |
└─deptName | string | 部门名称 | false | - |
└─orderNum | string | 显示顺序 | false | - |
└─leader | string | 负责人 | false | - |
└─phone | string | 联系电话 | false | - |
string | 邮箱 | false | - | |
└─status | string | 部门状态:0正常,1停用 | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─parentName | string | 父部门名称 | false | - |
└─children | array | 子部门 | false | - |
roles | array | 角色对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─roleId | int64 | 角色ID | false | - |
└─roleName | string | 角色名称 | false | - |
└─roleKey | string | 角色权限 | false | - |
└─roleSort | string | 角色排序 | false | - |
└─dataScope | string | 数据范围(1:所有数据权限;2:自定义数据权限;3:本部门数据权限;4:本部门及以下数据权限;5:仅本人数据权限) | false | - |
└─menuCheckStrictly | boolean | 菜单树选择项是否关联显示( 0:父子不互相关联显示 1:父子互相关联显示) | false | - |
└─deptCheckStrictly | boolean | 部门树选择项是否关联显示(0:父子不互相关联显示 1:父子互相关联显示 ) | false | - |
└─status | string | 角色状态(0正常 1停用) | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─flag | boolean | 用户是否存在此角色标识 默认不存在 | false | - |
└─menuIds | array | 菜单组 | false | - |
└─deptIds | array | 部门组(数据权限) | false | - |
roleIds | array | 角色组 | false | - |
postIds | array | 岗位组 | false | - |
roleId | int64 | 角色ID | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "yiqdud",
"data": "",
"exception": "m370o3"
}
32.7. 状态修改
Type: PUT
Author: ruoyi
Content-Type: application/json; charset=utf-8
Description: 状态修改
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
searchValue | string | 搜索值 | false | - |
createBy | string | 创建者 | false | - |
createTime | string | 创建时间 | false | - |
updateBy | string | 更新者 | false | - |
updateTime | string | 更新时间 | false | - |
remark | string | 备注 | false | - |
params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
userId | int64 | 用户ID | false | - |
deptId | int64 | 部门ID | false | - |
userName | string | 用户账号 | false | - |
nickName | string | 用户昵称 | false | - |
string | 用户邮箱 | false | - | |
phonenumber | string | 手机号码 | false | - |
sex | string | 用户性别 | false | - |
avatar | string | 用户头像 | false | - |
password | string | 密码 | false | - |
salt | string | 盐加密 | false | - |
status | string | 帐号状态(0正常 1停用) | false | - |
delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
loginIp | string | 最后登录IP | false | - |
loginDate | string | 最后登录时间 | false | - |
dept | object | 部门对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─deptId | int64 | 部门ID | false | - |
└─parentId | int64 | 父部门ID | false | - |
└─ancestors | string | 祖级列表 | false | - |
└─deptName | string | 部门名称 | false | - |
└─orderNum | string | 显示顺序 | false | - |
└─leader | string | 负责人 | false | - |
└─phone | string | 联系电话 | false | - |
string | 邮箱 | false | - | |
└─status | string | 部门状态:0正常,1停用 | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─parentName | string | 父部门名称 | false | - |
└─children | array | 子部门 | false | - |
roles | array | 角色对象 | false | - |
└─searchValue | string | 搜索值 | false | - |
└─createBy | string | 创建者 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateBy | string | 更新者 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─remark | string | 备注 | false | - |
└─params | map | 请求参数 | false | - |
└─any object | object | any object. | false | - |
└─roleId | int64 | 角色ID | false | - |
└─roleName | string | 角色名称 | false | - |
└─roleKey | string | 角色权限 | false | - |
└─roleSort | string | 角色排序 | false | - |
└─dataScope | string | 数据范围(1:所有数据权限;2:自定义数据权限;3:本部门数据权限;4:本部门及以下数据权限;5:仅本人数据权限) | false | - |
└─menuCheckStrictly | boolean | 菜单树选择项是否关联显示( 0:父子不互相关联显示 1:父子互相关联显示) | false | - |
└─deptCheckStrictly | boolean | 部门树选择项是否关联显示(0:父子不互相关联显示 1:父子互相关联显示 ) | false | - |
└─status | string | 角色状态(0正常 1停用) | false | - |
└─delFlag | string | 删除标志(0代表存在 2代表删除) | false | - |
└─flag | boolean | 用户是否存在此角色标识 默认不存在 | false | - |
└─menuIds | array | 菜单组 | false | - |
└─deptIds | array | 部门组(数据权限) | false | - |
roleIds | array | 角色组 | false | - |
postIds | array | 岗位组 | false | - |
roleId | int64 | 角色ID | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "mmqv2b",
"data": "",
"exception": "6akznm"
}
32.8. 根据用户编号获取授权角色
Type: GET
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 根据用户编号获取授权角色
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
userId | int64 | No comments found. | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
└─any object | object | any object. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "963rfk",
"data": {
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
},
"exception": "xc8pqx"
}
32.9. 用户授权角色
Type: PUT
Author: ruoyi
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 用户授权角色
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
userId | int64 | No comments found. | false | - |
roleIds | array | No comments found.,[array of int64] | false |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
status | object | No comments found. | - |
code | string | No comments found. | - |
msg | string | No comments found. | - |
data | object | No comments found. | - |
exception | string | No comments found. | - |
Response-example:
{
"status": {
},
"code": "22631",
"msg": "af50sy",
"data": "",
"exception": "wgvlqw"
}
33. 用户
33.1.
Type: POST
Author: ya
Content-Type: application/json; charset=utf-8
Description:
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id | int32 | 用户账号表ID | false | - |
userName | string | 用户名称 | false | - |
userPassword | string | 用户密码 | false | - |
accountContact | string | 账号联系人 | false | - |
contactPhone | string | 联系电话 | false | - |
createTime | string | 创建时间 | false | - |
creator | string | 创建人 | false | - |
enable | int32 | 使能标识(0 不生效,1 生效) | false | - |
Response-example:
Doesn't return a value.