数据表接口- FineBI帮助文档 FineBI帮助文档

版本

FineBI服务器版本	功能变更
6.0	-

功能简介

本文讲解FineBI中数据表相关接口。

接口简介


接口作用	添加DB表
接口URL	/v5/api/table/add
请求类型	POST
注意事项	与5.X接口不同

请求参数-Body参数

参数	是否必填	参数值
{ "type":1, "connectionName":"BI Demo", "tableName":"客户跟踪表", "name":"BIDemo_客户跟踪表", "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0", "initTime":0, "engineType":"spider" "comment":"" }	是	1）type：表类型为1，代表DB表 2）connectionName：数据连接名称 3）tableName：数据库中的表名称 4）name：添加的数据集名称（建议使用“数据连接_数据库中的表名”这样的形式，作为唯一标识符） 5）parentId：数据集所在文件夹ID 6）initTime：初始化时间 7）engineType：引擎类型（direct：直连数据；spider：抽取数据） 8）comment：备注信息，选填

参数

是否必填

参数值

{

"type":1,

"connectionName":"BI Demo",

"tableName":"客户跟踪表",

"name":"BIDemo_客户跟踪表",

"parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0",

"initTime":0,

"engineType":"spider"

"comment":""

}

是

1）type：表类型为1，代表DB表

2）connectionName：数据连接名称

3）tableName：数据库中的表名称

4）name：添加的数据集名称（建议使用“数据连接_数据库中的表名”这样的形式，作为唯一标识符）

5）parentId：数据集所在文件夹ID

6）initTime：初始化时间

7）engineType：引擎类型（direct：直连数据；spider：抽取数据）

8）comment：备注信息，选填

响应实例


请求链接	http://172.17.0.25:37799/webroot/decision/v5/api/table/add?fine_auth_token=XXX 注：使用接口时需要登录，需要传递token参数。
请求Body	{ "type":1, "connectionName":"BI Demo", "tableName":"客户跟踪表", "name":"BIDemo_客户跟踪表", "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0", "initTime":0, "engineType":"spider" }
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "name": "BIDemo_客户跟踪表", "transferName": "BIDemo_客户跟踪表", "success": true }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

接口简介


接口作用	添加SQL表
接口URL	/v5/api/table/add
请求类型	POST
注意事项	与5.X接口不同

请求参数-Body参数

参数	是否必填	参数值
{ "type":2, "connectionName":"BI Demo", "sql":"select * from 客户跟踪表", "name":"客户跟踪信息", "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0", "initTime":0, "engineType":"spider" "comment":"" }	是	1）type：表类型为2，代表SQL表 2）connectionName：数据连接名称 3）sql：SQL语句 4）name：表原始名 5）parentId：数据集所在文件夹ID 6）initTime：初始化时间 7）engineType：引擎类型（direct：直连数据；spider：抽取数据） 8）comment：备注信息，非必填

参数

是否必填

参数值

{

"type":2,

"connectionName":"BI Demo",

"sql":"select * from 客户跟踪表",

"name":"客户跟踪信息",

"parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0",

"initTime":0,

"engineType":"spider"

"comment":""

}

是

1）type：表类型为2，代表SQL表

2）connectionName：数据连接名称

3）sql：SQL语句

4）name：表原始名

5）parentId：数据集所在文件夹ID

6）initTime：初始化时间

7）engineType：引擎类型（direct：直连数据；spider：抽取数据）

8）comment：备注信息，非必填

响应实例


请求链接	http://172.17.0.25:37799/webroot/decision/v5/api/table/add?fine_auth_token=XXX 注：使用接口时需要登录，需要传递token参数。
请求Body	{ "type":2, "connectionName":"BI Demo", "sql":"select * from 客户跟踪表", "name":"客户跟踪信息", "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0", "initTime":0, "engineType":"spider" }
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "name": "客户跟踪信息", "transferName": "客户跟踪信息", "success": true }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

接口简介


接口作用	编辑保存DB表
接口URL	/v5/api/table/update
请求类型	POST
注意事项	与5.X接口不同

请求参数-Body参数

参数值	是否必填	参数值
{ "type":1, "connectionName":"BI Demo", "tableName":"客户跟踪表", "name":"26cd79512cc24c6a816c59ffe54b1a29", "transferName":"BIDemo_客户跟踪表", "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0", "initTime":0, "engineType":"spider" "comment":"" }	是	1）type：表类型为1，代表DB表 2）connectionName：数据连接名称 3）tableName：数据库中的表名称 4）name：数据集ID 5）transferName：数据集转义名 6）parentId：数据集所在文件夹ID 7）initTime：初始化时间 8）engineType：引擎类型（direct：直连数据；spider：抽取数据） 9）comment：备注信息

参数值

是否必填

参数值

{

"type":1,

"connectionName":"BI Demo",

"tableName":"客户跟踪表",

"name":"26cd79512cc24c6a816c59ffe54b1a29",

"transferName":"BIDemo_客户跟踪表",

"parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0",

"initTime":0,

"engineType":"spider"

"comment":""

}

是

1）type：表类型为1，代表DB表

2）connectionName：数据连接名称

3）tableName：数据库中的表名称

4）name：数据集ID

5）transferName：数据集转义名

6）parentId：数据集所在文件夹ID

7）initTime：初始化时间

8）engineType：引擎类型（direct：直连数据；spider：抽取数据）

9）comment：备注信息

响应实例


请求链接	http://172.17.0.25:37799/webroot/decision/v5/api/table/update?fine_auth_token=XXX 注：使用接口时需要登录，需要传递token参数。
请求Body	{ "type":1, "connectionName":"BI Demo", "tableName":"客户跟踪表", "name":"26cd79512cc24c6a816c59ffe54b1a29", "transferName":"BIDemo_客户跟踪表", "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0", "initTime":0, "engineType":"spider" }
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "name": "BIDemo_客户跟踪表", "transferName": "BIDemo_客户跟踪表", "success": true }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

接口简介


接口作用	编辑保存SQL表
接口URL	/v5/api/table/update
请求类型	POST
注意事项	与5.X接口不同

请求参数-Body参数

参数	是否必填	参数值
{ "type":2, "connectionName":"BI Demo", "sql":"select * from 客户跟踪表", "name":"26cd79512cc24c6a816c59ffe54b1a29", "transferName":"客户跟踪信息", "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0", "initTime":0, "engineType":"spider" "comment":"" }	是	1）type：表类型为2，代表SQL表 2）connectionName：数据连接名称 3）sql：SQL语句 4）name：表id 5）transferName：表转义名 5）parentId：数据集所在文件夹ID 6）initTime：初始化时间 7）engineType：引擎类型（direct：直连数据；spider：抽取数据） 8）comment：备注信息，非必填

参数

是否必填

参数值

{

"type":2,

"connectionName":"BI Demo",

"sql":"select * from 客户跟踪表",

"name":"26cd79512cc24c6a816c59ffe54b1a29",

"transferName":"客户跟踪信息",

"parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0",

"initTime":0,

"engineType":"spider"

"comment":""

}

是

1）type：表类型为2，代表SQL表

2）connectionName：数据连接名称

3）sql：SQL语句

4）name：表id

5）transferName：表转义名

5）parentId：数据集所在文件夹ID

6）initTime：初始化时间

7）engineType：引擎类型（direct：直连数据；spider：抽取数据）

8）comment：备注信息，非必填

响应实例


请求链接	http://172.17.0.25:37799/webroot/decision/v5/api/table/update?fine_auth_token=XXX 注：使用接口时需要登录，需要传递token参数。
请求Body	{ "type":2, "connectionName":"BI Demo", "sql":"select * from 客户跟踪表", "name":"26cd79512cc24c6a816c59ffe54b1a29", "transferName":"客户跟踪信息", "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0", "initTime":0, "engineType":"spider" }
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "name":"26cd79512cc24c6a816c59ffe54b1a29", "transferName":"客户跟踪信息", "success": true }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

接口简介


接口作用	修改数据集转义名
接口URL	/v5/api/tables/{tableName}/rename
请求类型	POST
注意事项	tableName是表原始名

请求参数-body参数

body	是否必填	描述说明
{ "name":"新转义名", "moduleType":1 }	是	1）name：表的新转义名 2）connectionName：表存放位置，1代表公共数据，2代表我的分析

body

是否必填

描述说明

{

"name":"新转义名",

"moduleType":1

}

是

1）name：表的新转义名

2）connectionName：表存放位置，1代表公共数据，2代表我的分析

响应实例


请求链接	表原始名： BI Demo_教师信息表链接： http://192.168.5.138:37799/webroot/decision/v5/api/tables/BI Demo_教师信息表/rename?fine_auth_token=xxx 注：使用接口时需要登录，需要传递token参数。
请求body	{ "name":"教育_2022届教师信息表", "moduleType":1 }
响应成功	{ "success": true, "code": "200", "message": "success", "data": [], "errorCode": null, "detailErrorMsg": null, "errorMsg": null }
截图示意

接口简介


接口作用	删除数据集
接口URL	/v5/api/pack/delete
请求类型	POST
注意事项	与5.X接口不同

请求参数-body参数

body	是否必填	描述说明
{"tableNames":["表原始名"]}	是	tableName为待删除的表原始名

响应实例


请求链接	http://172.17.0.25:37799/webroot/decision/v5/api/pack/delete?fine_auth_token=xxx 注：使用接口时需要登录，需要传递token参数。
请求body	{ "tableNames":["BI Demo_录取信息表"] }
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "success": { "tableNames": [ "BI Demo_录取信息表" ], "widgetIds": [], "reportIds": [], "docIds": [], "subjectIds": [], "packIds": [] }, "fail": { "tableNames": [], "widgetIds": [], "reportIds": [], "docIds": [], "subjectIds": [], "packIds": [] }, "errorDetailBeanMap": {} }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

接口简介


接口作用	获取数据集相关信息
接口URL	/v5/api/table/{tableName}/get
请求类型	GET
注意事项	tableName是数据表的原始名

响应实例


请求示例	http://172.17.0.25:37799/webroot/decision/v5/api/table/BI Demo_各省招生人数表/get?fine_auth_token=xxx 注：使用接口时需要登录，需要传递token参数。
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "name": "BI Demo_各省招生人数表", "transferName": "各省招生人数表", "type": 2, "createBy": "1", "initTime": 0, "comment": null, "validStatus": "VALID", "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0", "editable": true, "sqlEditable": true, "publishStatus": 0, "coopAnalysis": false, "creatorAuth": true, "connectionName": "BI Demo", "moduleType": 1, "extractDataSetting": 0, "inherit": false, "belongAnalysis": false, "configUpdateTime": 1655283326594, "engineType": "spider" }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

请求示例

http://172.17.0.25:37799/webroot/decision/v5/api/table/BI Demo_各省招生人数表/get?fine_auth_token=xxx

注：使用接口时需要登录，需要传递token参数。

响应成功

callback({

"success": true,

"code": "200",

"message": "success",

"data": {

"name": "BI Demo_各省招生人数表",

"transferName": "各省招生人数表",

"type": 2,

"createBy": "1",

"initTime": 0,

"comment": null,

"validStatus": "VALID",

"parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0",

"editable": true,

"sqlEditable": true,

"publishStatus": 0,

"coopAnalysis": false,

"creatorAuth": true,

"connectionName": "BI Demo",

"moduleType": 1,

"extractDataSetting": 0,

"inherit": false,

"belongAnalysis": false,

"configUpdateTime": 1655283326594,

"engineType": "spider"

},

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

})

截图示意

响应参数说明

参数	参数值说明
name	数据集原始名
transferName	数据集转义名
type	数据集类型 1：DB表 2：SQL表
createBy	数据集创建者用户名
initTime	初始化时间
comment	备注
validStatus	标红信息
parentID	数据集所在文件夹ID
editable	是否可编辑 true：是 false：否
sqlEditable	SQL是否可编辑 true：是 false：否
publicStatus	发布状态 0：未发布 1：已发布
coopAnalysis	是否协作给当前用户 true：是 false：否
creatorAuth	是否拥有和创建者相等的权限(我的分析下专用) true：是 false：否
connectionName	数据连接名称
moduleType	数据集所处位置 1：公共数据 2：我的分析
extractDataSetting	抽取状态
inherit	是否开启权限继承 true：开启 false：未开启
belongAnalysis	是否属于当前用户的「我的分析」(公共数据下专用) true：是 false：否
configUpdateTime	最近改动时间
engineType	数据集引擎类型 direct：直连数据 spider：抽取数据

接口简介


接口作用	获取数据集的数据预览
接口URL	/v5/api/tables/fields/page
请求类型	POST

请求参数-body参数

body	是否必填	描述说明
{ "tableName":"表原始名", "pageIndex":"页码", "limit":"数据量限制", "pageSize":"分页大小" }	是	1）tableName为表原始名 2）pageIndex为页码 3）limit为数据量限制可不填，不填默认为5000 最大不可超过数据访问量 4）pageSize为分页大小可不填，不填默认为100

body

是否必填

描述说明

{

"tableName":"表原始名",

"pageIndex":"页码",

"limit":"数据量限制",

"pageSize":"分页大小"

}

是

1）tableName为表原始名

2）pageIndex为页码

3）limit为数据量限制

可不填，不填默认为5000

最大不可超过数据访问量

4）pageSize为分页大小

可不填，不填默认为100

响应实例


请求链接	http://172.17.0.25:37799/webroot/decision/v5/api/tables/fields/page?fine_auth_token=xxx 注：使用接口时需要登录，需要传递token参数。
请求body	{ "tableName":"BI Demo_毕业生信息表", "pageIndex":"1" }
响应成功	{ "success": true, "code": "200", "message": "success", "data": { "performBean": { "info": { "startTime": 1669105706067, "endTime": 1669105706082, "user": "1", "category": "BI Demo_毕业生信息表", "subCategory": "preview", "queryId": "6b5aea688a1a4f289e6d449d039c21ba", "componentType": 8, "timezone": "Asia/Shanghai", "start": 0, "renderStart": 0, "consumePerformance": 0, "frontBackPerformance": 0 }, "tceridInfo": { "rulesCacheInfo": "false", "finalCacheInfo": "false" }, "cacheHitInfo": { "cacheType": -1, "cacheCostTime": 0, "rowSize": -1 }, "summary": { "prepare": 0, "sqlExecute": 6, "dbDataTransfer": 0, "cacheCalculator": 0 }, "details": { "data": [ [ "BI-Basic_Performance_Sql_Generator_Optimize", null, 0, "\n************* Get a baseCriteria(id:1363288290) begin ***********\nselect: 毕业生类型, 学科类型, 学位类型\nwhere: \ngroup: \norder: \nlimit: 5000, offset : 0\ncustom group: \nfrom: [SpiderLimitEntity]T_D9E899\n*********** Get a baseCriteria end ******************************", null, null, null, 1669105706072, 1669105706072, null ], [ "BI-Basic_Performance_Sql_Execute", null, 6, null, null, null, 4, 1669105706072, 1669105706078, null ] ] } }, "needShowTotalRowSize": true, "parentCached": false, "fields": [ { "id": "BI Demo[5f]毕业生信息表_[6bd5][4e1a][751f][7c7b][578b]", "name": "毕业生类型", "type": 16, "size": 0, "enable": true, "usable": true, "transferName": "毕业生类型", "fieldGroupType": 0 }, { "id": "BI Demo[5f]毕业生信息表_[5b66][79d1][7c7b][578b]", "name": "学科类型", "type": 16, "size": 0, "enable": true, "usable": true, "transferName": "学科类型", "fieldGroupType": 0 }, { "id": "BI Demo[5f]毕业生信息表_[5b66][4f4d][7c7b][578b]", "name": "学位类型", "type": 16, "size": 0, "enable": true, "usable": true, "transferName": "学位类型", "fieldGroupType": 0 } ], "data": [ [ "留学生", "管理学", "理论型博士" ], [ "普通在读生", "法学", "博士生" ], [ "交换生", "文学", "理论型博士" ], [ "普通在读生", "经济学", "理论型博士" ] ], "fieldsLabel": [], "pageInfo": { "totalRows": 688, "pageSize": 100, "pageIndex": 1 }, "dataStatus": { "tableName": "BI Demo_毕业生信息表", "updateStatus": 0, "errorCode": 0, "limit": 0.0 }, "updateStatus": { "table": { "name": "BI Demo_毕业生信息表", "transferName": "教育_毕业生信息表", "type": 2 }, "diffConf": false, "hasdata": true, "currentType": 4, "startTime": 0, "endTime": 1662375106784, "process": 0.0, "dataType": 0, "hasUpdated": true } }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }
截图示意

接口简介


接口作用	获取数据集的数据预览, 限制数据量不超过10w，支持设置每一页数据量
接口URL	/v5/api/tables/data/page
请求类型	POST

请求参数-body参数

body	是否必填	描述说明
{ "tableName":"表原始名", "pageIndex":"页码", "pageSize":"每页数据量" }	是	1）tableName为表原始名 2）pageIndex为页码 3）pageSize为每页的数据条数

body

是否必填

描述说明

{

"tableName":"表原始名",

"pageIndex":"页码",

"pageSize":"每页数据量"

}

是

1）tableName为表原始名

2）pageIndex为页码

3）pageSize为每页的数据条数

响应实例


请求链接	http://172.17.0.25:37799/webroot/decision/v5/api/tables/data/page?fine_auth_token=xxx 注：使用接口时需要登录，需要传递token参数。
请求body	{ "tableName":"BI Demo_毕业生信息表", "pageIndex":"1", "pageSize":"2" }
响应成功	{ "success": true, "code": "200", "message": "success", "data": { "needShowTotalRowSize": true, "parentCached": false, "fields": [ { "id": "BI Demo[5f]毕业生信息表_[6bd5][4e1a][751f][7c7b][578b]", "name": "毕业生类型", "type": 16, "size": 32, "enable": true, "usable": true, "transferName": "毕业生类型", "fieldGroupType": 0 }, { "id": "BI Demo[5f]毕业生信息表_[5b66][79d1][7c7b][578b]", "name": "学科类型", "type": 16, "size": 32, "enable": true, "usable": true, "transferName": "学科类型", "fieldGroupType": 0 }, { "id": "BI Demo[5f]毕业生信息表_[5b66][4f4d][7c7b][578b]", "name": "学位类型", "type": 16, "size": 32, "enable": true, "usable": true, "transferName": "学位类型", "fieldGroupType": 0 } ], "data": [ [ "留学生", "管理学", "理论型博士" ], [ "普通在读生", "法学", "博士生" ] ], "fieldsLabel": [], "pageInfo": { "totalRows": 688, "pageSize": 2, "pageIndex": 1 }, "dataStatus": { "tableName": "BI Demo_毕业生信息表", "updateStatus": 0, "errorCode": 0, "limit": 0.0 }, "updateStatus": { "table": { "name": "BI Demo_毕业生信息表", "transferName": "教育_毕业生信息表", "type": 1 }, "diffConf": false, "hasdata": true, "currentType": 4, "startTime": 0, "endTime": 1658727981210, "process": 0.0, "monitorExist": false } }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }
截图示意

接口简介


接口作用	获取我的分析中，调用了直连数据的数据表的查询SQL
接口URL	/v5/api/analysis/table/execute/sql/{tableName}
请求类型	GET
注意事项	tableName为表ID

响应实例


请求示例	http://172.17.0.25:37799/webroot/decision/v5/api/analysis/table/execute/sql/a9ae120c0a85448fa4ad4fb5d1762a4d?fine_auth_token=XXX 注：使用接口时需要登录，需要传递token参数。
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "sql": "\nselect \n t0.\"__fcol_0\" \"地区\", \n t0.\"__fcol_1\" \"销售员\", \n t0.\"__fcol_2\" \"产品类型\", \n t0.\"__fcol_3\" \"产品\", \n t0.\"__fcol_4\" \"销量\"\nfrom (\n select \n T_53DAD1AFB3D343F9A4140.\"地区\" \"__fcol_0\", \n T_53DAD1AFB3D343F9A4140.\"销售员\" \"__fcol_1\", \n T_53DAD1AFB3D343F9A4140.\"产品类型\" \"__fcol_2\", \n T_53DAD1AFB3D343F9A4140.\"产品\" \"__fcol_3\", \n T_53DAD1AFB3D343F9A4140.\"销量\" \"__fcol_4\"\n from (SELECT *from 销量\n) T_53DAD1AFB3D343F9A4140\n) t0" }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

请求示例

http://172.17.0.25:37799/webroot/decision/v5/api/analysis/table/execute/sql/a9ae120c0a85448fa4ad4fb5d1762a4d?fine_auth_token=XXX

注：使用接口时需要登录，需要传递token参数。

响应成功

callback({

"success": true,

"code": "200",

"message": "success",

"data": {

"sql": "\nselect \n t0.\"__fcol_0\" \"地区\", \n t0.\"__fcol_1\" \"销售员\", \n t0.\"__fcol_2\" \"产品类型\", \n t0.\"__fcol_3\" \"产品\", \n t0.\"__fcol_4\" \"销量\"\nfrom (\n select \n T_53DAD1AFB3D343F9A4140.\"地区\" \"__fcol_0\", \n T_53DAD1AFB3D343F9A4140.\"销售员\" \"__fcol_1\", \n T_53DAD1AFB3D343F9A4140.\"产品类型\" \"__fcol_2\", \n T_53DAD1AFB3D343F9A4140.\"产品\" \"__fcol_3\", \n T_53DAD1AFB3D343F9A4140.\"销量\" \"__fcol_4\"\n from (SELECT *from 销量\n) T_53DAD1AFB3D343F9A4140\n) t0"

},

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

})

截图示意

数据表接口

概述

版本

功能简介

添加数据集-DB表

添加数据集-SQL表

编辑保存数据集-DB表

编辑保存数据集-SQL表

修改数据集转义名

删除数据集

获取数据集信息

获取数据集数据

获取数据集分页数据

获取我的分析下数据的查询SQL

附件列表