SmartbiAPI接口说明文档_V1.0.docx

1. 接口设计说明

1.1. 接口设计

详情接口入参以实际接口为准，当前接口为模板接口设计，如无特殊情况，以下所有的接口都使用该模板，详细接口模块仅对paramInfo内容进行详细说明

接口名	** 接口
链接地址	http:// IP : 端口 /smartbi/vision/ api/***
方式	POST
格式	application/json
编码	UTF-8
入参request parameters
smartbiToken	string	token身份验证
paramsInfo	JSON字符串	接口入参，实际参数以接口设计为准
出参 JSON
{ "success": true, "msg": "创建成功", "result": {} }	string	s uccess 为接口成功标识 result 为返回结果对象，以实际接口为准 msg 为提示语

1.2. smartbiToken 说明

结合产品令牌功能：

https://wiki.smartbi.com.cn/pages/viewpage.action?smt_poid=43&pageId=111889065

t oken的结构参考如下 :

{

"timestamp" ：时间戳,

"username" ： "用户名" ,

"password" ： "可选，用户密码" ，

" extend " ：{ " 扩展对象,用于一些额外业务扩展，比如增加系统标识 "

}

使用 smartbi-CryptoUtil.zip 中的 smartbi-CryptoUtil.jar 的工具类的 encrypt 方法（默认使用AES-GCM方式加密）来加密token来获得令牌，其中加密API是：smartbi.crypto.CryptoUtil.encrypt(String, String)。

1.3. paramsInfo 说明

1、入参结构参考如下：JSON对象序列化后的字符串，JSON 结构见示例

单个参数：{"OrderDate":{"values":["2016-01-03"]}}

单个参数多个参数值：

{"OrderDate":{"values":["2016-01-03", "2016-01-06"]}}

多个参数：

{"OrderDate":{"values":["2016-01-03"]},"OrderDate2":{"values":["2016-01-10"]}}

2. 数据准备模块

2.1. 数据源接口

2.1.1. 创建接口

创建关系型数据源接口

1、接口地址：vision/api/datasource/create

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
parentId	String	是	父目录ID，默认为【数据连接】
name	String	否	数据源名称
alias	String	是	数据源别名
connectUserName	String	否	连接用户名
connectPassword	String	否	连接用户密码
maxConnection	Integer	是	最大连接数
driverType	String	否	数据库类型，常见的包含如下： MYSQL：MYSQL数据源 ORACLE：ORACLE数据源 MSSQL ：SQL Server数据源
driverClassName	String	否	驱动类名： - MYSQL: com.mysql.jdbc.Driver - ORACLE: oracle.jdbc.driver.OracleDriver - SQLSERVER: net.sourceforge.jtds .jdbc.Driver
driverCatalog	String	是	驱动目录，当驱动类型及驱动目录不为空时，驱动程序类型将设置为【自定义】
url	String	否	连接字符串
transactionIsolation	Integer	是	事务隔离级别: -1：JDBC默认值 0：关闭事务 1：脏数据读 2：防止脏数据读 4：可重复读 8：串行

3 、接口返回结果信息：返回创建的数据源id字符串

2.1.2. 修改接口

修改关系型数据源接口

1、接口地址：vision/api/datasource/update

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	否	更新的目标数据源ID
alias	String	是	数据源别名
connectUserName	String	否	连接用户名
connectPassword	String	否	连接用户密码
maxConnection	Int	是	最大连接数
driverType	String	否	数据库类型，常见的包含如下： MYSQL：MYSQL数据源 ORACLE：ORACLE数据源 MSSQL ：SQL Server数据源
driverClassName	String	是	驱动类名
driverCatalog	String	是	驱动目录，当驱动类型及驱动目录不为空时，驱动程序类型将设置为【自定义】
url	String	否	连接字符串
transactionIsolation	Integer	是	事务隔离级别: -1：JDBC默认值 0：关闭事务 1：脏数据读 2：防止脏数据读 4：可重复读 8：串行

3、接口返回信息：返回更新的数据源id字符串

2.1.3. 删除接口（ 3.10Smartbi 资源删除接口）

删除关系型数据源接口

2.1.4. 查询接口

1、接口地址：vision/api/datasource/get

2、 paramsInfo参数内容

3、接口返回信息：返回JSON字符串，JSON字符串包括如下信息：

名称	类型	描述
id	String	更新的目标数据源ID
name	String	数据源名称
alias	String	数据源别名
connectUserName	String	连接用户名
connectPassword	String	连接用户密码
maxConnection	Int	最大连接数
driverType	String	数据库类型
driverClassName	String	驱动类名
driverCatalog	String	驱动目录，当驱动类型及驱动目录不为空时，驱动程序类型将设置为【自定义】
url	String	连接字符串
transactionIsolation	Integer	事务隔离级别

2.2. 数据源 Schema 接口

2.2.1. 创建接口

创建Schema接口

1、接口地址：vision/api/schema/create

2、 paramsInfo参数内容

参数名称	参数类型	允许为空	参数描述
dsId	String	否	所属的数据源id
name	String	否	schema名称
catalog	String	是	catalog目录，如MySQL的catalog目录名称
needSync	Boolean	是	创建schema之后，是否需要同步表，默认为true，表示需要同步表，同步后会在该schema下创建所有的表

3、接口返回结果信息：返回创建的schema id字符串

2.2.2. 修改接口

只支持修改shcema名称

1、接口地址：vision/api/schema/update

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	否	schemaId
name	String	是	更新的名称

3、接口返回信息：更新的schema id字符串

2.2.3. 删除接口（ 3.10Smartbi 资源删除接口）

删除schema资源节点

2.2.4. 查询接口（ 3.7 资源目录下的资源信息查询接口）

获取smartbi数据源下创建的schema资源节点

2.3. 数据源 Schema 下表接口（通过 3.2.1schema 同步表即可）

2.3.1. 创建接口

1、接口地址：vision/api/table/create

2、 paramsInfo参数内容：JSONArray数组，内容包括如下

参数名称	参数类型	允许为空	参数描述
dsId	String	否	数据源id
schemaName	String	否	Schema名称
override	Boolean	是	是否覆盖已添加表，默认为false
catalog	String	是	catalog目录，如MySQL的catalog目录名称
tableList	JSONArray	否	添加的表名称列表

3、接口返回信息：无

2.3.2. 修改表资源接口

支持修改smartbi数据表资源节点信息

2.3.3. 删除接口（ 3.10Smartbi 资源删除接口）

支持批量删除

2.3.4. 查询接口（ 3.7 资源目录下的资源信息查询接口）

获取shcema下的表资源节点信息

2.4. 数据源、 schema 、表、字段的授权接口（ 2.9 资源授权接口）

2.5. 数据模型的行权限设置接口

因为行权限接口有很多场景支持，比如函数、字段值、用户属性，场景很复杂，目前接口只考虑简单设置，值与字段值场景

2.5.1. 创建接口

1、接口地址：vision/api/dataperm/create

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	否	设置的表ID
rowpermItems	JSONArray	否	JSON数组，支持的内容包括如下
override	Boolean	是	是否覆盖权限，默认为false，表示不覆盖权限，只做追加
- itemName	String	否	权限名称
- applicable	Integer	是	权限是否适用于传递用户信息，默认为是，即为【适用于】 - 1：适用于 - 0：不适用于
- user	JSONArray	是	授权的用户列表，如[userId1,userId2]
- group	JSONArray	是	授权的用户组列表，如[groupId1,groupId2]
- role	JSONArray	是	授权的角色列表，如[roleId1,roleId2]
- expression	JSONObject	否	数据权限设置，JSON内容包括如下配置
-- type	String	否	关联关系，包括： - FILTER：当前关联关系条件 - EXPRESSION：一组关联关系，
-- fieldId	String	否	当为type为FILTER时有效，为设置的字段id
-- value	String	否	当type为FILTER有效，为设置的值
-- valueKind	String	否	当为type为FILTER时有效，为设置的条件类型，包括： - FIELD：字段 - VALUE: 值
-- valueType	String	是	当type为FILTER时有效，为字段类型，默认为STRING
-- operator	String	否	当type为FILTER，表示条件，支持的内容包括： - =：等于 - like: 模糊匹配 - not like：不匹配 - <>: 不等于 - in：包含 - not in: 不包含 - like ..%：开头为 - like %..: 结尾为 - not like ..%：开头不是 - not like %..: 结尾不是当type为 EXPRESSION，表示条件关系，支持的内容为： - AND: AND条件 - OR: OR条件
-- expressions	JSONArray	否	当type为EXPRESSION时生效，表示为一个新的EXPRESSION，支持的内容与父级的一致，可以进行嵌套使用

3、接口返回信息：JSONArray对象，内容为JSON字符串，返回创建失败的条件的错误信息：

名称	类型	描述
- itemName	String	创建失败的权限名称
- msg	String	创建失败的提示

2.5.2. 查询接口

1、接口地址：vision/api/dataperm/get

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	否	设置的表ID

3、接口返回信息：JSONArray对象，内容为JSON字符串，返回对应表的数据行权限数组

名称	类型	描述
- itemName	String	权限名称
- applicable	Integer	权限是否适用于传递用户信息，默认为是，即为【适用于】 - 1：适用于 - 0：不适用于
- user	JSONArray	授权的用户列表，如[userId1,userId2]
- group	JSONArray	授权的用户组列表，如[groupId1,groupId2]
- role	JSONArray	授权的角色列表，如[roleId1,roleId2]
- expression	JSONObject	数据权限设置，JSON内容包括如下配置
-- type	String	关联关系，包括： - FILTER：当前关联关系条件 - EXPRESSION：一组关联关系，
-- fieldId	String	当为type为FILTER时有效，为设置的字段id
-- value	String	当type为FILTER有效，为设置的值
-- valueKind	String	当为type为FILTER时有效，为设置的条件类型，包括： - FIELD：字段 - VALUE: 值
-- valueType	String	当type为FILTER时有效，为字段类型，默认为STRING
-- operator	String	当type为FILTER，表示条件，支持的内容包括： - =：等于 - like: 模糊匹配 - not like：不匹配 - <>: 不等于 - in：包含 - not in: 不包含 - like ..%：开头为 - like %..: 结尾为 - not like ..%：开头不是 - not like %..: 结尾不是当type为 EXPRESSION，表示条件关系，支持的内容为： - AND: AND条件 - OR: OR条件
-- expressions	JSONArray	当type为EXPRESSION时生效，表示为一个新的EXPRESSION，支持的内容与父级的一致，可以进行嵌套使用

2.6. 资源目录接口

2.6.1. 创建接口

1、接口地址：vision/api/folder/create

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
parentId	String	否	父目录id
name	String	否	目录名称
alias	String	是	目录别名
desc	String	是	目录描述

3、接口返回信息：创建的资源ID字符串

2.6.2. 修改接口

1、接口地址：vision/api/folder/update

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	否	修改的目录id
alias	String	是	目录别名
desc	String	是	目录描述

3、接口返回信息：修改的资源ID字符串

2.6.3. 删除接口（ 3.10Smartbi 资源删除接口）

2.6.4. 查询接口

查询当前当前资源的节点信息，参考【Smartbi资源查询接口】

2.7. 资源下子资源信息查询接口

获取资源目录下的用户有权限访问的所有资源信息，包括目录，支持资源节点类型过滤

1、接口地址：vision/api/resource/getChildList

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	否	查询的目录id
types	JSONArray	是	过滤的资源类型，为字符串数组，格式为：[type1, type2]，如不传递，即不进行类型过滤
includeDescendants	Boolean	是	是否查询迭代查询孙子节点，默认为false
needPath	Boolean	是	是否需要返回路径信息，默认为false

3、接口返回信息：JSONArray数组，内容为JSON字符串，为查询的结果，包含：

名称	类型	描述
- id	String	资源id
- name	String	资源名称
- alias	String	资源别名
- type	String	资源类型

2.8. 数据模型接口

2.8.1. 创建接口

指定某个数据源下面的数据表，生成数据模型，让客户能创建数据模型，并返回创建成功失败的信息 ,

1、接口地址：vision/api/augmented/create

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
pid	String	否	存放的父目录id
name	String	否	数据模型名称
alias	String	是	数据模型别名
storeType	String	是	存储方式，默认为抽取，支持： - DIRECT: 直连 - EXTRACT: 抽取
extractType	String	是	抽取设置，默认为按次抽取: - FULL: 全量抽取 - REALTIME: 按次抽取
views	JSONArray	否	创建的基础表信息，包括的信息如下
- id	String	否	引用的表ID，即数据源-schema下的表的ID
- name	String	否	表名称
- alias	String	是	定义的表别名
dimensions	JSONArray	否	维度字段列表，包含的信息如下
- name	String	否	字段名称
- alias	String	是	字段别名
- viewName	String	否	依赖的表名称，与views中的name对应
- valueType	String	是	字段类型，默认为STRING
measures	JSONArray	否	度量字段列表，包含的信息如下
- name	String	否	字段名称
- alias	String	是	字段别名
- viewName	String	否	依赖的表名称，与views中的name对应
- aggregator	String	是	聚合关系，支持的内容包括，默认为合计： - SUM : 合计 - COUNT : 计数 - AVG : 平均值 - DISTINCT : 唯一计数 - MAX : 最大值 - MIN : 最小值
relations	JSONArray	是	表关系，若为单表可为空，内容包括如下
- srcViewName	String	否	关联表1名称，与views中的name对应
- destViewName	String	否	关联表2名称，与views中的name对应
- linkType	String	否	连接方式，支持的内容包括： - LEFTJOIN: 左连接，即一对多 - RIGHTJOIN: 右连接，即多对一 - INNERJOIN: 内连接，即一对一 - FULLJOIN: 外连接，即一对一
- srcFieldName	String	否	表1的关联字段名称
- destFieldName	String	否	表2的关联字段名称

3、接口返回信息：创建的数据模型ID

2.8.2. 修改接口（不需要）

客户在平台创建好数据模型后，后续操作都是在smartb i上使用，不需要考虑

2.8.3. 删除接口（ 3.10Smartbi 资源删除接口）

2.8.4. 查询接口

查询当前当前资源的节点信息，参考【Smartbi资源查询接口】

2.9. Smartbi 资源授权接口

1、接口地址：vision/api/perm/assignee/resource

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	否	设置的资源id
override	Boolean	是	是否覆盖权限，默认为false，表示不覆盖权限，只做追加
permAuth	JSONArray	否	权限规则，JSON内容包括下方配置
- user	JSONArray	是	授权的用户列表，如[userId1,userId2]
- group	JSONArray	是	授权的用户组列表，如[groupId1,groupId2]
- role	JSONArray	是	授权的角色列表，如[roleId1,roleId2]
- auth	String	是	授予的权限，默认为ref，支持的内容包括： - ref：引用权限 - read: 查看权限 - edit: 编辑权限
- scope	String	是	权限域，默认为NONE，支持的内容包括： - NONE: 只对当前目录 - FOLDER_FILE: 当前目录、子目录及文件 - FOLDER_ONLY:当前目录及子目录 - FILE_ONLY: 该目录及文件

3、接口返回信息：无

2.10. Smartbi 资源接口

2.10.1. Smartbi 资源删除接口

删除指定的smartbi资源节点

1、接口地址：vision/api/resource/delete

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	否	删除的资源id

3、接口返回信息：删除的资源id字符串

2.10.2. Smartbi 资源查询接口

查询当前资源节点的属性信息

1、接口地址：vision/api/resource/ getramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	否	查询的资源id

2、接口返回信息：查询的资源id信息，为JSON字符串，内容包括：

名称	类型	描述
- name	String	错误信息
- alias	String	更新的数据源ID
- path	String	路径
- type	String	类型
- desc	String	描述
-creator	String	创建人
- createtime	String	创建时间

3. 用户角色管理模块（此模块接口暂不支持）

3.1. 用户组接口

3.1.1. 创建接口

1、接口地址：vision/api/group/create

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
parentId	String	是	所属父组id，为空时默认存放到根组（DEPARTMENT）中
id	String	是	组id，为空时自动生成对应的UUID作为组ID
name	String	否	组名称
checkParExist	Boolean	是	默认为false，即不检查父组是否存在，当父组不存在时继续创建，默认放到根组下
alias	String	是	组别名
desc	String	是	组描述
code	String	是	组编号

3、接口返回信息：创建的用户组ID

3.1.2. 修改接口

1、接口地址：vision/api/group/update

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	否	组id
parentId	String	是	父组id
alias	String	是	组别名
desc	String	是	组描述
code	String	是	组编码

3、接口返回信息：修改的用户组ID字符串

3.1.3. 删除接口

1、接口地址：vision/api/group/delete

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	是	删除的组id

3、接口返回信息：删除的组id

3.1.4. 查询接口

1、接口地址：vision/api/group /get

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	是	查询的组id

3、接口返回信息：组信息JSON字符串，内容包括：

名称	类型	描述
name	String	组名称
alias	String	组别名
desc	String	组描述
code	String	组编码
parentId	String	父组id

3.2. 用户接口

3.2.1. 创建接口

1、接口地址：vision/api/user/create

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	是	用户ID，若不传递，自动生成UUID
groupId	String	是	所属父组id，若不传递，默认为根组
checkGroupExist	Boolean	是	默认为false，即不检查父组是否存在，若父组不存在，默认将用户创建到根组（DEPARTMENT）中
name	String	否	用户名称
alias	String	是	用户别名
desc	String	是	用户描述
password	String	是	用户密码，若不传递，默认为UUID，只支持传递明文密码
enabled	Boolean	是	用户启用状态，默认为true，表示启用

3、接口返回信息：创建的用户id

3.2.2. 修改接口

1、接口地址：vision/api/user/update

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	否	可传递用户id或用户名称，因用户名称是唯一的
alias	String	是	用户别名
desc	String	是	用户描述
password	String	是	用户密码，只支持传递明文密码
enabled	Boolean	是	用户启用状态，true表示启用

3、接口返回信息：更新的用户id字符串

3.2.3. 删除接口

1、接口地址：vision/api/user/delete

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	否	可传递用户id或用户名称，因用户名称是唯一的

3、接口返回信息：删除的用户id字符串

3.2.4. 查询接口

1、接口地址：vision/api/user/get

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
id	String	否	可传递用户id或用户名称，因用户名称是唯一的

3、接口返回信息：用户信息JSON字符串，信息包含如下：

名称	类型	描述
id	String	用户id
name	String	用户名称
alias	String	用户别名
desc	String	用户描述
enabled	Boolean	启用状态
groupId	String	默认组id
groupName	String	默认组名称

3.3. 角色接口

3.3.1. 创建接口

1、接口地址：vision/api/role/create

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
name	String	否	角色名称
alias	String	是	角色别名
desc	String	是	角色描述
groupId	String	是	所属组id，默认为根组（DEPARTMENT）
checkGroupExist	Boolean	是	默认为false，即不检查父组是否存在，若父组不存在，默认将用户创建到根组（DEPARTMENT）中

3、接口返回信息：创建的角色id字符串

3.3.2. 修改接口

1、接口地址：vision/api/role/update

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
name	String	否	角色名称，根据角色名称获取角色
alias	String	是	角色别名
desc	String	是	角色描述

3、接口返回信息：修改的角色id字符串

3.3.3. 删除接口

1、接口地址：vision/api/role/delete

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
name	String	否	角色名称，根据角色名称获取角色

3、接口返回信息：删除的角色id字符串

3.3.4. 查询接口

1、接口地址：vision/api/role/get

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
name	String	否	角色名称，根据角色名称获取角色

3、接口返回信息：角色信息JSON字符串，信息包括：

名称	类型	描述
id	String	角色id
name	String	角色名称
alias	String	角色别名
desc	String	角色描述
groupId	String	默认组id
groupName	String	默认组名称

3.4. 用户 & 用户组关联接口

3.4.1. 添加用户所属用户组

1、接口地址：vision/api/usergroup/update

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
userid	String	否	可传递用户id或用户名称，因用户名称是唯一的
groupList	JSONArray	否	添加的用户组列表，格式如：[groupId1,groupId2]
defaultGroupId	String	是	用户所属的默认组，若不传递则不改变默认组，若是覆盖默认，不传递时默认以传递的用户组列表第一个作为默认值
override	Boolean	是	默认为false，即为追加默认，为true表示覆盖

3、接口返回信息：JSONArray数组，返回添加失败的用户组信息，信息包括如下

名称	类型	描述
- id	String	创建失败的用户组id
- msg	String	创建失败原因

3.4.2. 删除用户所属用户组

1、接口地址：vision/api/usergroup/delete

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
userid	String	否	可传递用户id或用户名称，因用户名称是唯一的
groupList	JSONArray	否	删除的用户组列表，格式如：[groupId1,groupId2]

3、接口返回信息：无

3.4.3. 查询用户所属用户组

1、接口地址：vision/api/usergroup/get

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
userid	String	否	可传递用户id或用户名称，因用户名称是唯一的

3、接口返回信息：JSONArray数组，返回用户拥有的用户组列表，信息包括：

名称	类型	描述
- id	String	用户组id
- name	String	用户组名称
- alias	String	用户组别名
- desc	String	用户组描述
- code	String	用户组编号

3.5. 角色 & 用户组关联接口

3.5.1. 添加角色所属用户组

1、接口地址：vision/api/rolegroup/update

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
rolename	String	否	角色名称，用于做角色获取
groupList	JSONArray	否	添加的用户组列表，格式如：[groupId1,groupId2]
override	Boolean	是	默认为false，即为追加默认，为true表示覆盖

3、接口返回信息：JSONArray数组，返回添加失败的用户组信息，信息包括如下

名称	类型	描述
- id	String	创建失败的用户组id
- msg	String	创建失败原因

3.5.2. 删除角色所属用户组

1、接口地址：vision/api/rolegroup/delete

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
rolename	String	否	角色名称，用于做角色获取
groupList	JSONArray	否	删除的用户组列表，格式如：[groupId1,groupId2]

3、接口返回信息：无

3.5.3. 查询角色所属用户组

1、接口地址：vision/api/rolegroup/get

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
rolename	String	否	角色名称，用于做角色获取

3、接口返回信息：JSONArray数组，返回角色赋予的用户组列表，信息包括：

名称	类型	描述
- id	String	用户组id
- name	String	用户组名称
- alias	String	用户组别名
- desc	String	用户组描述

3.6. 用户 & 角色关联接口

3.6.1. 添加用户所属角色

1、接口地址：vision/api/userrole/update

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
userid	String	否	可传递用户id或用户名称，因用户名称是唯一的
roleList	JSONArray	否	添加的角色列表，格式如：[roleName1,roleName2]，传递角色名称
override	Boolean	是	默认为false，即为追加默认，为true表示覆盖

3、接口返回信息：JSONArray数组，返回添加失败的用户组信息，信息包括如下

名称	类型	描述
- id	String	创建失败的角色名称
- msg	String	创建失败原因

3.6.2. 删除用户所属角色

1、接口地址：vision/api/userrole/delete

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
userid	String	否	可传递用户id或用户名称，因用户名称是唯一的
roleList	JSONArray	否	删除的角色列表，格式如：[roleId1,roleId2]，支持传递id或名称

3、接口返回信息：无

3.6.3. 查询用户拥有的角色

1、接口地址：vision/api/userrole/get

2、 paramsInfo参数内容：

参数名称	参数类型	允许为空	参数描述
userid	String	否	可传递用户id或用户名称，因用户名称是唯一的

3、接口返回信息：JSONArray数组，返回用户拥有的用户组列表，信息包括：

名称	类型	描述
- id	String	角色id
- name	String	角色名称
- alias	String	角色别名
- desc	String	角色描述

页面树结构

SmartbiAPI接口说明文档_V1.0.docx

1. 接口设计说明

1.1. 接口设计

1.2. smartbiToken 说明

1.3. paramsInfo 说明

2. 数据准备模块

2.1. 数据源 接口

2.1.1. 创建接口

2.1.2. 修改接口

2.1.3. 删除接口（ 3.10Smartbi 资源删除接口）

2.1.4. 查询接口

2.2. 数据源 Schema 接口

2.2.1. 创建接口

2.2.2. 修改接口

2.2.3. 删除接口（ 3.10Smartbi 资源删除接口）

2.2.4. 查询接口（ 3.7 资 源目录下的资源信息查询接口 ）

2.3. 数据源 Schema 下表接口（通过 3.2.1schema 同步表即可）

2.3.1. 创建接口

2.3.2. 修改表资源接口

2.3.3. 删除接口（ 3.10Smartbi 资源删除接口）

2.3.4. 查询接口（ 3.7 资 源目录下的资源信息查询接口 ）

2.4. 数据源、 schema 、表、字段的授权接口 （ 2.9 资源授权接口）

2.5. 数据模型 的行权限设置接口

2.5.1. 创建接口

2.5.2. 查询接口

2.6. 资源目录接口

2.6.1. 创建接口

2.6.2. 修改接口

2.6.3. 删除接口（ 3.10Smartbi 资源删除接口）

2.6.4. 查询接口

2.7. 资源下 子 资源信息查询接口

2.8. 数据模型接口

2.8.1. 创建接口

2.8.2. 修改接口（不需要）

2.8.3. 删除接口（ 3.10Smartbi 资源删除接口）

2.8.4. 查询接口

2.9. Smartbi 资源 授权接口

2.10. Smartbi 资源 接口

2.10.1. Smartbi 资源删除接口

2.10.2. Smartbi 资源查询接口

3. 用户角色管理模块（此模块接口暂不支持）

3.1. 用户组接口

3.1.1. 创建接口

3.1.2. 修改接口

3.1.3. 删除接口

3.1.4. 查询接口

3.2. 用户接口

3.2.1. 创建接口

3.2.2. 修改接口

3.2.3. 删除接口

3.2.4. 查询接口

3.3. 角色接口

3.3.1. 创建接口

3.3.2. 修改接口

3.3.3. 删除接口

3.3.4. 查询接口

3.4. 用户 & 用户组关联接口

3.4.1. 添加用户所属用户组

3.4.2. 删除用户所属用户组

3.4.3. 查询用户所属用户组

3.5. 角色 & 用户组关联接口

3.5.1. 添加角色所属用户组

3.5.2. 删除角色所属用户组

3.5.3. 查询角色所属用户组

3.6. 用户 & 角色关联接口

3.6.1. 添加用户所属角色

3.6.2. 删除用户所属角色

3.6.3. 查询用户拥有的角色

2.1. 数据源接口

2.2.4. 查询接口（ 3.7 资源目录下的资源信息查询接口）

2.3.4. 查询接口（ 3.7 资源目录下的资源信息查询接口）

2.4. 数据源、 schema 、表、字段的授权接口（ 2.9 资源授权接口）

2.5. 数据模型的行权限设置接口

2.7. 资源下子资源信息查询接口

2.9. Smartbi 资源授权接口

2.10. Smartbi 资源接口