概述
版本
| FineBI服务器版本 | 功能变更 |
|---|---|
| 5.1 | - |
功能简介
本文讲解FineBI5.1中业务包相关接口。
注：直连对于业务包的增删改查不通过API进行区分，额外添加一个参数即可。参数：engineType=direct
添加业务包
接口简介
| 接口作用 | 添加业务包 |
| 接口URL | /v5/api/pack/{groupId}/add |
| 请求类型 | GET |
| 注意事项 | 1）使用该接口添加业务包时，无法指定业务包的命名，只能添加默认业务包 2）groupId为分组ID |
响应实例
| 请求示例 | http://172.17.0.25:37799/webroot/decision/v5/api/pack/318025f01f0344979325942f991f0fa2/add?fine_auth_token=XXX 注：使用接口时需要登录，需要传递token参数。 |
| 响应成功 | callback({ "id": "f92eeed58b6649f5a0bf3034254f765b", "name": "业务包", "owner": "b5f0c2ee-640f-4039-a4d4-918b55354898", "initTime": 1669018422364, "version": 0, "myAnalysis": false, "packType": "NORMAL", "tables": [] }) |
| 截图示意 |  |
重命名业务包
接口简介
| 接口作用 | 重命名业务包 |
| 接口URL | /v5/api/pack/{packId}/rename |
| 请求类型 | GET |
| 注意事项 | packId为业务包ID |
请求参数-Query参数
| 参数名 | 参数值 | 是否必填 |
|---|---|---|
| newName | 业务包新名称 | 是 |
响应实例
| 请求示例 | http://172.17.0.25:37799/webroot/decision/v5/api/pack/2f9d28964edd4d19a2316c111c07c6ac/rename?newName=银行金融业&fine_auth_token=XXX 注：使用接口时需要登录，需要传递token参数。 |
| 响应成功 | callback(true) |
| 截图示意 | |
删除业务包
接口简介
| 接口作用 | 删除业务包 |
| 接口URL | /v5/api/pack/{packId}/delete |
| 请求类型 | GET |
| 注意事项 | packId为业务包ID |
响应实例
| 请求示例 | http://172.17.0.25:37799/webroot/decision/v5/api/pack/f92eeed58b6649f5a0bf3034254f765b/delete?fine_auth_token=XXX 注：使用接口时需要登录，需要传递token参数。 |
| 响应成功 | callback(true) |
| 截图示意 | |
获取业务包信息
接口简介
| 接口作用 | 获取业务包信息 |
| 接口URL | /v5/api/pack/{packId}/get |
| 请求类型 | GET |
| 注意事项 | packId为业务包ID |
响应实例
| 请求示例 | http://172.17.0.25:37799/webroot/decision/v5/api/pack/c9dcb29695ba4d77a71fed73ea259720/get?fine_auth_token=XXX 注：使用接口时需要登录，需要传递token参数。 |
| 响应成功 | callback({ "id": "c9dcb29695ba4d77a71fed73ea259720", "name": "教育行业", "owner": "b5f0c2ee-640f-4039-a4d4-918b55354898", "initTime": 1567658753584, "version": 1, "myAnalysis": false, "packType": "NORMAL", "tables": [ "QQ", "BI Demo_教师信息表", "BI Demo_各省招生人数表", "BI Demo_录取信息表", "BI Demo_学生信息表", "BI Demo_各学院招生人数表", "我的分析埋点", "BI Demo_毕业生信息表" ] }) |
| 截图示意 | |
获取业务包中表信息
接口简介
| 接口作用 | 获取业务包中表信息 |
| 接口URL | /v5/api/conf/packs/{packId} |
| 请求类型 | GET |
| 注意事项 | packId为业务包ID |
响应实例
| 请求示例 | http://172.17.0.25:37799/webroot/decision/v5/api/conf/packs/c9dcb29695ba4d77a71fed73ea259720?fine_auth_token=XXX 注：使用接口时需要登录，需要传递token参数。 |
| 响应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "name": "教育行业", "editable": true, "tables": [ { "name": "BI Demo_教师信息表", "pack": "c9dcb29695ba4d77a71fed73ea259720", "myAnalysis": false, "operators": [], "transferName": "教育_2022届教师信息表", "usedSpace": 0.0, "createBy": "1", "editable": true, "selected": 0, "initTime": 0, "movable": true, "comment": null, "position": "数据准备/行业数据/教育行业", "realPack": "c9dcb29695ba4d77a71fed73ea259720", "memorize": false, "tableName": "教师信息表", "connectionName": "BI Demo", "fields": [ { "id": "BI Demo[5f]教师信息表_[5165][804c][65f6][95f4]", "name": "入职时间", "type": 48, "size": 32, "enable": true, "usable": true, "transferName": "入职时间", "fieldGroupType": 0 }, { "id": "BI Demo[5f]教师信息表_[90e8][95e8][5355][4f4d]", "name": "部门单位", "type": 16, "size": 32, "enable": true, "usable": true, "transferName": "部门单位", "fieldGroupType": 0 }, { "id": "BI Demo[5f]教师信息表_[7c7b][522b]", "name": "类别", "type": 16, "size": 32, "enable": true, "usable": true, "transferName": "类别", "fieldGroupType": 0 }, { "id": "BI Demo[5f]教师信息表_[6027][522b]", "name": "性别", "type": 16, "size": 32, "enable": true, "usable": true, "transferName": "性别", "fieldGroupType": 0 }, { "id": "BI Demo[5f]教师信息表_[5b66][5386]", "name": "学历", "type": 16, "size": 32, "enable": true, "usable": true, "transferName": "学历", "fieldGroupType": 0 }, { "id": "BI Demo[5f]教师信息表_[59d3][540d]", "name": "姓名", "type": 16, "size": 32, "enable": true, "usable": true, "transferName": "姓名", "fieldGroupType": 0 }, { "id": "BI Demo[5f]教师信息表_[804c][7ea7]", "name": "职级", "type": 16, "size": 32, "enable": true, "usable": true, "transferName": "职级", "fieldGroupType": 0 }, { "id": "BI Demo[5f]教师信息表_[5e74][9f84]", "name": "年龄", "type": 32, "size": 32, "enable": true, "usable": true, "transferName": "年龄", "fieldGroupType": 0 }, { "id": "BI Demo[5f]教师信息表_[79d1][7814][6210][679c]", "name": "科研成果", "type": 32, "size": 32, "enable": true, "usable": true, "transferName": "科研成果", "fieldGroupType": 0 }, { "id": "BI Demo[5f]教师信息表_[53d1][8868][671f][520a][8bba][6587]", "name": "发表期刊论文", "type": 32, "size": 32, "enable": true, "usable": true, "transferName": "发表期刊论文", "fieldGroupType": 0 }, { "id": "BI Demo[5f]教师信息表_[662f][5426][7ec8][8eab][5236]", "name": "是否终身制", "type": 16, "size": 32, "enable": true, "usable": true, "transferName": "是否终身制", "fieldGroupType": 0 } ], "type": 1, "engineType": 2 } ], "errorTable": [], "missTable": [] }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }) |
| 截图示意 | |
