概述
版本
| FineBI服务器版本 | 功能变更 |
|---|---|
| 5.1 | - |
功能简介
本文讲解FineBI5.1中分组相关接口。
注：直连对于分组的增删改查，可在接口URL中，加一个direct即可。
例如添加分组：
抽取接口：/v5/api/group/add
直连接口：/v5/api/direct/group/add
添加分组
接口简介
| 接口作用 | 添加分组 |
| 接口URL | /v5/api/group/add |
| 请求类型 | GET |
| 注意事项 | 使用该接口添加分组时，无法指定分组的命名，只能添加默认分组 |
响应实例
| 请求示例 | http://172.17.0.25:37799/webroot/decision/v5/api/group/add?fine_auth_token=XXX 注：使用接口时需要登录，需要传递token参数。 |
| 响应成功 | callback({ "id": "ed2a985422cc430fb1f6236eff1a97e6", "name": "分组", "initTime": 1669020778699, "packs": [], "editable": true, "myAnalysis": false, "groups": [] }) |
| 截图示意 |  |
重命名分组
接口简介
| 接口作用 | 重命名分组 |
| 接口URL | /v5/api/group/{groupId}/rename |
| 请求类型 | GET |
| 注意事项 | groupId为分组ID |
请求参数-Query参数
| 参数名 | 参数值 | 是否必填 |
|---|---|---|
groupName | 分组新名称 | 是 |
响应实例
| 请求示例 | http://172.17.0.25:37799/webroot/decision/v5/api/group/ed2a985422cc430fb1f6236eff1a97e6/rename?groupName=运维数据&fine_auth_token=XXX 注：使用接口时需要登录，需要传递token参数。 |
| 响应成功 | callback(true) |
| 截图示意 | |
删除分组
接口简介
| 接口作用 | 删除分组 |
| 接口URL | /v5/api/group/{groupId}/delete |
| 请求类型 | GET |
| 注意事项 | groupId为分组ID |
响应实例
| 请求示例 | http://172.17.0.25:37799/webroot/decision/v5/api/group/ed2a985422cc430fb1f6236eff1a97e6/delete?fine_auth_token=XXX 注：使用接口时需要登录，需要传递token参数。 |
| 响应成功 | callback(true) |
| 截图示意 | |
获取分组信息
接口简介
| 接口作用 | 获取分组信息 |
| 接口URL | /v5/api/group/{groupId}/get |
| 请求类型 | GET |
| 注意事项 | groupId为分组ID |
响应实例
| 请求示例 | http://172.17.0.25:37799/webroot/decision/v5/api/group/318025f01f0344979325942f991f0fa2/get?fine_auth_token=XXX 注：使用接口时需要登录，需要传递token参数。 |
| 响应成功 | callback({ "id": "318025f01f0344979325942f991f0fa2", "pid": "__root_group__", "name": "行业数据", "ownerId": "b5f0c2ee-640f-4039-a4d4-918b55354898", "myAnalysis": false, "initTime": 1531100845953, "version": 1531100845953, "packageIds": [ "3b9513c2421a402ba6c78a2fda5040b5", "7de04fa13a4c4f14af9f51605fb44a88", "b50db23ce76041a1b0fc6beeb2735c59", "f3ce11dfd7aa43b7b3d5fa9f3541e42e", "c8c903d51454491baa6c5d6714c15ea1", "2f9d28964edd4d19a2316c111c07c6ac", "52c96d6960014976b655415d9dd6f149", "d3c4d40760984547bb2e48a475393f94", "c9dcb29695ba4d77a71fed73ea259720", "8f8ef0f1af2f470b8b4ba5ed356c2bfb", "99210b00339a48f4b5f815650e82d5e7" ], "subGroups": [] }) |
| 截图示意 | |
获取所有分组业务包信息
接口简介
| 接口作用 | 获取所有分组业务包信息 |
| 接口URL | /v5/api/conf/groups |
| 请求类型 | GET |
响应实例
| 请求示例 | http://172.17.0.25:37799/webroot/decision/v5/api/conf/groups?fine_auth_token=XXX 注：使用接口时需要登录，需要传递token参数。 |
| 响应成功 | callback({ "success": true, "code": "200", "message": "success", "data": [ { "id": "de20c13fdcdd436987289588b232c38c", "name": "功能数据", "initTime": 1531138781428, "packs": [ { "id": "18d26ef06d1f4e91adaa12c80feb2daa", "name": "销售DEMO", "createBy": "1", "timeStamp": 1531101074181, "usedSpace": 0.0, "myAnalysis": false, "tables": [], "editable": true, "shareAnalysis": false, "tableCount": 9 }, { "id": "8975e5316ba9474db286bd20636745fb", "name": "高级报表", "createBy": "1", "timeStamp": 1531101056741, "usedSpace": 0.0, "myAnalysis": false, "tables": [], "editable": true, "shareAnalysis": false, "tableCount": 12 }, { "id": "dac1c0f5b11f46fcb9eb03280a4c26c5", "name": "用户访问日志", "createBy": "1", "timeStamp": 1534230478653, "usedSpace": 0.0, "myAnalysis": false, "tables": [], "editable": true, "shareAnalysis": false, "tableCount": 9 }, { "id": "731a306065ac4ad496bfcb4bf2910c1b", "name": "第一张仪表板", "createBy": "1", "timeStamp": 1598840033001, "usedSpace": 0.0, "myAnalysis": false, "tables": [], "editable": true, "shareAnalysis": false, "tableCount": 5 }, { "id": "8ef91440df924253856617f53c2d27b9", "name": "样式数据", "createBy": "1", "timeStamp": 1531101065479, "usedSpace": 0.0, "myAnalysis": false, "tables": [], "editable": true, "shareAnalysis": false, "tableCount": 12 } ], "editable": true, "myAnalysis": false, "groups": [] } ], "errorCode": null, "detailErrorMsg": null, "errorMsg": null }) |
| 截图示意 | |
