目录搜索

暂无相关搜索结果！

本文档使用 MinDoc 发布

数据集管理

根据数据集key构建树
获取字段列表
获取全部数据源
根据数据集key构建树
根据传入id查询，并返回数据集信息
根据传入key查询，并返回数据集信息
获取数据集树结构
数据集列表(分页条件查询)数据
数据源查询
删除(批量)
保存
设置分类
获取表列表
sql语句校验
备注

根据数据集key构建树

简述：

根据数据集key构建树

请求URL：

http://ip:port/ibps/platform/v3/data/dataset/buildTree
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
datasetKey	String	是		数据集KEY

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/business/v3/data/dataset/buildTree?datasetKey=sykj

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": [
        {
            "id": "675125181785571328",
            "label": "所有控件",
            "name": "t_sykj",
            "parentId": "0",
            "type": "table",
            "attrType": "table",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-table"
        },
        {
            "id": "675125181785571329",
            "label": "主键",
            "name": "id_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "Y",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571330",
            "label": "租户ID",
            "name": "tenant_id_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571331",
            "label": "IP地址",
            "name": "ip_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571332",
            "label": "创建人",
            "name": "create_by_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571333",
            "label": "创建时间",
            "name": "create_time_",
            "parentId": "675125181785571328",
            "type": "date",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-date"
        },
        {
            "id": "675125181785571334",
            "label": "更新人",
            "name": "update_by_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571335",
            "label": "更新时间",
            "name": "update_time_",
            "parentId": "675125181785571328",
            "type": "date",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-date"
        },
        {
            "id": "675125181785571336",
            "label": "单行",
            "name": "shan_hang_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571337",
            "label": "多行",
            "name": "duo_heng_",
            "parentId": "675125181785571328",
            "type": "clob",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-clob"
        },
        {
            "id": "675125181785571338",
            "label": "数字",
            "name": "shuo_zi_",
            "parentId": "675125181785571328",
            "type": "number",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-number"
        },
        {
            "id": "675125181785571339",
            "label": "单选",
            "name": "chan_xuan_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571340",
            "label": "多选",
            "name": "duo_xuan_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571341",
            "label": "日期",
            "name": "ri_ji_",
            "parentId": "675125181785571328",
            "type": "date",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-date"
        },
        {
            "id": "675125181785571342",
            "label": "下拉框",
            "name": "xia_la_kuang_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571343",
            "label": "富文本",
            "name": "fu_wen_ben_",
            "parentId": "675125181785571328",
            "type": "clob",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-clob"
        },
        {
            "id": "675125181785571344",
            "label": "数据字典",
            "name": "shuo_ju_zi_dian_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571345",
            "label": "自动编号",
            "name": "zi_dong_bian_hao_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571346",
            "label": "附件",
            "name": "fu_jian_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571347",
            "label": "选择器",
            "name": "xuan_ze_qi_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571348",
            "label": "地址",
            "name": "de_zhi_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571349",
            "label": "签名",
            "name": "qian_ming_",
            "parentId": "675125181785571328",
            "type": "clob",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-clob"
        },
        {
            "id": "675125181785571350",
            "label": "当前用户",
            "name": "dang_qian_yong_hu_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571351",
            "label": "当前组织",
            "name": "dang_qian_zu_zhi_",
            "parentId": "675125181785571328",
            "type": "varchar",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-varchar"
        },
        {
            "id": "675125181785571352",
            "label": "当前时间",
            "name": "qian_shi_jian_",
            "parentId": "675125181785571328",
            "type": "date",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-date"
        },
        {
            "id": "675125181785571353",
            "label": "当前日期",
            "name": "dang_qian_ri_ji_",
            "parentId": "675125181785571328",
            "type": "date",
            "attrType": "column",
            "objName": "t_sykj",
            "isPk": "N",
            "icon": "fa fa-date"
        }
    ]
}

返回参数说明：

名称	类型	备注
data	List< DatasetTreeVo >	构建数据集树

获取字段列表

简述：

获取字段列表

请求URL：

http://ip:port/ibps/platform/v3/data/dataset/columnList
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

DatasetVo 对象信息

名称	类型	是否必须	备注
id	String	否	主键
name	String	是	名称
key	String	是	数据集KEY
typeId	String		type_id_
type	String	是	类型（表、视图、SQL、外部数据源等）
external	String	是	是否外部数据源
dsAlias	String	是	数据源别名
from	String	是	来源
sql	String	是	SQL语句
isTree	String	是	是否树型
refField	String		关联字段
params	String		参数
createBy	String		创建人ID
createTime	date		创建时间
updateBy	date		更新人ID
updateTime	String		更新时间
queryName	String	是
datasetKey	String	是

请求参数示例：

{
    "pk": "",
    "name": "回填关联数据",
    "ip": null,
    "createBy": "1",
    "createTime": "2020-01-19 14:37:52",
    "updateBy": null,
    "updateTime": null,
    "tenantId": null,
    "dataStatus": null,
    "dbtype": null,
    "id": "668464145401643008",
    "key": "htglsj",
    "typeId": "654701857142210560",
    "type": "table",
    "external": "N",
    "dsAlias": "dataSource_default",
    "from": "htglsj",
    "sql": null,
    "isTree": "N",
    "refField": null,
    "params": null,
    "typeName": null,
    "queryName": "",
    "datasetKey": ""
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": [
        {
            "comment": "主键",
            "id": "id_",
            "text": "id_"
        },
        {
            "comment": "租户ID",
            "id": "tenant_id_",
            "text": "tenant_id_"
        },
        {
            "comment": "IP地址",
            "id": "ip_",
            "text": "ip_"
        },
        {
            "comment": "创建人",
            "id": "create_by_",
            "text": "create_by_"
        },
        {
            "comment": "创建时间",
            "id": "create_time_",
            "text": "create_time_"
        },
        {
            "comment": "更新人",
            "id": "update_by_",
            "text": "update_by_"
        },
        {
            "comment": "更新时间",
            "id": "update_time_",
            "text": "update_time_"
        },
        {
            "comment": "单行",
            "id": "dan_xing_",
            "text": "dan_xing_"
        },
        {
            "comment": "多行",
            "id": "duo_xing_",
            "text": "duo_xing_"
        },
        {
            "comment": "数字",
            "id": "shu_zi_",
            "text": "shu_zi_"
        },
        {
            "comment": "单选",
            "id": "dan_xuan_",
            "text": "dan_xuan_"
        },
        {
            "comment": "多选",
            "id": "duo_xuan_",
            "text": "duo_xuan_"
        },
        {
            "comment": "下拉",
            "id": "xia_la_",
            "text": "xia_la_"
        },
        {
            "comment": "日期",
            "id": "ri_qi_",
            "text": "ri_qi_"
        },
        {
            "comment": "富文本",
            "id": "fu_wen_ben_",
            "text": "fu_wen_ben_"
        },
        {
            "comment": "自动编号",
            "id": "zi_dong_bian_hao_",
            "text": "zi_dong_bian_hao_"
        },
        {
            "comment": "数据字典",
            "id": "shu_ju_zi_dian_",
            "text": "shu_ju_zi_dian_"
        },
        {
            "comment": "选择器",
            "id": "xuan_ze_qi_",
            "text": "xuan_ze_qi_"
        },
        {
            "comment": "关联数据",
            "id": "guan_lian_shu_ju_",
            "text": "guan_lian_shu_ju_"
        },
        {
            "comment": "对话框",
            "id": "dui_hua_kuang_",
            "text": "dui_hua_kuang_"
        }
    ]
}

返回参数说明：

名称	类型	备注
data	List<Map<String, String>>

获取全部数据源

简述：

获取全部数据源

请求URL：

http://ip:port/ibps/platform/v3/data/dataset/findAllDataSourceVo
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/business/v3/data/dataset/findAllDataSourceVo

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": [
        {
            "alias": "dataSource_default",
            "name": "def",
            "dbType": "mysql",
            "driver": "com.mysql.jdbc.Driver",
            "driverUrl": "jdbc:mysql://192.168.3.210:3306/ibps_business_test_v3.2.0?useUnicode=true&characterEncoding=utf-8",
            "port": null,
            "poolType": null,
            "user": "root",
            "password": "root",
            "comment": null,
            "status": "actived",
            "isDefault": true,
            "variables": {
                "minIdle": "20",
                "validationQuery": "SELECT 'x'",
                "initialSize": "20",
                "maxWait": "3600000",
                "poolPreparedStatements": "true",
                "filters": "stat",
                "maxPoolPreparedStatementPerConnectionSize": "20",
                "logAbandoned": "true",
                "testOnBorrow": "false",
                "testWhileIdle": "true",
                "removeAbandoned": "true",
                "timeBetweenEvictionRunsMillis": "3600000",
                "minEvictableIdleTimeMillis": "300000",
                "testOnReturn": "false",
                "removeAbandonedTimeout": "1800",
                "maxActive": "200"
            },
            "param": null,
            "default": true,
            "leader": false,
            "follower": false
        }
    ]
}

返回参数说明：

名称	类型	备注
data	List< DataSourceVo >	数据源Vo

根据数据集key构建树

简述：

根据数据集key构建树

请求URL：

http://ip:port/ibps/platform/v3/data/dataset/findColumnList
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

DatasetVo 对象信息

名称	类型	是否必须	备注
id	String	否	主键
name	String	是	名称
key	String	是	数据集KEY
typeId	String		type_id_
type	String	是	类型（表、视图、SQL、外部数据源等）
external	String	是	是否外部数据源
dsAlias	String	是	数据源别名
from	String	是	来源
sql	String	是	SQL语句
isTree	String	是	是否树型
refField	String		关联字段
params	String		参数
createBy	String		创建人ID
createTime	date		创建时间
updateBy	date		更新人ID
updateTime	String		更新时间
queryName	String	是
datasetKey	String	是

请求参数示例：

{
    "pk": "",
    "name": "关联数据（查询）",
    "ip": null,
    "createBy": "1",
    "createTime": "2020-01-19 14:23:36",
    "updateBy": null,
    "updateTime": null,
    "tenantId": null,
    "dataStatus": null,
    "dbtype": null,
    "id": "668460554397941760",
    "key": "glsjcx",
    "typeId": "654701857142210560",
    "type": "table",
    "external": "N",
    "dsAlias": "dataSource_default",
    "from": "glsjcx",
    "sql": null,
    "isTree": "N",
    "refField": null,
    "params": null,
    "typeName": null,
    "queryName": "",
    "datasetKey": ""
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": [
        {
            "comment": "主键",
            "id": "id_",
            "text": "id_"
        }
    ]
}

返回参数说明：

名称	类型	备注
data	List<Map<String, String>>

根据传入id查询，并返回数据集信息

简述：

根据传入id查询，并返回数据集信息

请求URL：

http://ip:port/ibps/platform/v3/data/dataset/get
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
datasetId	String	是		数据集id

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/business/v3/data/dataset/get?datasetId=668464145401643008

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "pk": "",
        "name": "回填关联数据",
        "ip": null,
        "createBy": "1",
        "createTime": "2020-01-19 14:37:52",
        "updateBy": null,
        "updateTime": null,
        "tenantId": null,
        "dataStatus": null,
        "dbtype": null,
        "id": "668464145401643008",
        "key": "htglsj",
        "typeId": "654701857142210560",
        "type": "table",
        "external": "N",
        "dsAlias": "dataSource_default",
        "from": "htglsj",
        "sql": null,
        "isTree": "N",
        "refField": null,
        "params": null,
        "typeName": null
    }
}

返回参数说明：

名称	类型	备注
data	DatasetPo	数据集对象

根据传入key查询，并返回数据集信息

简述：

根据传入key查询，并返回数据集信息

请求URL：

http://ip:port/ibps/platform/v3/data/dataset/getByKey
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
datasetKey	String	是		数据集key

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/business/v3/data/dataset/getByKey?datasetKey=htglsj

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "pk": "",
        "name": "回填关联数据",
        "ip": null,
        "createBy": "1",
        "createTime": "2020-01-19 14:37:52",
        "updateBy": null,
        "updateTime": null,
        "tenantId": null,
        "dataStatus": null,
        "dbtype": null,
        "id": "668464145401643008",
        "key": "htglsj",
        "typeId": "654701857142210560",
        "type": "table",
        "external": "N",
        "dsAlias": "dataSource_default",
        "from": "htglsj",
        "sql": null,
        "isTree": "N",
        "refField": null,
        "params": null,
        "typeName": null
    }
}

返回参数说明：

名称	类型	备注
data	DatasetPo	数据集对象

获取数据集树结构

简述：

获取数据集树结构

请求URL：

http://ip:port/ibps/platform/v3/data/dataset/getDatasetTree
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
datasetKey	String	是		数据集key

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/business/v3/data/dataset/getDatasetTree?datasetKey=htglsj

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": "[{\"isPk\":\"N\",\"icon\":\"fa fa-table\",\"name\":\"htglsj\",\"id\":\"675150135751081984\",\"label\":\"回填关联数据\",\"objName\":\"htglsj\",\"type\":\"table\",\"attrType\":\"table\",\"parentId\":\"0\"},{\"isPk\":\"Y\",\"icon\":\"fa fa-varchar\",\"name\":\"id_\",\"id\":\"675150135751081985\",\"label\":\"主键\",\"objName\":\"htglsj\",\"type\":\"varchar\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-varchar\",\"name\":\"tenant_id_\",\"id\":\"675150135751081986\",\"label\":\"租户ID\",\"objName\":\"htglsj\",\"type\":\"varchar\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-varchar\",\"name\":\"ip_\",\"id\":\"675150135751081987\",\"label\":\"IP地址\",\"objName\":\"htglsj\",\"type\":\"varchar\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-varchar\",\"name\":\"create_by_\",\"id\":\"675150135751081988\",\"label\":\"创建人\",\"objName\":\"htglsj\",\"type\":\"varchar\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-date\",\"name\":\"create_time_\",\"id\":\"675150135751081989\",\"label\":\"创建时间\",\"objName\":\"htglsj\",\"type\":\"date\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-varchar\",\"name\":\"update_by_\",\"id\":\"675150135751081990\",\"label\":\"更新人\",\"objName\":\"htglsj\",\"type\":\"varchar\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-date\",\"name\":\"update_time_\",\"id\":\"675150135751081991\",\"label\":\"更新时间\",\"objName\":\"htglsj\",\"type\":\"date\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-varchar\",\"name\":\"dan_xing_\",\"id\":\"675150135751081992\",\"label\":\"单行\",\"objName\":\"htglsj\",\"type\":\"varchar\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-clob\",\"name\":\"duo_xing_\",\"id\":\"675150135751081993\",\"label\":\"多行\",\"objName\":\"htglsj\",\"type\":\"clob\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-number\",\"name\":\"shu_zi_\",\"id\":\"675150135751081994\",\"label\":\"数字\",\"objName\":\"htglsj\",\"type\":\"number\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-varchar\",\"name\":\"dan_xuan_\",\"id\":\"675150135751081995\",\"label\":\"单选\",\"objName\":\"htglsj\",\"type\":\"varchar\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-varchar\",\"name\":\"duo_xuan_\",\"id\":\"675150135751081996\",\"label\":\"多选\",\"objName\":\"htglsj\",\"type\":\"varchar\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-varchar\",\"name\":\"xia_la_\",\"id\":\"675150135751081997\",\"label\":\"下拉\",\"objName\":\"htglsj\",\"type\":\"varchar\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-date\",\"name\":\"ri_qi_\",\"id\":\"675150135751081998\",\"label\":\"日期\",\"objName\":\"htglsj\",\"type\":\"date\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-clob\",\"name\":\"fu_wen_ben_\",\"id\":\"675150135751081999\",\"label\":\"富文本\",\"objName\":\"htglsj\",\"type\":\"clob\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-varchar\",\"name\":\"zi_dong_bian_hao_\",\"id\":\"675150135751082000\",\"label\":\"自动编号\",\"objName\":\"htglsj\",\"type\":\"varchar\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-varchar\",\"name\":\"shu_ju_zi_dian_\",\"id\":\"675150135751082001\",\"label\":\"数据字典\",\"objName\":\"htglsj\",\"type\":\"varchar\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-varchar\",\"name\":\"xuan_ze_qi_\",\"id\":\"675150135751082002\",\"label\":\"选择器\",\"objName\":\"htglsj\",\"type\":\"varchar\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-varchar\",\"name\":\"guan_lian_shu_ju_\",\"id\":\"675150135751082003\",\"label\":\"关联数据\",\"objName\":\"htglsj\",\"type\":\"varchar\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"},{\"isPk\":\"N\",\"icon\":\"fa fa-varchar\",\"name\":\"dui_hua_kuang_\",\"id\":\"675150135751082004\",\"label\":\"对话框\",\"objName\":\"htglsj\",\"type\":\"varchar\",\"attrType\":\"column\",\"parentId\":\"675150135751081984\"}]"
}

返回参数说明：

名称	类型	备注
data	String

数据集列表(分页条件查询)数据

简述：

数据集列表(分页条件查询)数据

请求URL：

http://ip:port/ibps/platform/v3/data/dataset/query
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

名称	类型	是否必须	默认值	备注	其他信息
request	APIRequest^[1]	是		动态查询请求对象

请求参数示例：

{
    "parameters": [],
    "requestPage": {
        "pageNo": 1,
        "limit": 20
    },
    "sorts": []
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "dataResult": [
            {
                "pk": "",
                "name": "回填关联数据",
                "ip": null,
                "createBy": "1",
                "createTime": "2020-01-19 14:37:52",
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "668464145401643008",
                "key": "htglsj",
                "typeId": "654701857142210560",
                "type": "table",
                "external": "N",
                "dsAlias": "dataSource_default",
                "from": "htglsj",
                "sql": null,
                "isTree": "N",
                "refField": null,
                "params": null,
                "typeName": null
            },
            {
                "pk": "",
                "name": "关联数据（查询）",
                "ip": null,
                "createBy": "1",
                "createTime": "2020-01-19 14:23:36",
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "668460554397941760",
                "key": "glsjcx",
                "typeId": "654701857142210560",
                "type": "table",
                "external": "N",
                "dsAlias": "dataSource_default",
                "from": "glsjcx",
                "sql": null,
                "isTree": "N",
                "refField": null,
                "params": null,
                "typeName": null
            },
            {
                "pk": "",
                "name": "主表公式",
                "ip": null,
                "createBy": "1",
                "createTime": "2020-01-19 10:51:50",
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "668407261470654464",
                "key": "zbgs",
                "typeId": "654701857142210560",
                "type": "table",
                "external": "N",
                "dsAlias": "dataSource_default",
                "from": "zbgs",
                "sql": null,
                "isTree": "N",
                "refField": null,
                "params": null,
                "typeName": null
            }
        ],
        "pageResult": {
            "limit": 3,
            "page": 1,
            "totalCount": 54,
            "totalPages": 18
        }
    }
}

返回参数说明：

名称	类型	备注
data	APIPageList< DatasetPo >	数据集对象

数据源查询

简述：

数据源查询

请求URL：

http://ip:port/ibps/platform/v3/msg/innerMessage/query/dataSource
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/business/v3/data/dataset/query/dataSource

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "dataResult": [
            {
                "alias": "dataSource_default",
                "name": "def",
                "dbType": "mysql",
                "driver": "com.mysql.jdbc.Driver",
                "driverUrl": "jdbc:mysql://192.168.3.210:3306/ibps_business_test_v3.2.0?useUnicode=true&characterEncoding=utf-8",
                "port": null,
                "poolType": null,
                "user": "root",
                "password": "root",
                "comment": null,
                "status": "actived",
                "isDefault": true,
                "variables": {
                    "minIdle": "20",
                    "validationQuery": "SELECT 'x'",
                    "initialSize": "20",
                    "maxWait": "3600000",
                    "poolPreparedStatements": "true",
                    "filters": "stat",
                    "maxPoolPreparedStatementPerConnectionSize": "20",
                    "logAbandoned": "true",
                    "testOnBorrow": "false",
                    "testWhileIdle": "true",
                    "removeAbandoned": "true",
                    "timeBetweenEvictionRunsMillis": "3600000",
                    "minEvictableIdleTimeMillis": "300000",
                    "testOnReturn": "false",
                    "removeAbandonedTimeout": "1800",
                    "maxActive": "200"
                },
                "param": null,
                "default": true,
                "leader": false,
                "follower": false
            }
        ],
        "pageResult": null
    }
}

返回参数说明：

名称	类型	备注
data	APIPageList< DataSourceVo >	数据源Vo

删除(批量)

简述：

删除(批量)

请求URL：

http://ip:port/ibps/platform/v3/data/dataset/remove
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
datasetIds	String[]	是		数据集ids

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/business/v3/data/dataset/remove?datasetIds=675151735982915584

返回示例：

{
    "state": 200,
    "request": null,
    "message": "删除数据集成功",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明：

名称	类型	备注
data	Void

保存

简述：

保存数据集信息

请求URL：

http://ip:port/ibps/platform/v3/data/dataset/save
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

DatasetPo 对象信息

名称	类型	是否必须	备注
id	String	否	主键
name	String	是	名称
key	String	是	数据集KEY
typeId	String		type_id_
type	String	是	类型（表、视图、SQL、外部数据源等）
external	String	是	是否外部数据源
dsAlias	String	是	数据源别名
from	String	是	来源
sql	String	是	SQL语句
isTree	String	是	是否树型
refField	String		关联字段
params	String		参数
createBy	String		创建人ID
createTime	date		创建时间
updateBy	date		更新人ID
updateTime	String		更新时间

请求参数示例：

{
    "name": "test",
    "key": "test",
    "typeId": "",
    "type": "table",
    "external": "N",
    "dsAlias": "dataSource_default",
    "from": "t_test",
    "sql": null,
    "isTree": "N",
    "refField": null,
    "params": null,
    "typeName": null
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "保存数据集成功",
    "cause": "",
    "variables": {
        "id": "675152407490985984"
    },
    "data": null
}

返回参数说明：

名称	类型	备注
data	Void

设置分类

简述：

设置分类

请求URL：

http://ip:port/ibps/platform/v3/data/dataset/setCategory
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
datasetIds	String[]	是		数据集id数组
typeId	String	是		分类id

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/business/v3/data/dataset/setCategory?datasetIds=675152407490985984&typeId=654701857142210560

返回示例：

{
    "state": 200,
    "request": null,
    "message": "设置分类成功!",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明：

名称	类型	备注
data	Void

获取表列表

简述：

获取表列表

请求URL：

http://ip:port/ibps/platform/v3/data/dataset/tableOrViewList
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

DatasetVo 对象信息

名称	类型	是否必须	备注
id	String	否	主键
name	String	是	名称
key	String	是	数据集KEY
typeId	String		type_id_
type	String	是	类型（表、视图、SQL、外部数据源等）
external	String	是	是否外部数据源
dsAlias	String	是	数据源别名
from	String	是	来源
sql	String	是	SQL语句
isTree	String	是	是否树型
refField	String		关联字段
params	String		参数
createBy	String		创建人ID
createTime	date		创建时间
updateBy	date		更新人ID
updateTime	String		更新时间

请求参数示例：

{
    "pk": "",
    "name": "test",
    "ip": null,
    "createBy": "654384477392338944",
    "createTime": "2020-02-07 01:31:58",
    "updateBy": null,
    "updateTime": null,
    "tenantId": null,
    "dataStatus": null,
    "dbtype": null,
    "id": "675151735982915584",
    "key": "test",
    "typeId": "",
    "type": "table",
    "external": "N",
    "dsAlias": "dataSource_default",
    "from": "t_test",
    "sql": null,
    "isTree": "N",
    "refField": null,
    "params": null,
    "typeName": null
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": [
        {
            "comment": "test",
            "id": "t_test",
            "text": "t_test"
        }
    ]
}

返回参数说明：

名称	类型	备注
data	Map<String, String>

sql语句校验

简述：

sql语句校验

请求URL：

http://ip:port/ibps/platform/v3/data/dataset/validate
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

DatasetVo 对象信息

名称	类型	是否必须	备注
id	String	否	主键
name	String	是	名称
key	String	是	数据集KEY
typeId	String		type_id_
type	String	是	类型（表、视图、SQL、外部数据源等）
external	String	是	是否外部数据源
dsAlias	String	是	数据源别名
from	String	是	来源
sql	String	是	SQL语句
isTree	String	是	是否树型
refField	String		关联字段
params	String		参数
createBy	String		创建人ID
createTime	date		创建时间
updateBy	date		更新人ID
updateTime	String		更新时间

请求参数示例：

{
    "pk": "",
    "name": "test",
    "ip": null,
    "createBy": "654384477392338944",
    "createTime": "2020-02-07 01:31:58",
    "updateBy": null,
    "updateTime": null,
    "tenantId": null,
    "dataStatus": null,
    "dbtype": null,
    "id": "675151735982915584",
    "key": "test",
    "typeId": "",
    "type": "table",
    "external": "N",
    "dsAlias": "dataSource_default",
    "from": "t_test",
    "sql": "select * from t_test",
    "isTree": "N",
    "refField": null,
    "params": null,
    "typeName": null
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "校验成功",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明：

名称	类型	备注
data	String

备注

[1] : APIRequest为动态查询请求对象，详情请移步全局请求格式

文档更新时间: 2020-02-07 01:43 作者：朱业成