From 662932b76c54b66b086741b182007444e1a12aa1 Mon Sep 17 00:00:00 2001 From: binggchen <141918726+binggchen@users.noreply.github.com> Date: Mon, 21 Aug 2023 12:24:47 +0800 Subject: [PATCH] =?UTF-8?q?Create=20=E6=95=B0=E6=8D=AE=E6=BA=90=E7=AE=A1?= =?UTF-8?q?=E7=90=86API?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...56\346\272\220\347\256\241\347\220\206API" | 894 ++++++++++++++++++ 1 file changed, 894 insertions(+) create mode 100644 "product/\347\247\273\345\212\250\344\270\216\351\200\232\344\277\241/\344\272\221\345\274\200\345\217\221\344\275\216\344\273\243\347\240\201\345\271\263\345\217\260/\344\272\247\345\223\201\347\256\200\344\273\213/\346\225\260\346\215\256\346\272\220/\346\225\260\346\215\256\346\250\241\345\236\213/\346\225\260\346\215\256\346\272\220\347\256\241\347\220\206API" diff --git "a/product/\347\247\273\345\212\250\344\270\216\351\200\232\344\277\241/\344\272\221\345\274\200\345\217\221\344\275\216\344\273\243\347\240\201\345\271\263\345\217\260/\344\272\247\345\223\201\347\256\200\344\273\213/\346\225\260\346\215\256\346\272\220/\346\225\260\346\215\256\346\250\241\345\236\213/\346\225\260\346\215\256\346\272\220\347\256\241\347\220\206API" "b/product/\347\247\273\345\212\250\344\270\216\351\200\232\344\277\241/\344\272\221\345\274\200\345\217\221\344\275\216\344\273\243\347\240\201\345\271\263\345\217\260/\344\272\247\345\223\201\347\256\200\344\273\213/\346\225\260\346\215\256\346\272\220/\346\225\260\346\215\256\346\250\241\345\236\213/\346\225\260\346\215\256\346\272\220\347\256\241\347\220\206API" new file mode 100644 index 000000000000..c21d50d72d87 --- /dev/null +++ "b/product/\347\247\273\345\212\250\344\270\216\351\200\232\344\277\241/\344\272\221\345\274\200\345\217\221\344\275\216\344\273\243\347\240\201\345\271\263\345\217\260/\344\272\247\345\223\201\347\256\200\344\273\213/\346\225\260\346\215\256\346\272\220/\346\225\260\346\215\256\346\250\241\345\236\213/\346\225\260\346\215\256\346\272\220\347\256\241\347\220\206API" @@ -0,0 +1,894 @@ +# 数据源管理API + +**简介**:数据源管理API + +**HOST**:https://{envId}.ap-shanghai.tcb-api.tencentcloudapi.com/weda + + +环境 ID (envId) 可前往 [资源管理](https://console.cloud.tencent.com/lowcode/resource/index) 页面获取。 + + +# 数据源API + +envType: 正式环境传prod，体验环境传pre +datasourceName: 数据源名称可以在[数据模型](https://console.cloud.tencent.com/lowcode/datasource/model)中，对应的 数据表-基础信息-标识 字段查到。 + + +## 创建数据源记录 + + +**接口地址**:`/odata/v1/{envType}/{datasourceName}` + + +**请求方式**:`POST` + + +**请求数据类型**:`application/json` + + +**响应数据类型**:`*/*` + + +**请求示例**: + + +```javascript +{ + "name": "李四", + "course": "体育", + "score": 89, + "semester": "第二学期" +} +``` + + +**请求参数**: + + +| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | +| -------- | -------- | ----- | -------- | -------- | ------ | +|X-Request-Id|请求requestId|header|true|string|| +|envType|环境类型,pre预览环境，prod正式环境|path|true|string|| +|datasourceName|数据源标识,示例值(student_bky05o0)|path|true||| +|创建记录对象|字段标识和字段值对象|body|true|创建记录对象|字段标识:字段值| + +**响应状态**: + + +| 状态码 | 说明 | schema | +| -------- | -------- | ----- | +|201|创建成功|| + + +**响应参数**: + +| 参数名称 | 参数说明 | 类型 | schema | +| -------- | -------- | ----- |----- | +|创建记录对象|字段标识和字段值对象|创建记录对象|字段标识:字段值| +|_id|记录id|string|| + + +**响应示例**: +```javascript +{ + "@odata.context": "$metadata#student_bky05o0", + "_id": "5b049cc8621c7f040ea751850b63e442", + "createdAt": 1646034692306, + "updatedAt": 1646034692306, + "owner": "1463080581028851713", + "createBy": "1463080581028851713", + "updateBy": "1463080581028851713", + "_departmentList": "[]", + "name": "李四", + "course": "体育", + "score": 89.0, + "semester": "第二学期" +} +``` + + +## 更新数据源记录 + + +**接口地址**:`/odata/v1/{envType}/{datasourceName}('{recordId}')` + + +**请求方式**:`PATCH` + + +**请求数据类型**:`application/json` + + +**响应数据类型**:`*/*` + + +**请求示例**: + + +```javascript +{ + "name": "李四", + "course": "体育", + "score": 89, + "semester": "第二学期" +} +``` + + +**请求参数**: + + +| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | +| -------- | -------- | ----- | -------- | -------- | ------ | +|X-Request-Id|请求requestId|header|true|string|| +|envType|环境类型,pre预览环境，prod正式环境|path|true|string|| +|datasourceName|数据源标识|path|true||| +|recordId|数据标识id|path|true||| +|更新记录对象|字段标识和字段值对象|body|true|更新记录对象|字段标识:字段值| + + +**响应状态**: + + +| 状态码 | 说明 | schema | +| -------- | -------- | ----- | +|204|更新成功|| + + +**响应参数**: + + +暂无 + + + + +## 查询数据源记录 + + +**接口地址**:`/odata/v1/{envType}/{datasourceName}('{recordId}')` + + +**请求方式**:`GET` + + +**请求数据类型**:`application/json` + + +**响应数据类型**:`*/*` + + +**接口描述**: + + +**请求参数**: + + +| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | +| -------- | -------- | ----- | -------- | -------- | ------ | +|X-Request-Id|请求requestId|header|true|string|| +|envType|环境类型,pre预览环境，prod正式环境|path|true|string|| +|datasourceName|数据源标识|path|true||| +|recordId|数据标识id|path|true||| + + +**响应状态**: + + +| 状态码 | 说明 | schema | +| -------- | -------- | ----- | +|200|查询成功|| + + +**响应参数**: + +| 参数名称 | 参数说明 | 类型 | schema | +| -------- | -------- | ----- |----- | +|记录对象|字段标识和字段值对象|记录对象|字段标识:字段值| +|_id|记录id|string|| + + +**响应示例**: +```javascript +{ + "@odata.context": "$metadata#student_bky05o0", + "_id": "5b049cc8621c7f040ea751850b63e442", + "createdAt": 1646034692306, + "updatedAt": 1646034692306, + "owner": "1463080581028851713", + "createBy": "1463080581028851713", + "updateBy": "1463080581028851713", + "_departmentList": "[]", + "name": "李四", + "course": "体育", + "score": 89.0, + "semester": "第二学期" +} +``` + + +## 根据filter查询数据源记录 + + +**接口地址**:`/odata/v1/{envType}/{datasourceName}` + + +**请求方式**:`GET` + + +**请求数据类型**:`application/json` + + +**响应数据类型**:`*/*` + + +**接口描述**: + + +**请求参数**: + + +| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | +| -------- | -------- | ----- | -------- | -------- | ------ | +|X-Request-Id|请求requestId|header|true|string|| +|envType|环境类型,pre预览环境，prod正式环境|path|true|string|| +|datasourceName|数据源标识|path|true|string|| +|$filter|查询条件,$filter中判断条件包含:eq：等于,gt：大于,lt：小于,ne：不等于,contains()：包含， 其中 contains() 用法为 $filter=contains(name, '张'),注意：如果 or 和 and 并用，优先级高的需要加括号，用法为(age gt 1 and age lt 10) or age eq 20 |query|false|string|| +|$skip|跳过N条记录|query|false|integer|| +|$top|查询N条记录|query|false|integer|| +|$orderby|排序字段,$orderby 排序支持:desc和asc模式, 例如需要按某字段顺序排列$orderby=age asc|query|false|string|| +|$count|获取数据总数|query|false|boolean|| + + +**响应状态**: + + +| 状态码 | 说明 | schema | +| -------- | -------- | ----- | +|200|查询成功|| + +**响应参数**: + +| 参数名称 | 参数说明 | 类型 | schema | +| -------- | -------- | ----- |----- | +|value|字段标识和字段值对象列表|array|记录列表| + + +**响应示例**: +```javascript +{ + "@odata.context": "$metadata#student_bky05o0", + "@odata.count": 1, + "value": [ + { + "_id": "287a53aa61af01df00dc957a79c1ab3b", + "createdAt": 1638859231940, + "updatedAt": 1638859231940, + "owner": "1468105174530121729", + "createBy": "1468105174530121729", + "updateBy": "1468105174530121729", + "_departmentList": "[]", + "name": "二蛋", + "course": "语文", + "score": 77, + "semester": "第一学期" + } + ] +} + +``` + + +## 删除数据源记录 + + +**接口地址**:`/odata/v1/{envType}/{datasourceName}('{recordId}')` + + +**请求方式**:`DELETE` + + +**请求数据类型**:`application/json` + + +**响应数据类型**:`*/*` + + +**接口描述**: + + +**请求参数**: + + +| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | +| -------- | -------- | ----- | -------- | -------- | ------ | +|X-Request-Id|请求requestId|header|true|string|| +|envType|环境类型,pre预览环境，prod正式环境|path|true|string|| +|datasourceName|数据源标识|path|true||| +|recordId|数据标识id|path|true||| + + +**响应状态**: + + +| 状态码 | 说明 | schema | +| -------- | -------- | ----- | +|204|删除成功|| + + +**响应参数**: + + +暂无 + + +## 批量创建数据源记录 + + +**接口地址**:`/odata/v1/batch/{envType}/{datasourceName}` + + +**请求方式**:`POST` + + +**请求数据类型**:`application/json` + + +**响应数据类型**:`*/*` + + +**请求示例**: + + +```javascript +{ + "value": [ + { + "name": "二蛋", + "course": "语文", + "score": 77, + "semester": "第一学期" + } + ] +} +``` + + +**请求参数**: + + +| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | +| -------- | -------- | ----- | -------- | -------- | ------ | +|X-Request-Id|请求requestId|header|true|string|| +|envType|环境类型,pre预览环境，prod正式环境|path|true|string|| +|datasourceName|数据源标识|path|true||| +|批量创建对象||body|true|| +|  value|字段标识和字段值对象列表||true|记录列表| + + +**响应状态**: + + +| 状态码 | 说明 | schema | +| -------- | -------- | ----- | +|201|创建成功|| + + +**响应参数**: + +| 参数名称 | 参数说明 | 类型 | schema | +| -------- | -------- | ----- |----- | +|value|字段标识和字段值对象列表|array|记录列表| + + + +**响应示例**: +```javascript +{ + "@odata.context": "$metadata#student_bky05o0", + "value": [ + { + "_id": "287a53aa61af01df00dc957a79c1ab3b", + "createdAt": 1638859231940, + "updatedAt": 1638859231940, + "owner": "1468105174530121729", + "createBy": "1468105174530121729", + "updateBy": "1468105174530121729", + "_departmentList": "[]", + "name": "二蛋", + "course": "语文", + "score": 77, + "semester": "第一学期" + } + ] +} +``` + + +## 根据ID批量更新数据源记录 + + +**接口地址**:`/odata/v1/batch/{envType}/{datasourceName}('{recordIds}')` + + +**请求方式**:`PATCH` + + +**请求数据类型**:`application/json` + + +**响应数据类型**:`*/*` + + +**请求示例**: + + +```javascript +{ +    "name":"二蛋", +    "course":"语文", +    "score":77, +    "semester":"第一学期" +} +``` + + +**请求参数**: + + +| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | +| -------- | -------- | ----- | -------- | -------- | ------ | +|X-Request-Id|请求requestId|header|true|string|| +|envType|环境类型,pre预览环境，prod正式环境|path|true|string|| +|datasourceName|数据源标识|path|true||| +|recordIds|数据标识id|path|true||| +|批量更新对象||body|true|| + + +**响应状态**: + + +| 状态码 | 说明 | schema | +| -------- | -------- | ----- | +|200|更新成功|| + + +**响应参数**: + +| 参数名称 | 参数说明 | 类型 | schema | +| -------- | -------- | ----- |----- | +|updateCount|修改记录数|int|| + + + +**响应示例**: +```javascript +{ + +    "updateCount": N + +} +``` + + +## 根据ID批量查询数据源记录 + + +**接口地址**:`/odata/v1/batch/{envType}/{datasourceName}('{recordIds}')` + + +**请求方式**:`GET` + + +**请求数据类型**:`application/json` + + +**响应数据类型**:`*/*` + + +**接口描述**: + + +**请求参数**: + + +| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | +| -------- | -------- | ----- | -------- | -------- | ------ | +|X-Request-Id|请求requestId|header|true|string|| +|envType|环境类型,pre预览环境，prod正式环境|path|true|string|| +|datasourceName|数据源标识|path|true||| +|recordIds|数据标识id|path|true||| + + +**响应状态**: + + +| 状态码 | 说明 | schema | +| -------- | -------- | ----- | +|200|查询成功|| + +**响应参数**: + +| 参数名称 | 参数说明 | 类型 | schema | +| -------- | -------- | ----- |----- | +|value|字段标识和字段值对象列表|array|记录列表| + + + +**响应示例**: +```javascript +{ + "@odata.context": "$metadata#student_bky05o0", + "value": [ + { + "_id": "287a53aa61af01df00dc957a79c1ab3b", + "createdAt": 1638859231940, + "updatedAt": 1638859231940, + "owner": "1468105174530121729", + "createBy": "1468105174530121729", + "updateBy": "1468105174530121729", + "_departmentList": "[]", + "name": "二蛋", + "course": "语文", + "score": 77, + "semester": "第一学期" + } + ] +} +``` + + +## 根据Filter批量查询数据源记录 + + +**接口地址**:`/odata/v1/batch/{envType}/{datasourceName}` + + +**请求方式**:`GET` + + +**请求数据类型**:`application/json` + + +**响应数据类型**:`*/*` + + +**接口描述**: + + +**请求参数**: + + +| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | +| -------- | -------- | ----- | -------- | -------- | ------ | +|X-Request-Id|请求requestId|header|true|string|| +|envType|环境类型,pre预览环境，prod正式环境|path|true|string|| +|datasourceName|数据源标识|path|true||| +|$filter|查询条件,$filter中判断条件包含:eq：等于,gt：大于,lt：小于,ne：不等于,contains()：包含， 其中 contains() 用法为 $filter=contains(name, '张'),注意：如果 or 和 and 并用，优先级高的需要加括号，用法为(age gt 1 and age lt 10) or age eq 20 |query|false||| +|$skip|跳过N条记录|query|false||| +|$top|查询N条记录|query|false||| +|$orderby|排序字段,$orderby 排序支持:desc和asc模式, 例如需要按某字段顺序排列$orderby=age asc|query|false||| +|$count|获取数据总数|query|false||| + + +**响应状态**: + + +| 状态码 | 说明 | schema | +| -------- | -------- | ----- | +|200|查询成功|| + + +**响应参数**: + +| 参数名称 | 参数说明 | 类型 | schema | +| -------- | -------- | ----- |----- | +|value|字段标识和字段值对象列表|array|记录列表| + + + +**响应示例**: +```javascript +{ + "@odata.context": "$metadata#student_bky05o0", + "@odata.count": 2, + "value": [ + { + "_id": "287a53aa61af01df00dc957a79c1ab3b", + "createdAt": 1638859231940, + "updatedAt": 1638859231940, + "owner": "1468105174530121729", + "createBy": "1468105174530121729", + "updateBy": "1468105174530121729", + "_departmentList": "[]", + "name": "二蛋", + "course": "语文", + "score": 77, + "semester": "第一学期" + } + ] +} +``` + + +## 根据ID批量删除数据源记录 + + +**接口地址**:`/odata/v1/batch/{envType}/{datasourceName}('{recordIds}')` + + +**请求方式**:`DELETE` + + +**请求数据类型**:`application/json` + + +**响应数据类型**:`*/*` + + +**接口描述**: + + +**请求参数**: + + +| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | +| -------- | -------- | ----- | -------- | -------- | ------ | +|X-Request-Id|请求requestId|header|true|string|| +|envType|环境类型,pre预览环境，prod正式环境|path|true|string|| +|datasourceName|数据源标识|path|true||| +|recordIds|数据标识id|path|true||| + + +**响应状态**: + + +| 状态码 | 说明 | schema | +| -------- | -------- | ----- | +|200|删除成功|| + + +**响应参数**: + +| 参数名称 | 参数说明 | 类型 | schema | +| -------- | -------- | ----- |----- | +|deleteCount|删除记录数|integer|| + + +**响应示例**: +```javascript +{ + "deleteCount": 3 +} +``` + + +## 查询环境下所有数据源Schema + + +**接口地址**:`/model/v1/getSchemaList` + + +**请求方式**:`GET` + + +**请求数据类型**:`application/json` + + +**响应数据类型**:`*/*` + + +**接口描述**: + + +**请求参数**: + + +| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | +| -------- | -------- | ----- | -------- | -------- | ------ | +|X-Request-Id|请求requestId|header|true|string|| + + +**响应状态**: + + +| 状态码 | 说明 | schema | +| -------- | -------- | ----- | +|200|查询成功|公共出参对象| + + +**响应参数**: + + +| 参数名称 | 参数说明 | 类型 | schema | +| -------- | -------- | ----- |----- | +|Response||公共出参对象，data类型为QueryDataSourceSchemaResultListResponse|公共出参对象，data类型为QueryDataSourceSchemaResultListResponse| +|  RequestId|requestId|string|| +|  Error|错误信息|错误信息|错误信息| +|    Code|错误码|string|| +|    Message|错误消息提示|string|| +|  Data||QueryDataSourceSchemaResultListResponse|QueryDataSourceSchemaResultListResponse| +|    QueryDataSourceSchemaResultList|数据模型Schema数组|array|QueryDataSourceSchemaResult| +|      Id|数据模型ID|string|| +|      Name|数据模型标识|string|| +|      Title|数据模型标题|string|| +|      Schema|数据模型Schema|string|| +|    RequestId|请求ID|string|| + + +**响应示例**: +```javascript +{ +    "Response":{ +        "Data":{ +            "QueryDataSourceSchemaResultList":[ +                { +                    "Id":"data-1P1UtRsJ2", +                    "Name":"sys_user", +                    "Title":"用户", +                    "Schema":"model schema" +                } +            ], +            "RequestId":"reqid" +        } +    } +} +``` + + +## 查询数据源Schema + + +**接口地址**:`/model/v1/getSchemaList/{dataSourceName}` + + +**请求方式**:`GET` + + +**请求参数**: + + +| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | +| -------- | -------- | ----- | -------- | -------- | ------ | +|X-Request-Id|请求requestId|header|true|string|| +|dataSourceName||path|true|string|| + + +**响应状态**: + + +| 状态码 | 说明 | schema | +| -------- | -------- | ----- | +|200|查询成功|公共出参对象| + + +**响应参数**: + + +| 参数名称 | 参数说明 | 类型 | schema | +| -------- | -------- | ----- |----- | +|Response||公共出参对象，data类型为QueryDataSourceSchemaResultListResponse|公共出参对象，data类型为QueryDataSourceSchemaResultListResponse| +|  RequestId|requestId|string|| +|  Error|错误信息|错误信息|错误信息| +|    Code|错误码|string|| +|    Message|错误消息提示|string|| +|  Data||QueryDataSourceSchemaResultListResponse|QueryDataSourceSchemaResultListResponse| +|    QueryDataSourceSchemaResultList|数据模型Schema数组|array|QueryDataSourceSchemaResult| +|      Id|数据模型ID|string|| +|      Name|数据模型标识|string|| +|      Title|数据模型标题|string|| +|      Schema|数据模型Schema|string|| +|    RequestId|请求ID|string|| + + +**响应示例**: +```javascript +{ +    "Response":{ +        "Data":{ +            "QueryDataSourceSchemaResultList":[ +                { +                    "Id":"data-1P1UtRsJ2", +                    "Name":"sys_user", +                    "Title":"用户", +                    "Schema":"model schema" +                } +            ], +            "RequestId":"reqid" +        } +    } +} +``` + +## 查询选项集信息 + + +**接口地址**:`/model/v1/describeOptionSet` + + +**请求方式**:`POST` + + +**请求数据类型**:`application/json` + + +**响应数据类型**:`*/*` + + +**接口描述**:

根据选项集标识查询选项集具体信息

+ + + +**请求示例**: + + +```javascript +{ + "optionSetNames": [] +} +``` + + +**请求参数**: + + +| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | +| -------- | -------- | ----- | -------- | -------- | ------ | +|查询选项集信息入参对象|查询选项集信息入参对象|body|true|查询选项集信息入参对象|查询选项集信息入参对象| +|  optionSetNames|选项集标识列表||true|array|string| + + +**响应状态**: + + +| 状态码 | 说明 | schema | +| -------- | -------- | ----- | +|200|OK|OpenApiServerResponse查询选项集信息出参对象| + + +**响应参数**: + + +| 参数名称 | 参数说明 | 类型 | schema | +| -------- | -------- | ----- |----- | +|response||公共出参对象，data类型为查询选项集信息出参对象|公共出参对象，data类型为查询选项集信息出参对象| +|  requestId|requestId|string|| +|  error|错误信息|错误信息|错误信息| +|    code|错误码|string|| +|    message|错误消息提示|string|| +|  data||查询选项集信息出参对象|查询选项集信息出参对象| +|    total|选项集个数|integer|| +|    items|选项集列表|array|DescribeOptionSetDetailParam| +|      name|标识|string|| +|      title|名称|string|| +|      description|描述|string|| +|      envId|所属环境|string|| +|      config|选项集KV列表|string|| +|      data|选项集kv映射结构|object|| + + +**响应示例**: +```javascript +{ + "response": { + "requestId": "", + "error": { + "code": "", + "message": "" + }, + "data": { + "total": 1, + "items": [ + { + "name": "gender", + "title": "性别", + "description": "性别信息描述", + "envId": "lowcode-a1b2c3", + "config": "[{\"key\":\"1\",\"value\":\"男\"},{\"key\":\"2\",\"value\":\"女\"}]", + "data": {"1":"男", "2":"女"} + } + ] + } + } +} +```