最新历史版本 :上传数据表 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

1. 概述编辑

本页面所有接口均需要临时令牌。请先使用您的 accessKeyId 和 accessKeySecret 获取,详见 登录认证

访问接口时在设置中将 Value 替换为您的临时令牌。

1.png

2. 开启API数据源编辑

接口简介:



接口作用开启API数据源
接口URL/api/v1/datasource/status/modify
请求参数{"status":"1"}
请求类型POST

响应实例:




请求示例

https://work.jiushuyun.com/decision/api/v1/datasource/status/modify

响应成功

{

    "success": true,

    "code": "200",

    "message": "success",

    "data": [],

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

}

截图示例

Group 28.png

开启后,可在数据连接市场看到 API 数据源入口。如下图所示:
Group 29.png

3. 分组管理编辑

3.1 创建分组

接口简介:



接口作用创建分组
接口URL

/api/v1/datasource/group/create

请求参数{"groupName":"#分组名"}
请求类型POST

响应实例:



请求示例

https://work.jiushuyun.com/decision/api/v1/datasource/group/create

响应成功

{

    "success": true,

    "code": "200",

    "message": "success",

    "data": "c65201928c874a41bdb7ee199b2684db",

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

}

截图示例

Group 30.png


3.2 读取所有分组

接口简介:



接口作用读取所有分组
接口URL

/api/v1/datasource/group/list

请求类型POST

响应实例:



请求示例

https://work.jiushuyun.com/decision/api/v1/datasource/group/list

响应成功

{

    "success": true,

    "code": "200",

    "message": "success",

    "data": [

        {

            "id": "34e7e1bee25e42c8a7e48cb6096c9ec5",

            "name": "API测试"

        },

        {

            "id": "c65201928c874a41bdb7ee199b2684db",

            "name": "API 数据表"

        }

    ],

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

}

截图示例

Group 31.png

3.3 读取分组下的所有表

接口简介:



接口作用读取分组下的所有表
接口URL

/api/v1/datasource/group/table/list

请求参数{"groupId":"#分组Id"}
请求类型POST

响应实例:



请求示例

https://work.jiushuyun.com/decision/api/v1/datasource/group/table/list

响应成功

{

    "success": true,

    "code": "200",

    "message": "success",

    "data": [

        {

            "id": "d38dd9f6ead140648535275496a4177c",

            "name": "销售数据表"

        }

    ],

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

}


截图示例

Group 32.png

3.4 修改分组名

接口简介:



接口作用修改分组名
接口URL

/api/v1/datasource/group/modify

请求参数{"groupId":"#分组Id","groupName":"#新的分组名"}
请求类型POST

响应实例:




请求示例

https://work.jiushuyun.com/decision/api/v1/datasource/group/modify

响应成功

{

    "success": true,

    "code": "200",

    "message": "success",

    "data": [],

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

}

截图示例

Group 33.png

3.5 删除分组

接口简介:



接口作用删除分组(分组下有表存在时无法删除)
接口URL

/api/v1/datasource/group/delete

请求参数{"groupId":"#分组Id"}
请求类型POST

响应实例:



请求示例

https://work.jiushuyun.com/decision/api/v1/datasource/group/delete

响应成功

{

    "success": true,

    "code": "200",

    "message": "success",

    "data": [],

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

}

截图示例

Group 34.png

4. 表管理编辑

4.1 创建数据源表

接口简介:



接口作用创建数据源表
接口URL

/api/v1/datasource/table/create

请求参数{"tableName":"#表名","groupId":"#分组Id","updateMode":1(可选1,2,3或不上传默认为1)}
请求类型POST
备注

updateMode: 更新方式

1:全量更新:用全新的数据替换旧的全部数据(数据可以做到新增、修改、删除,但是耗费资源较多,表数据量大时可能会比较慢,表数据量小时推荐使用,每次替换大规模数据时推荐使用);

2:增量更新:新增新数据,旧数据不受影响(数据无法更新、删除,只能新增,记录历史数据无需修改和删除时推荐使用,效率最高);

3:替换更新:(必须声明主键)按主键替换相同主键的数据,之前没有的数据直接新增。(主键处理见csv文件说明)(数据只能替换、新增,不能删除,每次更新会修改少量数据时推荐使用)

响应实例:



请求示例

https://work.jiushuyun.com/decision/api/v1/datasource/table/create

响应成功

{

    "success": true,

    "code": "200",

    "message": "success",

    "data": "18c5c6d790364b9091be37b45ed52372",

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

}

截图示例

Group 35.png

4.2 获取表数据上传地址

接口简介:



接口作用获取表数据上传地址
接口URL

/api/v1/datasource/table/upload/url

请求参数{"tableId":"#表Id"}
请求类型POST
说明
  • 获取数据上传地址后,使用put请求调用,csv文件使用二进制上传

  • 本文档提供的上传地址、下载地址等链接,过期时间均为24h

响应实例:



请求示例

https://work.jiushuyun.com/decision/api/v1/datasource/table/upload/url

响应成功

{

    "success": true,

    "code": "200",

    "message": "success",

    "data": "https://qfx30.oss-cn-hangzhou.aliyuncs.com/qfx3/sync/18c5c6d790364b9091be37b45ed52372.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241231T023734Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=LTAI4GKmR7rpd5thHtVrBHpv%2F20241231%2Foss-cn-hangzhou.aliyuncs.com%2Fs3%2Faws4_request&X-Amz-Signature=b6b18bde22722d2b53f84d75684990c38d30faf0607a9e37aa8b16a2958676ff",

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

}

截图示例

Group 36.png

4.3 标记表数据已上传完成

接口简介:



接口作用标记表数据已上传完成
接口URL

/api/v1/datasource/table/upload/finish

请求参数{"tableId":"#表Id"}
请求类型POST
说明创建表的动作是异步处理的,因此有可能存在调用标记数据上传完成接口时表未创建完成的情况,推荐在调用前等待3秒

响应实例:



请求示例

https://work.jiushuyun.com/decision/api/v1/datasource/table/upload/finish

响应成功

{

    "success": true,

    "code": "200",

    "message": "success",

    "data": "18c5c6d790364b9091be37b45ed52372",

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

}

截图示例

Group 37.png

4.4 修改数据源表名、更新方式

接口简介:



接口作用修改数据源表名、更新方式
接口URL

/api/v1/datasource/table/modify

请求参数 {"tableId":"#表Id","tableName":"#新的表名","updateMode": 1(可选1,2,3或不上传默认为1,说明见本文 4.1 节)}
请求类型POST

响应实例:




请求示例

https://work.jiushuyun.com/decision/api/v1/datasource/table/modify

响应成功

{

    "success": true,

    "code": "200",

    "message": "success",

    "data": [],

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

}

截图示例

Group 38.png

4.5 删除数据源表

接口简介:



接口作用删除数据源表
接口URL

/api/v1/datasource/table/delete

请求参数{"tableId":"#表Id"}
请求类型POST

响应实例:




请求示例

https://work.jiushuyun.com/decision/api/v1/datasource/table/delete

响应成功

{

    "success": true,

    "code": "200",

    "message": "success",

    "data": [],

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

}

截图示例

Group 39.png


4.6 重置整个数据源

接口简介:



接口作用重置整个数据源
接口URL

/api/v1/datasource/reset

请求类型POST