首页 - 资讯 - 科技 - 教育 - 汽车 - 财经 - 健康 - 房产 - 文旅 - 娱乐 - 游戏
访谈 |股票 |创投人物 |产业 |金融 |维修 |车展 |报价 |行情 |时评 |新车 |数码 |互联网 |名企 |IT业 |能源
当前位置： 首页> 财经> 访谈 > 衡石科技产品手册--BI仪表盘如何配置对接

衡石科技产品手册--BI仪表盘如何配置对接

时间:2025/7/9 3:32:55来源：https://blog.csdn.net/zandy1011/article/details/141723508 浏览次数:0次

仪表盘​

仪表盘说明​

仪表盘 的定义​

仪表盘是由多个图表按照一定的业务逻辑排布形成的数据看板。仪表盘属于一个应用。

仪表盘结构说明​
字段类型描述
appIdLONG仪表盘所属的应用 id
titleSTRING仪表盘标题
optionsOBJECT仪表盘配置信息
options.layoutsMAPkey是图表的id，value是图表的位置 {h: 高度, i: "图表id", w: 宽度, x: x轴位置, y: y轴位置}。高级仪表盘布局中的 w 和 h 都不能小于40
options.filtersHE 数组仪表盘的过滤器
options.typeSTRING仪表盘类型，可用类型： Dashboard，InfoGraphic，Report
options.backgroundImageIdsINTEGER 数组背景图的 id 列表
options.pageOBJECT仪表盘的页面配置
options.configOBJECT前端需要的任意数据，后端只存储，不使用
options.hideBOOLEAN仪表盘隐藏标识,用于表示仪表盘是否处于隐藏状态
hsVersionINTEGER可选，本次编辑的版本号，从0开始，修改前先GET待修改资源获取当前版本号，修改时带上刚刚获取的版本号，服务端会检查并发冲突。不带版本号不检查并发冲突。
仪表盘隐藏说明​

仪表盘可以被设置为隐藏状态,其效果体现在:发布、预览、分享时,被隐藏的仪表盘不可见,且如果直接通过url访问被隐藏的仪表盘,会响应404

接口说明​

新增仪表盘​

新增仪表盘

请求URL​

http

POST /api/apps/${appId}/dashboards HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

1
2
3

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是仪表盘所在的应用 id
Request Body 参数​

仪表盘配置信息，见仪表盘结构

返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT仪表盘的完整配置信息，见仪表盘结构
接口示例1: 新增普通仪表盘​

http

POST /api/apps/1/dashboards HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...// Request Body:
{"title": "新建仪表盘","options": {"type": "Dashboard","charts": [],"filters": [],"layouts": {},"page": {"width": 1280,"height": 800,"padding": [0,0,0,0],"background": "rgba(255, 255, 255, 1)","showGrid": false},"config": {"theme": "CLASSIC","showGrid": false,"background": {"image": "","size": "auto","repeat": "no-repeat","position-x": "left","position-y": "top"},"pc": {"w": 12,"scale": "4*3","gap": 10},"mobile": {"mode": "auto","w": 6,"scale": "1*1","gap": 10}}}
}

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

接口示例1: 新增高级仪表盘​

http

POST /api/apps/1/dashboards HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...// Request Body:
{"title": "新建高级仪表盘","options": {"type": "InfoGraphic","charts": [],"filters": [],"layouts": {},"page": {"width": 1280,"height": 800,"padding": [0,0,0,0],"background": "rgba(255, 255, 255, 1)","showGrid": false}}
}

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

接口示例1: 新增报表类型的仪表盘​

新建报表的时候，后端会同时创建一个复杂表格，并在接口返回中包含复杂表格对应的chart id。

RequestResponse

http

POST /api/apps/1/dashboards?dataAppId=123&datasetId=4 HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...// Request Body:
{"title": "新建报表","options": {"type": "Report","charts": [],"filters": [],"layouts": {}}
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

更新仪表盘​

更新仪表盘的标题或者配置信息。

请求URL​

http

PUT /api/apps/${appId}/dashboards/{dashboardId} HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

1
2
3

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是仪表盘所在的应用 id
dashboardIdINTEGER是仪表盘的 id
Request Body 参数​

仪表盘配置信息，见仪表盘结构

返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT仪表盘的完整配置信息，见仪表盘结构
接口示例1: 修改仪表盘中图表的布局信息​

RequestResponse

http

PUT /api/apps/1/dashboards/1 HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...// Request Body:
{"title": "新建高级仪表盘","hsVersion": 1,"options": {"layouts": {"7": {"h": 68,"i": "7","w": 237,"x": 20,"y": 20,"src": "","link": "","type": "graph","rotate": 0,"zIndex": 10000,"padding": [20,20,20,20],"arrowEnd": "triangle","imageSize": "auto","arrowBegin": "none","arrowStyle": "solid","arrowWidth": 2,"borderColor": "rgba(255, 255, 255, 1)","borderStyle": "solid","borderWidth": 0,"borderRadius": 0,"imagePosition": "center","titlePosition": "left","backgroundColor": "rgba(255, 255, 255, 0)"}},"filters": [],"layoutsVersion": "24*12","backgroundImageIds": [48],"page": {"padding": [0,0,0,0],"background": "rgba(255, 255, 255, 1)","width": 1024,"showGrid": false,"height": 768},"type": "InfoGraphic","charts": [7,8]}
}

通过 ID 获取仪表盘信息​

请求URL​

http

GET /api/apps/${appId}/dashboards/{dashboardId} HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是仪表盘所在的应用 id
dashboardIdINTEGER是仪表盘的 id
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT仪表盘的完整配置信息，见仪表盘结构

通过 ID 删除仪表盘​

请求URL​

http

DELETE /api/apps/${appId}/dashboards/{dashboardId} HTTP/1.1
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

1
2

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是仪表盘所在的应用 id
dashboardIdINTEGER是仪表盘的 id
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
msgSTRING执行成功返回 success

批量更新仪表盘主题配置​

批量更新仪表盘主题配置

请求URL​

http

PUT /api/apps/${appId}/dashboards/update-theme HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是仪表盘所在的应用 id
Request Body 参数​

仪表盘配置信息，见仪表盘结构。这里只有 options -> config -> theme 的配置会被用于批量修改仪表盘，其它信息都被忽略。

返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT返回被更新的仪表盘个数
接口示例1:​

RequestResponse

RequestResponse

http

PUT /api/apps/1/dashboards/update-theme HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...// Request Body:
{"options": {"config": {"theme": "hengshi"}}
}

:::

下载仪表盘中所有图表的聚合数据​

请求URL​

http

GET /api/apps/${apiId}/dashboards/${dashboardId}/download HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是仪表盘所在的应用 id
dashboardIdINTEGER是仪表盘的 id
返回结果​

返回一个excel文件，文件名是仪表盘的名称，excel文件中每个sheet对应一个图表的聚合数据

获取仪表盘列表​

分页查询应用中的仪表盘信息

请求URL​

http

GET /api/apps/{appId}/dashboards HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

1
2
3

请求参数​
URL参数​
字段类型说明
offsetINTEGER可选，分页字段，起始查询位置
limitINTEGER可选，分页字段，查询数量
orderBySTRING可选，排序字段，默认是按照更新时间降序排序
orderTypeSTRING可选，排序类型，asc - 表示升序，desc - 表示降序
queryChartsBOOLEAN可选,默认为false，是否查询仪表盘中的chart信息，true - 查询，false - 不查询
showHideBOOLEAN可选,默认为true，是否查询隐藏仪表盘，true - 查询，false - 不查询
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT指定数量的仪表盘信息
接口示例1​

RequestResponse

http

GET /api/apps/{appId}/dashboards HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

接口示例2​

RequestResponse

http

GET /api/apps/{appId}/dashboards?queryCharts=true HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

接口示例3​

RequestResponse

http

GET /api/apps/{appId}/dashboards?queryCharts=true&showHide=false HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

异步导出仪表盘PNG/PDF​

请求URL​

http

POST /api/apps/{appId}/dashboards/{dashboardId}/async-export HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdLONG是仪表盘所在的应用 id
dashboardIdLONG是仪表盘id
typeSTRING否传png或者pdf
timeoutINTEGER否导出超时时间，timeout内完成，直解返回二进制流下载，timeout未完成或出现异常，返回json信息
widthINTEGER否宽度
heightINTEGER否单页的高度
totalHeightINTEGER否整个页面的总高度
Request Body 参数​

DownloadDto

字段类型是否必须说明
appOBJECT否全局过滤器 见应用结构
dashboardOBJECT否仪表盘过滤器 见仪表盘结构
chartNamesMAP否chart名称map，key为chartId
返回对象的格式说明​

如果导出任务没有完成，返回PENDING状态；若任务已完成，返回png/pdf格式文件流下载，文件名是仪表盘的名称

接口示例1: 导出仪表盘PDF​

http

POST /api/apps/41589/dashboards/1/async-export?type=pdf&timeout=170000 HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...// Request Body:
{"app": {"id": 41589,"options": {"filters": []}},"dashboard": {"id": 1,"options": {"filters": []}}
}

接口示例2: 导出仪表盘PNG​

http

POST /api/apps/41589/dashboards/1/async-export?type=png&timeout=170000&width=1255&height=1049&totalHeight=1295 HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...// Request Body:
{"app": {"id": 41589,"options": {"filters": []}},"dashboard": {"id": 1,"options": {"filters": []}},"chartNames": {"2": "邮寄方式 按 省/自治区","3": "城市 按 省/自治区"}
}

复制仪表盘​

请求URL​

http

POST /api/apps/${appId}/dashboards/{dashboardId}/duplicate HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是仪表盘所在的应用 id
dashboardIdINTEGER是仪表盘的 id
titleSTRING否新仪表盘的标题
Request Body 参数​

只复制仪表盘，不修改的情况下，传空的 json 即可。

返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
msgSTRING执行成功返回 success
关键字：衡石科技产品手册--BI仪表盘如何配置对接

版权声明:

本网仅为发布的内容提供存储空间，不对发表、转载的内容提供任何形式的保证。凡本网注明“来源：XXX网络”的作品，均转载自其它媒体，著作权归作者所有，商业转载请联系作者获得授权，非商业转载请注明出处。

我们尊重并感谢每一位作者，均已注明文章来源和作者。如因作品内容、版权或其它问题，请及时与我们联系，联系邮箱：809451989@qq.com，投稿邮箱：809451989@qq.com

责任编辑：
>> 相关文章
>> 热门图片
小程序外包公司发展前景_优化方案数学2024电子版_成都网络营销搜索推广_百度一下首页登录
小程序外包公司发展前景_优化方案数学2024电子版_成都网络营销搜索推广_百度一下首页登录
官网维护是什么意思_公开招标网站_最新舆情信息网_怎么找到当地的微信推广
官网维护是什么意思_公开招标网站_最新舆情信息网_怎么找到当地的微信推广
手机银行网站建设_广告联盟平台哪个好_网络黄页推广软件哪个好_关键词规划师工具
手机银行网站建设_广告联盟平台哪个好_网络黄页推广软件哪个好_关键词规划师工具
流程图制作网页_简历电子模版免费下载_武汉seo搜索引擎_网络营销活动策划方案模板
流程图制作网页_简历电子模版免费下载_武汉seo搜索引擎_网络营销活动策划方案模板
无锡网站制作优化排名_网页生成app在线_友情链接平台网站_亚马逊站外推广网站
无锡网站制作优化排名_网页生成app在线_友情链接平台网站_亚马逊站外推广网站
seo发展现状_成都教育行业网站建设_百度广告电话号码是多少_百度竞价账户
seo发展现状_成都教育行业网站建设_百度广告电话号码是多少_百度竞价账户
东莞广告设计公司排名_北京实创装修公司官网_无限制访问国外的浏览器_seogw
东莞广告设计公司排名_北京实创装修公司官网_无限制访问国外的浏览器_seogw
有创意的网络公司名字大全_简述网站开发技术_什么是seo技术_公司地址怎么弄在百度上显示
有创意的网络公司名字大全_简述网站开发技术_什么是seo技术_公司地址怎么弄在百度上显示
>> 热门搜索
评论排行
图片新闻
更多>>
少儿编程价格表_常平网站建设_百度百家_百度收录量
衡石科技产品手册--BI仪表盘如何配置对接
东莞建站公司速推全网天下首选_网络建设专业石家庄_市场运营和市场营销的区别_互联网优化是什么意思
初级网络工程师之入门到入狱（一）
点击排行

邮箱：809451989@qq.com 网站地图
未经过本站允许,请勿将本站内容传播或复制