|
<< Click to Display Table of Contents >> 资源相关复制链接 |
1. 数据连接
•新建数据源
支持的版本：7.1.3及以后。
URL：http://ip:port/bi/Viewer?proc=0&action=conn&operate=newConn&assetType=XXX
通过此URL可以新建某个具体类型的数据源，assetType可以为空，默认选中下拉的第一个数据源类型GENERIC
assetType也可以指定某个具体的数据源类型，可选值为：GENERIC，ACCESS，ANALYTICDB, CLICKHOUSE, CTSDB, DAMENG，DB2，DERBY，ELASTIC SEARCH, ,FUSIONINSIGHT ELK, FUSIONINSIGHT HD, GAUSSDB 100, GAUSSDB 200, GBASE8A, GREENPLUM, HAHA，HBASE，HIVE，HUAWEICLOUD DWS, IMPALA，INFORMIX，KINGBASE，KYLIN，MAXCOMPUTER, MONGO，MYSQL，NEO4J, OCEANBASE，ORACLE，ORACLE，ESSBASE，POSTGRESQL，PRESTO，RESTful, SAP BW，SPARK，SQLSERVER，SSAS，SYBASE IQ，TBDS，TBDS OLAP，TERADATA，TRANSWARP，VERTICA。
例如：http://ip:port/bi/Viewer?proc=0&action=conn&operate=newConn&assetType=MYSQL
•编辑数据源
支持的版本：7.1.3及以后。编辑某个已经存在的数据源。
URL：http://ip:port/bi/Viewer?proc=0&action=conn&operate=openConn&assetPath=XXX
assetPath：数据源的完整路径。
•新建数据集
URL：http://ip:port/bi/Viewer?proc=0&action=query&operate=newQuery&assetType=XXX
assetType：指定数据集类型，支持的值参考下图的数据集缩略名。
数据集类型 |
数据集缩略名 |
SQL数据集 |
sqry |
Mongo数据集 |
mgqry |
Excel数据集 |
xlqry |
组合数据集 |
cmqry |
数据集市数据集 |
clqry |
内嵌数据集 |
eqry |
定制数据集 |
cqry |
自服务数据集 |
fqry |
Neo4j数据集 |
neoqry |
多维数据集 |
mdxqry |
流式数据集 |
stqry |
RESTful数据集 |
rfqry |
数据模型 |
dmqry |
•新建数据集指定参数
支持的版本：10.2及以后
可通过url传递参数，例如：http://ip:port/bi/Viewer?proc=0&action=query&operate=newQuery&assetType=XXX&testparam=test
•打开数据集
支持的版本：10.0及以后
URL：http://ip:port/bi/Viewer?proc=0&action=query&operate=openQry&assetID=XXX
或
URL：http://ip:port/bi/Viewer?proc=0&action=query&operate=openQry&assetPath=XXX&assetType=XXX
assetID：数据集ID。
assetPath：数据集路径。
assetType：指定数据集类型，参考“新建数据集”中的表对应的数据集缩略名。
当同时输入assetPath=XXX（路径）和assetID=XXXXXX时，优先获取该路径的数据集。
•打开数据集指定参数
支持的版本：10.2及以后
可通过url传递参数，例如：http://ip:port/bi/Viewer?proc=0&action=query&operate=openQry&assetPath=XXX&assetType=XXX&testparam=test
2. 报告
2.1 分析报告
•新建分析报告
支持的版本：7.1.3及以后。
URL：http://ip:port/bi/Viewer?proc=0&action=editor&createNewDb=true&dbtype=db
•新建分析报告指定参数
支持的版本：10.2及以后。
URL：http://ip:port/bi/Viewer?proc=0&action=editor&createNewDb=true&dbtype=db&testparam=test
•新建分析报告指定绑定的数据集
支持的版本：9.4及以后。
URL：http://ip:port/bi/Viewer?proc=0&action=editor&createNewDb=true&dbtype=db&defQuery=XXX&type=XXX
defQuery：数据集路径
type：数据集类型，参考上方数据集缩略名。
例如：http://ip:port:8093/bi/Viewer?proc=0&action=editor&createNewDb=true&dbtype=db&defQuery=coffee&type=sqry
•打开报告文件夹
支持的版本：7.0及以后。
URL：http://ip:port/bi/Viewer?proc=0&action=viewerManager&keepFolder=false&dbf=XXX
dbf：输入文件夹路径。
当查看报告为图标模式时，可以直接进入某个指定的文件夹下。
•编辑报告中打开分析报告
URL：http://ip:port/bi/Viewer?proc=0&action=editor&db=XXX.db
db：报告的完整路径。打开根目录/folder1下的db1为folder1/db1.db。我的报告路径为：__MY_DB__，打开我的报告下的db1为__MY_DB__/db1.db
•编辑报告中指定参数打开分析报告
支持的版本：10.2及以后。
URL：http://ip:port/bi/Viewer?proc=0&action=editor&db=XXX.db&testparam=test
•查看报告中打开分析报告
URL：http://ip:port/bi/Viewer?proc=1&action=viewer&db=XXX.db
10.0及以后还支持URL为：
http://ip:port/bi/Viewer?proc=1&action=viewer&assetID=XXXXXX
当同时输入db=XXX.db（路径）和assetID=XXXXXX时，优先获取该路径的报告。
如果报告中带有参数，可以在URL里指定参数名和参数值，多个参数值用!a!分割。
例如：http://ip:port/bi/Viewer?proc=1&action=viewer&hback=true&db=db1.db&a=Amaretto!a!Caffe%20Latte
给参数a传参，参数值为：Amaretto，Caffe Latte
•打开作为链接的分析报告
http://ip:port/bi/Viewer?proc=1&action=viewer&hback=true&db=XXX.dblink
db：链接报告的完整路径。
•以元数据模式打开分析报告
支持的版本：9.2及以后。
http://ip:port/bi/Viewer?proc=1&action=viewer&db=XXX.db&mode=meta
•输出分析报告
URL：http://ip:port/bi/Viewer?proc=1&action=viewer&export=XXX&db=XXX.db
export：输出的文件类型，可选值为pdf，excel，csv，word，image。
db：报告的完整路径。
如果报告中带有参数，可以在URL里指定参数名和参数值，多个参数值用!a!分割。
•查看报告时，切换分析报告主题
支持的版本：9.3及以后。
URL：http://ip:port/bi/Viewer?proc=1&action=viewer&type=system&theme=XXX&db=XXX.db
type：主题的类型，可选值：system（系统主题）、custom（自定义主题）。
theme：主题的名字。系统主题有：Classic Grey、Classic Grey、Forest Green、Ice Blue、Macaron、Moon Blue、Ocean Blue、Secret Blue、Silver Grey、Silver Moonligh、Simple Black、Sunny Orange。自定义主题：自定义的主题名字。
•在H5页面中打开分析报告
支持直接集成H5的分析报告到第三方系统
URL：http://ip:port/bi/Viewer#/DBViewer/xxx.db
ip：服务器的ip地址。
port：端口号。
xxx.db：报告的全路径。
➢例如：
_Mobile_case_file__!2f!__Business_financial_situation__.db。
报告全路径的获取方式有以下两种：
•在PC端打开一个报告，点击鼠标右键，选择复制链接，在链接中找到db=xxxx.db
•在手机浏览器上登录，打开一个报告，复制报告的链接，在链接中找到DBViewer/xxx.db。也可以直接用手机浏览器的链接集成。
2.2 大屏报告
•新建大屏报告
支持的版本：10.1及以后
URL：http://ip:port/bi/Viewer?proc=0&action=editor&createNewDb=true&dbType=vividdb
•新建大屏报告并指定参数
支持的版本：10.2及以后
URL：http://ip:port/bi/Viewer?proc=0&action=editor&createNewDb=true&dbType=vividdb&testparam=test
•新建大屏报告并指定分析的数据集
支持的版本：10.1及以后
URL：http://ip:port/bi/Viewer?proc=0&action=editor&createNewDb=true&dbType=vividdb&defQuery=XXX&type=XXX
defQuery：数据集路径。
type：数据集类型，数据集缩略名。
•编辑报告中打开大屏分析报告
支持的版本：10.1及以后
http://ip:port/bi/Viewer?proc=0&action=editor&db=XXX.vividdb
db：报告的完整路径。打开根目录/folder1下的db1为folder1/db1.vividdb。我的报告路径为：__MY_DB__，打开我的报告下的db1为__MY_DB__/db1.vividdb
如果报告中带有参数，可以在URL里指定参数名和参数值，多个参数值用!a!分割。
•编辑报告中指定参数打开大屏分析报告
支持的版本：10.2及以后
URL：http://ip:port/bi/Viewer?proc=0&action=editor&db=XXX.vividdb&testparam=test
•查看报告中打开大屏报告
支持的版本：10.1及以后
http://ip:port/bi/Viewer?proc=1&action=viewer&db=XXX.vividdb
http://ip:port/bi/Viewer?proc=1&action=viewer&assetID=XXXXXX
当同时输入db=XXX.vividdb和assetID=XXXXXX时，优先获取该路径的大屏报告。
如果大屏报告中带有参数，可以在URL里指定参数名和参数值，多个参数值用!a!分割。
•打开作为链接的大屏分析报告
支持的版本：10.1及以后
URL：http://ip:port/bi/Viewer?proc=1&action=viewer&hback=true&db=XXX.vividdblink
db：链接报告的完整路径。
•输出大屏报告
支持的版本：10.1及以后
URL：http://ip:port/bi/Viewer?proc=1&action=viewer&export=XXX&db=XXX.vividdb
export：输出的文件类型，可选值为pdf，excel，csv，word，image。
db：报告的完整路径。
如果报告中带有参数，可以在URL里指定参数名和参数值，多个参数值用!a!分割。
•查看报告时，切换大屏报告主题
支持的版本：10.1及以后
URL：http://ip:port/bi/Viewer?proc=1&action=viewer&type=system&theme=XXX&db=XXX.vividdb
type：主题的类型，可选值：system（系统主题）、custom（自定义主题）。
theme：主题的名字。系统主题有：Classic Grey、Classic Grey、Forest Green、Ice Blue、Macaron、Moon Blue、Ocean Blue、Secret Blue、Silver Grey、Silver Moonligh、Simple Black、Sunny Orange。自定义主题：自定义的主题名字。
2.3 即席分析报告
•新建即席分析报告
支持的版本：10.1及以后
URL：http://ip:port/bi/Viewer?proc=0&action=editor&createNewDb=true&dbType=adb
•新建即席分析报告并指定参数
支持的版本：10.2及以后
URL：http://ip:port/bi/Viewer?proc=0&action=editor&createNewDb=true&dbType=adb&testparam=test
•新建即席分析报告并指定分析的数据集
支持的版本：10.1及以后
URL：http://ip:port/bi/Viewer?proc=0&action=editor&createNewDb=true&dbType=adb&defQuery=XXX&type=XXX
defQuery：数据集路径。
type：数据集类型，数据集缩略名。
•编辑报告中打开即席分析报告
支持的版本：10.1及以后
http://ip:port/bi/Viewer?proc=0&action=editor&db=XXX.adb
db：报告的完整路径。打开根目录/folder1下的db1为folder1/db1.adb。我的报告路径为：__MY_DB__，打开我的报告下的db1为__MY_DB__/db1.adb
如果报告中带有参数，可以在URL里指定参数名和参数值，多个参数值用!a!分割。
•编辑报告中指定参数打开即席分析报告
支持的版本：10.2及以后
URL：http://ip:port/bi/Viewer?proc=0&action=editor&db=XXX.adb&testparam=test
•查看报告中打开即席分析报告
支持的版本：10.1及以后
http://ip:port/bi/Viewer?proc=1&action=viewer&db=XXX.adb
http://ip:port/bi/Viewer?proc=1&action=viewer&assetID=XXXXXX
当同时输入db=XXX.adb（路径）和assetID=XXXXXX时，优先获取该路径的即席分析报告。
如果即席分析报告中带有参数，可以在URL里指定参数名和参数值，多个参数值用!a!分割。
例如：http://ip:port/bi/Viewer?proc=1&action=viewer&hback=true&AdHoc=adhoc1&a=Amaretto!a!Caffe%20Latte
给参数a传参，参数值为：Amaretto，Caffe Latte
•输出即席分析报告
支持的版本：10.1及以后
URL：http://ip:port/bi/Viewer?proc=1&action=viewer&export=XXX&db=XXX.adb
export：输出的文件类型，可选值为pdf，excel，csv，word，image。
db：报告的完整路径。
如果报告中带有参数，可以在URL里指定参数名和参数值，多个参数值用!a!分割。
•查看报告时，切换即席分析报告主题
支持的版本：10.1及以后
URL：http://ip:port/bi/Viewer?proc=1&action=viewer&type=system&theme=XXX&db=XXX.adb
type：主题的类型，可选值：system（系统主题）、custom（自定义主题）。
theme：主题的名字。系统主题有：Classic Grey、Classic Grey、Forest Green、Ice Blue、Macaron、Moon Blue、Ocean Blue、Secret Blue、Silver Grey、Silver Moonligh、Simple Black、Sunny Orange。自定义主题：自定义的主题名字。
2.4 组合报告
•新建组合报告
组合报告支持4种：网格组合，标签组合，堆栈组合、轻应用。
•新建组合报告
支持的版本：9.3及以后
URL：http://ip:port/bi/Viewer?proc=0&action=portal&urlEdit=true&isCell=true&layoutType=xxx
参数 |
值 |
描述 |
说明 |
layoutType |
1902 |
网格组合 |
9.3及以后 |
1904 |
标签组合 |
||
1905 |
堆栈组合 |
||
1912 |
轻应用 |
10.1及以后 |
•编辑报告中打开组合报告
支持的版本：10.1及以后
（推荐使用）URL：http://ip:port/bi/Viewer?proc=0&action=editor&db=XXX.ptlc（10.1及以后）
➢说明：
URL：http://ip:port/bi/Viewer?proc=0&action=portal&urlEdit=true&path=XXX&isCell=true （9.3及以后，不推荐使用）
path：门户组合的完整路径。
如果门户组合报告中带有参数，可以在URL里指定参数名和参数值，多个参数值用!a!分割。
•查看报告中打开组合报告
支持的版本：10.1及以后
（推荐使用）URL：http://ip:port/bi/Viewer?proc=1&action=viewer&db=XXX.ptlc
（推荐使用）URL：http://ip:port/bi/Viewer?proc=1&action=viewer&assetID=XXXXXX
当同时输入db=XXX（路径）和assetID=XXXXXX时，优先获取该路径的报告。
➢说明：
URL：http://ip:port/bi/Viewer?proc=0&action=portal&path=XXX&isCell=true（支持版本：9.1及以后，不推荐使用。）
如果门户组合报告中带有参数，可以在URL里指定参数名和参数值，多个参数值用!a!分割。
•H5中打开组合报告
支持单独集成组合报告
URL：http://ip:port/bi/Viewer?path=路径&isCell=true
path：组合报告的路径，如组合报告在根目录，直接为组合报告的名称。
2.5 作业后台管理
支持的版本：10.2及以后
URL：http://ip:port/bi/Viewer?proc=0&action=transJobs
3. 门户
•新建门户
URL：http://ip:port/bi/Viewer?proc=0&action=portal&urlEdit=true&isCell=false&layoutType=1900
layoutType：指定不同样式、不同组件的值，参考如下表格。
门户样式2种：综合布局、左右布局。
参数 |
值 |
描述 |
版本 |
layoutType |
1900 |
综合布局 |
9.3及以后 |
1901 |
左右布局 |
•编辑门户
URL：http://ip:port/bi/Viewer?proc=0&action=portal&urlEdit=true&path=XXX&isCell=false
path：门户的完整路径。
如果门户报告中带有参数，可以在URL里指定参数名和参数值，多个参数值用!a!分割。
•查看门户
URL：http://ip:port/bi/Viewer?proc=9&req=804&resource=portalViewer&path=XXX
如果门户报告中带有参数，请使用URL：http://ip:port/bi/Viewer?proc=0&action=portal&isPreview=true&path=path&isCell=false，并指定参数名和参数值，多个参数值用!a!分割。
如需隐藏URL标题中的“预览：”文字，只保留门户名称，增加参数hiddenPreview=true。
•H5中打开门户
支持单独集成门户
URL：http://ip:port/bi/Viewer?path=路径&isCell=false
path：门户的路径，如门户在根目录，直接为门户名称。
4.调度任务
•执行作业
支持的版本：7.1.4及以后。
URL：http://ip:port/bi/Viewer?proc=9&action=runJob&req=800&isAjax=true&fromClient=true&jobPath=XXX
jobPath：作业的完整路径。
也可以传递参数，参数以param_开始，多个参数值用英文,分割。不支持调用url给发送邮件和同步数据类型的作业传参。
例如：http://ip:port/bi/Viewer?proc=9&action=runJob&req=800&isAjax=true&fromClient=true&jobPath=job1¶m_deptno=10
本接口并不等待计划任务运行完成，而是提交过运行请求之后直接返回。
返回结果：
成功：
{
"status": "success",
"msg": "Job '测试计划任务' has been run"
}
失败：
{
"status": "failure",
"msg": "错误信息"
}
•获取作业状态
支持的版本：7.1.4及以后。
URL：http://ip:port/bi/Viewer?proc=9&action=getNode&req=800&isAjax=true&fromClient=true&jobPath=XXX
jobPath：作业的完整路径。
传递正确的参数时，将会返回指定作业的运行状态。
返回结果：
[
{
"status": "success", "fireTime": "2017-09-29 12:05:37",
"path": "测试计划任务"
}
]
status为计划任务的运行状态，fireTime为上次启动时间。
status可能的值见下表:
状态 |
描述 |
|---|---|
toRun |
待运行状态. 即已经提交了运行请求, 正在初始化计划任务。 |
running |
正在运行 |
cancelled |
计划任务被取消 |
failure |
计划任务运行失败 |
success |
计划任务运行成功 |
•取消作业执行
支持的版本：7.1.4及以后。
URL：http://ip:port/bi/Viewer?proc=9&action=stopJob&req=800&isAjax=true&fromClient=true&jobPath=XXX，并且传递正确的参数时，将会取消正在运行的指定作业。
jobPath：作业的完整路径。
返回结果：
成功：
[
{
"status": "Success to stop",
"path": "测试计划任务"
}
]
失败：
[
{
"status": " Failure to stop",
"path": "测试计划任务"
}
]
取消没有运行的作业：
[]
5.我的卡片
支持的版本：10.2及以后
URL：http://ip:port/bi/Viewer?proc=0&action=myCards
6.智能问答Copilot
支持的版本：10.2及以后
•对话页面
URL：http://ip:port/bi/Viewer?proc=0&action=askDataChat
•移动端首页
URL：http://ip:port/bi/Viewer/?proc=0&action=index&page=askDataHome
•指定数据集打开Copilot首页
URL：http://ip:port/bi/Viewer?proc=0&action=askDataHome&defQuery=XXX
•指定数据集打开Copilot对话页面
URL：http://ip:port/bi/Viewer?proc=0&action=askDataChat&defQuery=XXX
•移动端指定数据集打开Copilot
URL：http://ip:port/bi/Viewer/?proc=0&action=index&page=askDataHome&defQuery=XXX
defQuery：数据集路径。