ThingsKitAppearance
报表分页 ¶
接口地址:/api/yt/report_form/config{?endTime,name,orderFiled,orderType,organizationId,page,pageSize,startTime,status}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 |
|---|---|---|---|
| page | page | true | int |
| pageSize | pageSize | true | int |
| name | name | false | string |
| organizationId | organizationId | false | string |
| status | status | false | integer(int32) |
| startTime | startTime | false | integer(int64) |
| endTime | endTime | false | integer(int64) |
| orderFiled | orderFiled | false | string |
| orderType | orderType,可用值:ASC,DESC | false | string |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| items | array | |
| createTime | 创建时间 | string(date-time) |
| createUserName | 创建用户名称 | string |
| creator | 创建用户 | string |
| cycle | 周期参数 | CycleParameterDTO |
| currentCycle | 当前周期 | string |
| cycleTime | 时间 | string |
| cycleType | 周期类型：0每日 1每周 2每月 | integer |
| dataType | 数据类型：0原始数据 1聚合数据 | integer(int32) |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| enabled | 租户状态：启用/禁用 | boolean |
| executeAttributes | 执行设备及属性 | array |
| attributes | 执行属性 | array |
| device | 执行设备 | string |
| name | 设备名称 | string |
| executeContent | cron表达式 | string |
| executeWay | 执行方式：0立即执行 1定时执行 | integer(int32) |
| icon | 租户图标 | string |
| id | ID | string |
| name | 报表配置名称 | string |
| organizationDTO | 组织信息 | OrganizationDTO |
| children | 子集 | array |
| createTime | 创建时间 | string |
| creator | 创建用户 | string |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| enabled | 租户状态：启用/禁用 | boolean |
| icon | 租户图标 | string |
| id | ID | string |
| name | 组织名称 | string |
| parentId | 组织父ID | string |
| remark | 备注 | string |
| roleIds | 租户角色列表 | array |
| sort | 排序 | integer |
| tenantExpireTime | 租户到期时间 | string |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string |
| updater | 更新用户 | string |
| organizationId | 组织ID | string |
| queryCondition | 查询条件 | 查询条件 |
| agg | 聚合条件：AVG, COUNT, MAX, MIN, NONE, SUM,可用值:AVG,COUNT,MAX,MIN,NONE,SUM | string |
| endTs | 结束时间:单位毫秒 | integer |
| interval | 聚合间隔:单位毫秒，默认0 | integer |
| limit | 查询的最大数量：该参数仅在'agg'参数设置为'NONE'的情况下使用，默认100 | integer |
| orderBy | 排序：ASC, DESC 默认DESC | string |
| queryMode | 查询方式:0 周期查询 1自定查询 | integer |
| startTs | 开始时间:单位毫秒 | integer |
| useStrictDataTypes | 启用/禁用遥测值到字符串的转换。默认情况下启用转换。设置参数为'true'以禁用转换 | boolean |
| remark | 配置状态:0禁用 1启用 | string |
| roleIds | 租户角色列表 | array |
| status | 配置状态:0禁用 1启用 | integer(int32) |
| tenantExpireTime | 租户到期时间 | string(date-time) |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
| total | integer(int32) |
响应示例:
javascript
{
"items": [
{
"createTime": "",
"createUserName": "",
"creator": "",
"cycle": {
"currentCycle": "",
"cycleTime": "",
"cycleType": 0
},
"dataType": 0,
"defaultConfig": "",
"description": "",
"enabled": false,
"executeAttributes": [
{
"attributes": [],
"device": "",
"name": ""
}
],
"executeContent": "",
"executeWay": 0,
"icon": "",
"id": "",
"name": "",
"organizationDTO": {
"children": [
{
"children": [
{}
],
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"enabled": false,
"icon": "",
"id": "",
"name": "",
"parentId": "",
"remark": "",
"roleIds": [],
"sort": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
],
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"enabled": false,
"icon": "",
"id": "",
"name": "",
"parentId": "",
"remark": "",
"roleIds": [],
"sort": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
},
"organizationId": "",
"queryCondition": {
"agg": "",
"endTs": 0,
"interval": 0,
"limit": 0,
"orderBy": "",
"queryMode": 0,
"startTs": 0,
"useStrictDataTypes": false
},
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
],
"total": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
报表导出删除 ¶
接口地址:/api/yt/report/generate/record
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
请求示例:
javascript
{
"ids": [],
"tenantId": ""
}
1
2
3
4
2
3
4
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| deleteDTO | DeleteDTO | body | true | DeleteDTO |
| ids | 删除ID列表 | true | array | |
| tenantId | 租户ID | false | string |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| code | integer(int32) | |
| data | boolean | |
| message | string |
响应示例:
javascript
{
"code": 0,
"data": true,
"message": ""
}
1
2
3
4
5
2
3
4
5
报表导出分页 ¶
接口地址:/api/yt/report/generate/record{?endTime,executeStatus,orderFiled,orderType,page,pageSize,reportConfigName,startTime}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 |
|---|---|---|---|
| page | page | true | int |
| pageSize | pageSize | true | int |
| reportConfigName | reportConfigName | false | string |
| executeStatus | executeStatus | false | integer(int32) |
| startTime | startTime | false | integer(int64) |
| endTime | endTime | false | integer(int64) |
| orderFiled | orderFiled | false | string |
| orderType | orderType,可用值:ASC,DESC | false | string |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| items | array | |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| dataCompare | 数据对比：0历史数据 1环比 2同比 | integer(int32) |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| enabled | 租户状态：启用/禁用 | boolean |
| executeCondition | 执行条件 | JsonNode |
| executeStatus | 执行状态：0失败 1成功 2执行中 | integer(int32) |
| executeTime | 执行时间 | string(date-time) |
| executeWay | 执行方式：0立即执行 1定时执行 | integer(int32) |
| icon | 租户图标 | string |
| id | ID | string |
| jobId | 定时任务ID | string |
| name | 租户名称 | string |
| organizationId | 组织ID | string |
| organizationName | 组织名称 | string |
| reportConfigName | 报表配置名称 | string |
| reportPath | 报表导出地址 | string |
| roleIds | 租户角色列表 | array |
| tenantExpireTime | 租户到期时间 | string(date-time) |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
| total | integer(int32) |
响应示例:
javascript
{
"items": [
{
"createTime": "",
"creator": "",
"dataCompare": 0,
"defaultConfig": "",
"description": "",
"enabled": false,
"executeCondition": {},
"executeStatus": 0,
"executeTime": "",
"executeWay": 0,
"icon": "",
"id": "",
"jobId": "",
"name": "",
"organizationId": "",
"organizationName": "",
"reportConfigName": "",
"reportPath": "",
"roleIds": [],
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
],
"total": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32