概述
添加数据集-DB表
接口简介
| 接口作用 | 添加DB表 |
| 接口URL | /v5/api/table/add |
| 请求类型 | POST |
请求参数-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://192.168.101.92:8883/webroot/decision/v5/api/table/add 注:使用接口时需要登录,需要传递token参数。
|
| 请求Body | { "type":1, "connectionName":"BI Demo", "tableName":"客户跟踪表", "name":"BIDemo_客户跟踪表", "parentId": "13dd317974a144f886dbaaec51df46c6", "initTime":0, "engineType":"spider" } |
| 响应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "name": "61a3170bff084f25ac40e57354d8c795", "transferName": "BIDemo_客户跟踪表", "success": true }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }) |
| 截图示意 | ![]() |
添加数据集-SQL表
接口简介
| 接口作用 | 添加SQL表 |
| 接口URL | /v5/api/table/add |
| 请求类型 | POST |
请求参数-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://192.168.101.92:8883/webroot/decision/v5/api/table/add 注:使用接口时需要登录,需要传递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": "9b5389bf4b2842fa9474f9ea0d82dcc3", "transferName": "客户跟踪信息", "success": true }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }) |
| 截图示意 | ![]() |
编辑保存数据集-DB表
接口简介
| 接口作用 | 编辑保存DB表 |
| 接口URL | /v5/api/table/update |
| 请求类型 | POST |
请求参数-Body参数
| 参数值 | 是否必填 | 参数值 |
|---|---|---|
{ "type":1, "connectionName":"BI Demo", "tableName":"客户跟踪表", "name":"61a3170bff084f25ac40e57354d8c795", "transferName":"BIDemo_客户跟踪表", "parentId": "13dd317974a144f886dbaaec51df46c6", "initTime":0, "engineType":"spider" } | 是 | 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://192.168.101.92:8883/webroot/decision/v5/api/table/update 注:使用接口时需要登录,需要传递token参数。
|
| 请求Body | { "type":1, "connectionName":"BI Demo", "tableName":"客户跟踪表", "name":"a0d1265813d04bc6a3ba8764a8aed6e5", "transferName":"BIDemo_客户跟踪表", "parentId": "13dd317974a144f886dbaaec51df46c6", "initTime":0, "engineType":"spider" } |
| 响应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "name": "a0d1265813d04bc6a3ba8764a8aed6e5", "transferName": "BIDemo_客户跟踪表", "success": true }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }) |
| 截图示意 | ![]() |
编辑保存数据集-SQL表
接口简介
| 接口作用 | 编辑保存SQL表 |
| 接口URL | /v5/api/table/update |
| 请求类型 | POST |
请求参数-Body参数
| 参数 | 是否必填 | 参数值 |
|---|---|---|
{ "type":2, "connectionName":"BI Demo", "sql":"select * from 客户跟踪表", "name":"2bc4819522694110832a030135bb1daf", "transferName":"客户跟踪信息", "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0", "initTime":0, "engineType":"spider" } | 是 | 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://192.168.101.92:8883/webroot/decision/v5/api/table/update 注:使用接口时需要登录,需要传递token参数。
|
| 请求Body | { "type":2, "connectionName":"BI Demo", "sql":"select * from 客户跟踪表", "name":"2bc4819522694110832a030135bb1daf", "transferName":"客户跟踪信息", "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0", "initTime":0, "engineType":"spider" } |
| 响应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "name": "2bc4819522694110832a030135bb1daf", "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代表我的分析 |
响应实例
| 请求链接 | 表原始名: BI Demo_教师信息表 链接: http://192.168.101.92:8883/webroot/decision/v5/api/tables/BI Demo_教师信息表/rename 注:使用接口时需要登录,需要传递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 |
请求参数-body参数
| body | 是否必填 | 描述说明 |
|---|---|---|
{"tableNames":["表原始名"]} | 是 | tableName为待删除的表原始名 |
响应实例
| 请求链接 | http://192.168.101.92:8883/webroot/decision/v5/api/pack/delete 注:使用接口时需要登录,需要传递token参数。
|
| 请求body | { "tableNames":["BI Demo_录取信息表"] } |
| 响应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "success": { "tableNames": [ "BI Demo_录取信息表" ], "etlTableNames": [], "widgetIds": [], "reportIds": [], "docIds": [], "subjectIds": [], "packIds": [], "indexIds": [], "dimensionIds": [], "businessModelIds": [], "biBusinessModelIds": [], "modelIndexIds": [], "modelDimensionIds": [], "modelBusinessModelIds": [], "modelTableIds": [], "modelIndexFolderIds": [], "modelDimensionFolderIds": [], "modelBusinessModelFolderIds": [], "modelTableFolderIds": [], "measureIds": [], "modelBusinessFolderIds": [] }, "fail": { "tableNames": [], "etlTableNames": [], "widgetIds": [], "reportIds": [], "docIds": [], "subjectIds": [], "packIds": [], "indexIds": [], "dimensionIds": [], "businessModelIds": [], "biBusinessModelIds": [], "modelIndexIds": [], "modelDimensionIds": [], "modelBusinessModelIds": [], "modelTableIds": [], "modelIndexFolderIds": [], "modelDimensionFolderIds": [], "modelBusinessModelFolderIds": [], "modelTableFolderIds": [], "measureIds": [], "modelBusinessFolderIds": [] }, "errorDetailBeanMap": {} }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }) |
| 截图示意 | ![]() |
获取数据集信息
接口简介
| 接口作用 | 获取数据集相关信息 |
| 接口URL | /v5/api/table/{tableName}/get |
| 请求类型 | GET |
| 注意事项 | tableName是数据表的原始名 |
响应实例
| 请求示例 | http://192.168.101.92:8883/webroot/decision/v5/api/table/BI Demo_各省招生人数表/get 注:使用接口时需要登录,需要传递token参数。
|
| 响应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "name": "BI Demo_各省招生人数表", "transferName": "各省招生人数表", "type": 2, "createBy": "admin", "initTime": 1679328000000, "comment": null, "validStatus": "VALID", "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0", "editable": true, "usable": true, "sqlEditable": true, "publishStatus": 0, "coopAnalysis": false, "creatorAuth": true, "connectionName": "BI Demo", "moduleType": 1, "extractDataSetting": 0, "inherit": false, "belongAnalysis": false, "configUpdateTime": 1727573112891, "activeType": 0, "updateMode": 0, "consanguinityLevel": 1, "consanguinityOverLimit": false, "canSwitchRealtime": false, "dbMode": 0, "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 |
响应实例
| 请求链接 | http://192.168.101.92:8883/webroot/decision/v5/api/tables/fields/page 注:使用接口时需要登录,需要传递token参数。
|
| 请求body | { "tableName":"BI Demo_毕业生信息表", "pageIndex":"1" } |
| 响应成功 | { "success": true, "code": "200", "message": "success", "data": { "allFields": [ { "id": "BI Demo[5f]毕业生信息表_[6bd5][4e1a][751f][7c7b][578b]", "name": "毕业生类型", "type": 16, "size": 0, "enable": true, "transferName": "毕业生类型", "fieldGroupType": 0 }, { "id": "BI Demo[5f]毕业生信息表_[5b66][79d1][7c7b][578b]", "name": "学科类型", "type": 16, "size": 0, "enable": true, "transferName": "学科类型", "fieldGroupType": 0 }, { "id": "BI Demo[5f]毕业生信息表_[5b66][4f4d][7c7b][578b]", "name": "学位类型", "type": 16, "size": 0, "enable": true, "transferName": "学位类型", "fieldGroupType": 0 } ], "performBean": { "info": { "startTime": 1767516310411, "endTime": 1767516310536, "user": "admin", "category": "教育_毕业生信息表", "subCategory": "preview", "queryId": "e923d0b519934345b3a525ef4d6898d2", "componentType": 8, "timezone": "Asia/Shanghai", "start": 0, "renderStart": 0, "end": 0, "serverToBrowserTime": 0 }, "tceridInfo": { "rulesCacheInfo": "false", "finalCacheInfo": "false" }, "cacheHitInfo": { "cacheType": -1, "cacheCostTime": 0, "rowSize": -1 }, "summary": { "prepare": 0, "sqlExecute": 0, "dbDataTransfer": 0, "cacheCalculator": 0 }, "details": { "data": [] } }, "needShowTotalRowSize": true, "parentCached": false, "activeType": 0, "updateMode": 0, "fields": [ { "id": "BI Demo[5f]毕业生信息表_[6bd5][4e1a][751f][7c7b][578b]", "name": "毕业生类型", "type": 16, "size": 0, "enable": true, "transferName": "毕业生类型", "fieldGroupType": 0 }, { "id": "BI Demo[5f]毕业生信息表_[5b66][79d1][7c7b][578b]", "name": "学科类型", "type": 16, "size": 0, "enable": true, "transferName": "学科类型", "fieldGroupType": 0 }, { "id": "BI Demo[5f]毕业生信息表_[5b66][4f4d][7c7b][578b]", "name": "学位类型", "type": 16, "size": 0, "enable": 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": 1765939628834, "process": 0.0, "dataType": 0, "hasUpdated": true, "error": "", "fatherErrors": [], "infos": [], "accelerate": false } }, "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://192.168.101.92:8883/webroot/decision//v5/api/tables/data/page 注:使用接口时需要登录,需要传递token参数。
|
| 请求body | { "tableName":"BI Demo_毕业生信息表", "pageIndex":"1", "pageSize":"2" } |
| 响应成功 | { "success": true, "code": "200", "message": "success", "data": { "allFields": [ { "id": "BI Demo[5f]毕业生信息表_[6bd5][4e1a][751f][7c7b][578b]", "name": "毕业生类型", "type": 16, "size": 0, "enable": true, "transferName": "毕业生类型", "fieldGroupType": 0 }, { "id": "BI Demo[5f]毕业生信息表_[5b66][79d1][7c7b][578b]", "name": "学科类型", "type": 16, "size": 0, "enable": true, "transferName": "学科类型", "fieldGroupType": 0 }, { "id": "BI Demo[5f]毕业生信息表_[5b66][4f4d][7c7b][578b]", "name": "学位类型", "type": 16, "size": 0, "enable": true, "transferName": "学位类型", "fieldGroupType": 0 } ], "performBean": { "info": { "startTime": 1767516654007, "endTime": 1767516654201, "user": "admin", "category": "教育_毕业生信息表", "subCategory": "preview", "queryId": "342ab5c1bedc4634897d8a05b23cdf78", "componentType": 8, "timezone": "Asia/Shanghai", "start": 0, "renderStart": 0, "end": 0, "serverToBrowserTime": 0 }, "tceridInfo": { "rulesCacheInfo": "false", "finalCacheInfo": "false" }, "cacheHitInfo": { "cacheType": -1, "cacheCostTime": 0, "rowSize": -1 }, "summary": { "prepare": 7, "sqlExecute": 128, "dbDataTransfer": 6, "cacheCalculator": 0 }, "details": { "data": [ [ "SQL生成及优化", null, 7, "fbfc5d0b44d3-BI_Demo_毕业生信息表-preview-1a9eff6d-5aaa-4977-b1cd-8871cfecf058&&4afbb95c-aa5d-4c3a-b3d7-2d98778128f0&&1767516654071\r\nnull", null, null, 6, 1767516654052, 1767516654059, null ], [ "SQL执行", null, 128, null, null, null, null, 1767516654060, 1767516654188, null ], [ "数据传输(数据库-BI)", null, 6, null, 688, 3, 6, 1767516654188, 1767516654194, null ] ] } }, "needShowTotalRowSize": true, "parentCached": false, "activeType": 0, "updateMode": 0, "fields": [ { "id": "BI Demo[5f]毕业生信息表_[6bd5][4e1a][751f][7c7b][578b]", "name": "毕业生类型", "type": 16, "size": 0, "enable": true, "transferName": "毕业生类型", "fieldGroupType": 0 }, { "id": "BI Demo[5f]毕业生信息表_[5b66][79d1][7c7b][578b]", "name": "学科类型", "type": 16, "size": 0, "enable": true, "transferName": "学科类型", "fieldGroupType": 0 }, { "id": "BI Demo[5f]毕业生信息表_[5b66][4f4d][7c7b][578b]", "name": "学位类型", "type": 16, "size": 0, "enable": 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": 2 }, "diffConf": false, "hasdata": true, "currentType": 4, "startTime": 0, "endTime": 1765939628834, "process": 0.0, "dataType": 0, "hasUpdated": true, "error": "", "fatherErrors": [], "infos": [], "accelerate": false } }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null } |
| 截图示意 | ![]() |
获取我的分析下数据的查询SQL
接口简介
| 接口作用 | 获取我的分析中,调用了直连数据的数据表的查询SQL |
| 接口URL | /v5/api/analysis/table/execute/sql/{tableName} |
| 请求类型 | GET |
| 注意事项 | tableName为表ID |
响应实例
| 请求示例 | http://192.168.101.92:8883/webroot/decision/v5/api/analysis/table/execute/sql/03e424f0a70345fdbc365671ec9d8ddc 注:使用接口时需要登录,需要传递token参数。
|
| 响应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "sql": "\nselect \n t0.\"__fcol_0\" \"产品ID\", \n t0.\"__fcol_1\" \"产品名称\", \n t0.\"__fcol_2\" \"供应商ID\", \n t0.\"__fcol_3\" \"类别ID\", \n t0.\"__fcol_4\" \"单位数量\", \n t0.\"__fcol_5\" \"单价\", \n t0.\"__fcol_6\" \"库存量\", \n t0.\"__fcol_7\" \"订购量\", \n t0.\"__fcol_8\" \"再订购量\", \n t0.\"__fcol_9\" \"中止\"\nfrom (\n select \n T_8118E4E2057B46A0830DF.\"产品ID\" \"__fcol_0\", \n T_8118E4E2057B46A0830DF.\"产品名称\" \"__fcol_1\", \n T_8118E4E2057B46A0830DF.\"供应商ID\" \"__fcol_2\", \n T_8118E4E2057B46A0830DF.\"类别ID\" \"__fcol_3\", \n T_8118E4E2057B46A0830DF.\"单位数量\" \"__fcol_4\", \n T_8118E4E2057B46A0830DF.\"单价\" \"__fcol_5\", \n T_8118E4E2057B46A0830DF.\"库存量\" \"__fcol_6\", \n T_8118E4E2057B46A0830DF.\"订购量\" \"__fcol_7\", \n T_8118E4E2057B46A0830DF.\"再订购量\" \"__fcol_8\", \n T_8118E4E2057B46A0830DF.\"中止\" \"__fcol_9\"\n from (select * FROM S产品\n) T_8118E4E2057B46A0830DF\n) t0" }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }) |
| 截图示意 | ![]() |

