数据模型接口是用来获取数据模型里的数据。

是属于应用内的接口,因此它的鉴权方式请参考应用

注意事项

在爱速搭新版中,数据模型支持在页面中进行行列级别权限控制,但这个接口取决于页面设置,因此不适合作为 OpenAPI。

目前 OpenAPI 调用的是完整数据模型接口,不支持行列级别控制,因此这个接口最好作为程序内部使用,不应该直接暴露给前端浏览器使用,因为这个接口能获得所有字段信息,避免信息泄露。

接口列表

获取数据列表

地址:GET /openapi/company/{组织短名字}/app/{应用短名字}/model/{数据源key.模型表名}

注意后面的路径由两部分组成,一个是数据源 key,另一个是模型名,数据源 key 可以在数据源管理中看见,默认情况下会自动生成,比如:

image

模型表名可以在模型列表中看见

image

上面例子的路径就将会是 eRg7ny9piQzok5CGqzzbRT.data

返回内容示例:

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "items": [
  6. {
  7. "id": 1,
  8. "name": "aisuda"
  9. }
  10. ],
  11. "count": 10
  12. }
  13. }

这个返回内容可以直接用在 amis 的 crud 中

这个接口还支持以下 query 参数:

  • page,第几页,以 1 作为起始
  • perPage,每页个数
  • orderBy,按某个字段排序
  • orderDir,排序方式,asc 或 desc

比如取第一页数据,每页 10 条 GET /openapi/company/{组织短名字}/app/{应用短名字}/model/{数据源key.模型表名}?page=1&perPage=10

获取单个数据

地址:GET /openapi/company/{组织短名字}/app/{应用短名字}/model/{数据源key.模型表名}/{id}

其中 id 就是模型里设置的主键字段值

提交数据

地址:POST /openapi/company/{组织短名字}/app/{应用短名字}/model/{数据源key.模型表名}

提交格式是 JSON,比如:

  1. {
  2. "name": "amis"
  3. }

更新数据

地址:POST /openapi/company/{组织短名字}/app/{应用短名字}/model/{数据源key.模型表名}/{id}

提交格式是 JSON,比如

  1. {
  2. "title": "amis"
  3. }

删除数据

地址:DELETE /openapi/company/{组织短名字}/app/{应用短名字}/model/{数据源key.模型表名}/{id}

没有提交内容。

导出数据为 Excel

地址:POST /openapi/company/{组织短名字}/app/{应用短名字}/model/{数据源key.模型表名}/exportExcelData