142 lines
3.3 KiB
Markdown
142 lines
3.3 KiB
Markdown
|
# 首页
|
||
|
|
|
||
|
|
## API接口-报表模板
|
||
|
|
|
||
|
|
| 接口分类 | 接口描述 | API接口 | 权限 |
|
||
|
|
|----------|--------------------|------------------------------| ---------------------------- |
|
||
|
|
| 2.1 报表模板 | 2.1.1 新增报表模板 | /api/report/template/add | SYS_AUTHORITY_ID_DEVICE_CTRL |
|
||
|
|
| | 2.1.2 根据模板分类查询模板列表 | /api/report/template/getList | |
|
||
|
|
| | 2.1.3 删除报表模板 | /api/report/template/del | SYS_AUTHORITY_ID_DEVICE_CTRL|
|
||
|
|
|
||
|
|
|
||
|
|
## 2.1 报表模板相关接口
|
||
|
|
|
||
|
|
### 2.1.1 新增报表模板
|
||
|
|
|
||
|
|
POST 请求接口
|
||
|
|
|
||
|
|
> /api/report/template/add
|
||
|
|
|
||
|
|
请求参数
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"category": "单机报表",
|
||
|
|
"template": "{\"name\":\"测试模板1\",\"startTime\":\"2024-11-04 14:15:00\"}"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
入参描述
|
||
|
|
|
||
|
|
| 参数名 | 参数类型 | 可选 | 描述 |
|
||
|
|
| ------------ |--------|----|------------------|
|
||
|
|
| category | String | NO | 报表分类；如:单机报表；多机报表 |
|
||
|
|
| template | String | NO | 模板内容(必须为:JSON格式) |
|
||
|
|
|
||
|
|
返回报文
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"code": 200,
|
||
|
|
"success": true,
|
||
|
|
"data": {
|
||
|
|
"id": "1853330292178747393",
|
||
|
|
"category": "单机报表",
|
||
|
|
"template": "{\"name\":\"测试模板1\",\"startTime\":\"2024-11-04 14:15:00\"}"
|
||
|
|
},
|
||
|
|
"msg": "操作成功"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
返参描述
|
||
|
|
|
||
|
|
| 参数名 | 参数类型 | 可选 | 描述 |
|
||
|
|
| ------------ |--------| ---- |--------|
|
||
|
|
| category | String | 否 | 报表分类 |
|
||
|
|
| template | String | 否 | 模板内容 |
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### 2.1.2 根据模板分类查询模板列表
|
||
|
|
|
||
|
|
POST 请求接口
|
||
|
|
|
||
|
|
> /api/report/template/getList
|
||
|
|
|
||
|
|
请求参数
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"category": "单机报表",
|
||
|
|
"pageNum":1,
|
||
|
|
"pageSize":2
|
||
|
|
}
|
||
|
|
```
|
||
|
|
入参描述
|
||
|
|
|
||
|
|
| 参数名 | 参数类型 | 可选 | 描述 |
|
||
|
|
| ------------ |---------|-----|------------------|
|
||
|
|
| category | String | YES | 报表分类；如:单机报表；多机报表 |
|
||
|
|
| pageNum | Integer | NO | 当前页 |
|
||
|
|
| pageSize | Integer | NO | 每页显示大小|
|
||
|
|
|
||
|
|
返回报文
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"code": 200,
|
||
|
|
"success": true,
|
||
|
|
"data": {
|
||
|
|
"total": 3,
|
||
|
|
"rows": [
|
||
|
|
{
|
||
|
|
"id": "1853320886498217986",
|
||
|
|
"category": "单机报表",
|
||
|
|
"template": "{\"name\":\"测试模板2\",\"startTime\":\"2024-11-04 14:15:00\"}"
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "1853328049337548801",
|
||
|
|
"category": "单机报表",
|
||
|
|
"template": "{\"name\":\"测试模板3\",\"startTime\":\"2024-11-04 14:15:00\"}"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"code": 200,
|
||
|
|
"msg": "查询成功"
|
||
|
|
},
|
||
|
|
"msg": "操作成功"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
返参描述
|
||
|
|
|
||
|
|
| 参数名 | 参数类型 | 可选 | 描述 |
|
||
|
|
| ------------ |--------| ---- |--------|
|
||
|
|
| category | String | 否 | 报表分类 |
|
||
|
|
| template | String | 否 | 模板内容 |
|
||
|
|
|
||
|
|
### 2.1.3 删除报表模板
|
||
|
|
|
||
|
|
POST 请求接口
|
||
|
|
|
||
|
|
> /api/report/template/del
|
||
|
|
|
||
|
|
请求参数
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"id": "1853320886498217986"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
入参描述
|
||
|
|
|
||
|
|
| 参数名 | 参数类型 | 可选 | 描述 |
|
||
|
|
| ------------ | -------- | ---- |------------------------------------------------------------------|
|
||
|
|
| id | String | no | 报表模板id |
|
||
|
|
|
||
|
|
返回报文
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"code": 200,
|
||
|
|
"success": true,
|
||
|
|
"msg": "操作成功"
|
||
|
|
}
|
||
|
|
```
|