历史版本4 :数据表接口 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

概述编辑

版本

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

功能简介

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

添加数据集-DB表编辑

接口简介



接口作用添加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：备注信息，选填

响应实例



请求链接

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表编辑

接口简介



接口作用添加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：备注信息，非必填

响应实例



请求链接

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表编辑

接口简介



接口作用编辑保存DB表
接口URL

/v5/api/table/update

请求类型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：备注信息

响应实例



请求链接

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":"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表编辑

接口简介



接口作用编辑保存SQL表
接口URL

/v5/api/table/update

请求类型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：备注信息，非必填

响应实例




请求链接

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":"客户跟踪信息",

    "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0",

    "initTime":0,

    "engineType":"spider"

}

响应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

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

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

        "success": true

    },

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截图示意

修改数据集转义名编辑

接口简介



接口作用修改数据集转义名
接口URL

/v5/api/tables/{tableName}/rename

请求类型POST
注意事项tableName是表原始名

请求参数-body参数

body是否必填描述说明

{"newName":"新转义名"}

是

newName为表的新转义名

响应实例



请求链接

表原始名：

BI Demo_教师信息表

链接：

http://172.17.0.25:37799/webroot/decision/v5/api/tables/BI Demo_教师信息表/rename?fine_auth_token=xxx

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

请求body{

"newName":"教育_2022届教师信息表"

}

响应成功

{

    "success": true,

    "code": "200",

    "message": "success",

    "data": [],

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

}

截图示意

删除数据集编辑

接口简介



接口作用删除数据集
接口URL

/v5/api/pack/delete

请求类型POST
注意事项与5.X接口不同

请求参数-body参数

body是否必填描述说明

{"tableName":"表原始名"}

是

tableName为待删除的表原始名

响应实例



请求链接

http://172.17.0.25:37799/webroot/decision/v5/api/pack/delete?fine_auth_token=xxx

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

请求body{

    "tableName":"BI Demo_录取信息表"

}

响应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "success": {

            "tableNames": [],

            "widgetIds": [],

            "reportIds": [],

            "subjectIds": [],

            "packIds": []

        },

        "fail": {

            "tableNames": [],

            "widgetIds": [],

            "reportIds": [],

            "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

})

截图示意

响应参数说明

参数
参数值说明
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：抽取数据

获取数据集的查询SQL编辑

接口简介



接口作用获取自助数据集的查询SQL
接口URL

/v5/api/analysis/table/execute/sql/{tableName}

请求类型GET
注意事项tableName为表原始名

响应实例



请求示例

http://172.17.0.25:37799/webroot/decision/v5/api/analysis/table/execute/sql/BI Demo_毕业生信息表?fine_auth_token=XXX

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

响应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {},

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截图示意

获取数据集数据编辑

接口简介



接口作用获取数据集的数据预览
接口URL

/v5/api/tables/fields/page

请求类型POST

请求参数-body参数

body是否必填描述说明

{

"tableName":"表原始名",

"pageIndex":"页码"

}

是

1）tableName为表原始名

2）pageIndex为页码

响应实例



请求链接

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为每页的数据条数

响应实例



请求链接

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

}

截图示意