资源相关

<< Click to Display Table of Contents >>

当前位置:  部署与集成 > Web页面集成 

资源相关

复制链接

新建数据源

支持的版本: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, DATA MART,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, 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

打开数据集

支持的版本: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时,优先获取该路径的数据集。

新建报告

支持的版本:7.1.3及以后。

URL:http://ip:port/bi/Viewer?proc=0&action=editor&createNewDb=true

新建报告指定绑定的数据集

支持的版本:9.4及以后。

URL:http://ip:port/bi/Viewer?proc=0&action=editor&createNewDb=true&defQuery=XXX&type=XXX

defQuery:数据集路径

type:数据集类型,参考上方数据集缩略名。

例如:http://ip:port:8093/bi/Viewer?proc=0&action=editor&createNewDb=true&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:报告的完整路径。打开根目录/folder1下的db1为folder1/db1。我的报告路径为:__MY_DB__,打开我的报告下的db1为__MY_DB__/db1

如果报告中带有参数,可以在URL里指定参数名和参数值,多个参数值用!a!分割。

查看报告时打开报告

URL:http://ip:port/bi/Viewer?proc=1&action=viewer&db=XXX

10.0及以后还支持URL为:

http://ip:port/bi/Viewer?proc=1&action=viewer&assetID=XXXXXX

当同时输入db=XXX(路径)和assetID=XXXXXX时,优先获取该路径的报告。

例如:http://ip:port/bi/Viewer?proc=1&action=viewer&hback=true&db=db1&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&mode=meta

输出报告

URL:http://ip:port/bi/Viewer?proc=1&action=viewer&export=XXX&db=XXX

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

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。自定义主题:自定义的主题名字。

新建门户和门户组合

支持的版本:9.3及以后。

URL:http://ip:port/bi/Viewer?proc=0&action=portal&urlEdit=true&isCell=false&layoutType=1900

layoutType:指定不同样式、不同组件的值,参考如下表格。

门户样式2种:综合布局、左右布局。

门户组件3种:网格组合,标签组合,堆栈组合。

参数

描述

layoutType

1900

综合布局

1901

左右布局

1902

网格组合

1904

标签组合

1905

堆栈组合

编辑门户组合

支持的版本:9.3及以后。

URL:http://ip:port/bi/Viewer?proc=0&action=portal&urlEdit=true&path=XXX&isCell=true

path:门户组合的完整路径。

如果门户组合报告中带有参数,可以在URL里指定参数名和参数值,多个参数值用!a!分割。

编辑门户

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=0&action=portal&isPreview=true&path=XXX&isCell=true

如需隐藏URL标题中的“预览:”文字,只保留组合报告名称,增加参数hiddenPreview=true

URL:http://ip:port/bi/Viewer?proc=0&action=portal&isPreview=true&path=XXX&isCell=true&hiddenPreview=true

如果门户组合报告中带有参数,可以在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。

执行作业

支持的版本: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&param_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": "测试计划任务"

   }

]

 

取消没有运行的作业:

[]