报表
更新时间:2022-11-15
创建报表
接口简介
创建报表
接口详情
请求地址
/openapi/v1/group/{groupKey}/report?__scp__={__scp__}
请求类型
POST
请求参数
Javascript
1{
2 charts: [], // 报表内图表设置
3 conditions: [], // 图表内过滤条件
4 isDev: false, // 是否开发模式
5 isPublic: false, // 空间内是否公开
6 name: "报表创建", // 报表名
7 parentHash: '0', // 父目录 hash(可以通过下方[报表树形目录列表]进行获取,下方type === 0 时即为文件夹目录,其中的hash即为当前的parentHash,在根目录创建时parentHash: '0')
8 remark: "", // 简介
9 type: 1, // 报表类型 0文件夹、1报表页面、2iframe页面
10 url: "" // iframe页面地址
11}
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
charts | Array | 是 | 报表内图表设置(不同图表内的具体配置请参考:图表配置) | - | - |
conditions | Array | 是 | 图表内过滤条件(不同过滤组件配置请参考:过滤组件配置)) | - | - |
isDev | Boolean | 是 | 是否开发模式 | false | false |
isPublic | Boolean | 是 | 空间内是否公开 | false | false |
name | String | 是 | 报表名 | - | - |
parentHash | String | 是 | 父目录 hash(可以通过下方[报表树形目录列表]进行获取,下方type === 0 时即为文件夹目录,其中的hash即为当前的parentHash,在根目录创建时parentHash: '0') | '0' | '0' |
remark | String | 是 | 简介 | - | - |
type | String | 是 | 报表类型 0 文件夹、1 报表页面、2iframe 页面 | 1 | 1 |
url | String | 否 | iframe 页面地址 | - | - |
返回正确 JSON 示例
Javascript
1{
2 data: {
3 authType: 0, // 公开分享状态 0停止分享、1公开分享、2加密公开分享
4 config: {}, // 报表配置信息
5 editable: true, // 是否可编辑
6 hash: "r_ada15-523rmf5c-xm5bym", // 报表hash
7 hierarchyLevel: 1, // 层级level
8 icon: "fa fa-th", // 图标
9 isDev: false, // 是否开发模式
10 isPublic: false, // 是否公开分享
11 name: "报表创建", // 报表名
12 orderIndex: 64, // 同级的顺序编号
13 password: "", // 密码
14 remark: "", // 备注说明
15 source_hash: "", // hash ID
16 token: "", // 分享token
17 type: 1, // 报表类型,0:文件夹 1:报表 2:iframe
18 url: "http://www.baidu.com" // iframe页面地址
19 },
20 msg: '',
21 status: 0
22}
返回错误 JSON 示例
Javascript
1{
2 msg: '错误详情',
3 status: 499
4}
删除报表
接口简介
删除报表
接口详情
请求地址
/openapi/v1/group/{groupKey}/report/{reportHash}?__scp__={__scp__}
请求类型
DELETE
返回正确 JSON 示例
Javascript
1{
2 data: {},
3 msg: '',
4 status: 0
5}
返回错误 JSON 示例
Javascript
1{
2 msg: '错误详情',
3 status: 499
4}
获取报表树形目录列表
接口简介
获取报表树形目录列表
接口详情
请求地址
/openapi/v1/group/{groupKey}/report?__scp__={__scp__}
请求类型
GET
请求参数
无
返回正确 JSON 示例
Javascript
1{
2 data: [
3 {
4 hash: "r_ada15-50z688xs-p284kv",
5 source_hash: "",
6 type: 1,
7 name: "test-report",
8 editable: true,
9 remark: "测试",
10 token: "",
11 hierarchyLevel: 1,
12 orderIndex: 1,
13 isPublic: false,
14 isDev: true,
15 authType: 0
16 },
17 {
18 hash: "r_ada15-6fni6aob-g2vopk", // 报表文件夹hash,可作为[创建报表]接口中parentHash字段的值
19 source_hash: "",
20 type: 0, // 类型:0(文件夹)、1(报表)
21 name: "报表",
22 editable: true,
23 remark: "",
24 token: "",
25 children: [ // 文件夹中包含的报表
26 {
27 hash: "r_ada15-5frjkqkz-9kqezk", // 报表hash
28 source_hash: "",
29 type: 1,
30 name: "时间默认值",
31 editable: true,
32 remark: "",
33 token: "",
34 hierarchyLevel: 2, // 层级深度
35 orderIndex: 1, // 当前数序(在文件夹中第一个)
36 isPublic: false, // 是否公开
37 isDev: false,
38 authType: 0
39 }
40 ],
41 hierarchyLevel: 1,
42 orderIndex: 8,
43 isPublic: false,
44 isDev: false,
45 authType: 0
46 },
47 ],
48 msg: '',
49 status: 0
50}
返回错误 JSON 示例
Javascript
1{
2 msg: '错误详情',
3 status: 499
4}