数据操作

获得数据表数据接口，支持对内置表自定义字段的获取与修改

查询数据

接口

GET https://cloud.minapp.com/userve/v2.4/table/:table_id/record/

其中 :table_id 需替换为你的数据表 ID

参数说明

Content-Type: application/json

例如需要查询价格为 10 元的物品时，我们应该这样构造查询语句:

{
  "price": {"$eq": 10}
}

执行

var axios = require('axios').create({
  withCredentials: true
})

axios.get('https://cloud.minapp.com/userve/v2.4/table/1/record/', {params: {where: {price: {$eq: 10}}}}).then(res => {
  console.log(res.data)
})

该接口完整支持的查询操作符如下：

使用以上查询操作符即可完成一些简单的条件查询，同时，你也可以使用 $and 和 $or 查询操作符，对以上查询操作符进行组合使用，完成更复杂的条件查询，如查询 价格为 10 元且产品名称中包含 “包” 的物品 或 价格大于 100 元的物品，其筛选条件为：

{
  "$or": [
    {
      "$and": [
        {
          "price": {"$eq": 10}
        },
        {
          "name": {"$contains": "包"}
        }
      ]
    },
    {
      "price": {"$gt": 100}
    }
  ]
}

若开发者只需要获取对象总数，则可以通过设置 limit=1 以及 return_total_count=1 来达到该效果，total_count 可从返回的 meta 中获取

请求示例：

https://cloud.minapp.com/userve/v2.4/table/:table_id/record/?limit=1&return_total_count=1

排序返回查询数据

查询接口默认按创建时间倒序的顺序来返回数据列表，你也可以通过设置 order_by 参数来实现。

示例：

# 顺序
https://cloud.minapp.com/userve/v2.4/table/:table_id/record/?order_by=created_at

# 倒序
https://cloud.minapp.com/userve/v2.4/table/:table_id/record/?order_by=-created_at

获取数据项

接口

GET https://cloud.minapp.com/userve/v2.4/table/:table_id/record/:record_id/

其中 :table_id 需替换为你的数据表 ID，record_id 需替换为你的记录 ID

写入数据

接口

POST https://cloud.minapp.com/userve/v2.4/table/:table_id/record/

其中 :table_id 需替换为你的数据表 ID

参数说明

Content-Type: application/json

file 类型字段的更新比较特殊，需要先将文件上传，拿上传结果中返回的 id 字段调用 文件模块：文件操作：获取文件详情 接口后，将返回的文件详情结果设为字段值进行写入。

状态码说明

201 写入成功，400 请求参数有错

更新数据

本接口提供数据更新的能力，通过指定表 ID 以及 Record ID 来完成操作， 需注意，更新的数据所包含的字段需要与数据表中定义的字段一致。

接口

PUT https://cloud.minapp.com/userve/v2.6/table/:table_id/record/:record_id/

其中 :table_id 需替换为你的数据表 ID，record_id 需替换为你的记录 ID

参数说明

Content-Type: application/json

file 类型字段的更新比较特殊，需要先将文件上传，拿上传结果中返回的 id 字段调用 文件模块：文件操作：获取文件详情 接口后，将返回的文件详情结果设为字段值进行更新。

状态码说明

200 更新成功，400 请求参数有错

清空字段值

将数据表中行数据对应字段值清空

接口

PUT https://cloud.minapp.com/userve/v2.6/table/:table_id/record/:record_id/

其中 :table_id 需替换为你的数据表 ID，record_id 需替换为你的记录 ID

参数说明

{
  "$unset": {
    "expample": "" 
  }
}

状态码说明

200 更新成功，400 请求参数有错

修改数据行 ACL

接口

PUT https://cloud.minapp.com/userve/v2.6/table/:table_id/record/:record_id/

其中 :table_id 需替换为你的数据表 ID，record_id 需替换为你的记录 ID

参数说明

Content-Type: application/json

write_perm 和 read_perm 的可选值请参考 数据表操作-创建数据表 小节

状态码说明

200 更新成功，400 请求参数有错

数据删除

接口

DELETE https://cloud.minapp.com/userve/v2.4/table/:table_id/record/:record_id/

其中 :table_id 需替换为你的数据表 ID，record_id 需替换为你的记录 ID

状态码说明

204 删除成功

数据原子性更新

当请求同时对一个数据进行修改时，原子性更新使得冲突和覆盖导致的数据不正确的情况不会出现，目前支持的数据类型是数字类型和数组类型

接口

PUT https://cloud.minapp.com/userve/v2.6/table/:table_id/record/:record_id/

其中 :table_id 需替换为你的数据表 ID，record_id 需替换为你的记录 ID

参数说明

Content-Type: application/json

本接口支持以下原子性操作：

(1) incr_by 对数字类型的字段的值进行增减操作

将对象中的价格（price）字段加 1

{
  "price": {
    "$incr_by": 1
  }
}

将对象中的价格（price）字段减 1

{
  "price": {
    "$incr_by": -1
  }
}

(2) append 对数组类型的字段的值追加一个数组

往对象中的 tag 字段追加 「Hello」

{
  "tag": {
    "$append": ["Hello"]
  }
}

(3) append_unique 对数组类型的字段的值追加一个数组，但追加的数组里的数组项，如果已存在于原数组中，则该数组项不会再被追加

往对象中的 tag 字段追加 「Hello」，tag 字段依然为 ["Hello"]

{
  "tag": {
    "$append_unique": ["Hello"]
  }
}

(4) remove 从数组类型的字段的值里，删除包含在指定数组中的数组项

往对象中的 tag 字段删除 「Hello」

{
  "tag": {
    "$remove": ["Hello"]
  }
}

状态码说明

200 更新成功，400 操作符不支持/请求参数有错

pointer 查询

接口

GET https://cloud.minapp.com/userve/v2.4/table/:table_id/record/?where=query

其中 :table_id 需替换为你的数据表 ID，query 为查询条件

字段扩展

支持 expand created_by 以及 pointer 类型字段。返回结果中的 created_by 以及扩展的 pointer 类型字段会被替换为这个字段对应的完整对象。

接口

GET https://cloud.minapp.com/userve/v2.4/table/:table_id/record/?expand=pointer,created_by&keys=created_by.nickanme,created_by.avatar,pointer.customized_field

其中 :table_id 需替换为你的数据表 ID

expand 返回结果示例

不使用 expand

{
  "created_at": 1516118400,
  "created_by": 1234,
  "id": "5a2fa9b008443e59e0e67829",
  "name": "小米无线耳机",
  "price": 199,
  "pointer": {"id": "5a2fa9b008443e59e0e67889", "_table": "pointer"}
}

使用 expand

{
  "created_at": 1516118400,
  "created_by": {
    "avatar": "https://media.ifanrusercontent.com/tavatar/fb/cd/xxxx.jpg",
    "nickname": "Larry。"
  },
  "id": "5a2fa9b008443e59e0e67829",
  "name": "小米无线耳机",
  "price": 199,
  "pointer": {
    "_table": "pointer",
    "customized_field": "field_content"
  }
}

添加 pointer 类型数据

接口

POST https://cloud.minapp.com/userve/v2.4/table/:table_id/record/

其中 :table_id 需替换为你的数据表 ID

参数说明

Content-Type: application/json

其中 pointer 类型字段的创建只需传入指向的数据行 ID 即可。

状态码说明

201 写入成功，400 请求参数有错

更新 pointer 类型数据

接口

PUT https://cloud.minapp.com/userve/v2.6/table/:table_id/record/:record_id/

其中 :table_id 需替换为你的数据表 ID，record_id 需替换为你的记录 ID

参数说明

Content-Type: application/json

其中 pointer 类型字段的创建只需传入指向的数据行 ID 即可。

状态码说明

200 更新成功，400 请求参数有错

批量写入数据

接口

POST https://cloud.minapp.com/userve/v2.4/table/:table_id/record/

其中 :table_id 是数据表的 ID。一次请求最多支持创建 1000 条数据，支持触发触发器。

参数说明

Content-Type: application/json

将需要批量创建的数据放到一个数组里提交，数组中的元素构建方式与创建单条数据一致。

返回示例

{
  "operation_result": [
    {
      "success": {
        "id": "5cac254426eda1729d9f1d8c",
        "created_at": 1554785604
      }
    },
    {
      "error": {
        "err_msg": "数据写入失败，具体错误信息可联系知晓云微信客服：minsupport3 获取。",
        "code": 11000
      }
    }
  ],
  "total_count": 2,
  "succeed": 1
}

返回参数说明

operation_result 包含的 Object 的参数说明：

创建成功（对象中包含键：success）：

创建失败（对象中包含键：error）：

状态码说明

201: 成功。

400: 参数错误，比如缺少必填项，数据类型不对。

404: 指定的数据表不存在。

同步批量修改数据

接口

PUT https://cloud.minapp.com/userve/v2.6/table/:table_id/record/

其中 :table_id 是数据表的 ID。单次请求最多修改 1000 条数据，支持触发触发器。

Query 参数说明

参数说明

Content-Type: application/json

与修改单条数据的参数一致。

返回示例

{
  "offset": 0,
  "operation_result": [
    {
      "success": {
        "updated_at": 1556414642,
        "id": "5cc5009f04cc155b1d61dc26"
      }
    }
  ],
  "next": null,
  "total_count": 1,
  "limit": 1000,
  "succeed": 1
}

返回参数说明

operation_result 包含的 Object 的参数说明：

更新成功（对象中包含键：success）：

更新失败（对象中包含键：error）：

状态码说明

200: 成功。

400: 参数错误，比如缺少必填项，数据类型不对。

404: 指定的数据表不存在。

同步批量删除数据

接口

DELETE https://cloud.minapp.com/userve/v2.4/table/:table_id/record/

其中 :table_id 是数据表的 ID。单次请求最多删除 1000 条数据，支持触发触发器。

Query 参数说明

返回示例

{
  "total_count": 2,
  "offset": 0,
  "next": null,
  "limit": 1000,
  "succeed": 2
}

返回参数说明

状态码说明

200: 成功。

400: 查询参数不合法，比如：数据类型不对。

404: 指定的数据表不存在。

异步大批量修改数据

接口

PUT https://cloud.minapp.com/userve/v2.6/table/:table_id/record/

其中 :table_id 是数据表的 ID。单次请求更新的数据条数大于 1000 条且 Query 参数中没有 limit 参数或 limit 值大于 1000 时会自动使用此接口，不支持触发触发器。

Query 参数说明

参数说明

Content-Type: application/json

与修改单条数据的参数一致。

返回参数说明

状态码说明

200: 成功。

400: 参数错误，比如缺少必填项，数据类型不对。

404: 指定的数据表不存在。

异步大批量删除数据

接口

DELETE https://cloud.minapp.com/userve/v2.4/table/:table_id/record/

其中 :table_id 是数据表的 ID。单次请求删除的数据条数大于 1000 条且 Query 参数中没有 limit 参数或 limit 值大于 1000 时会自动使用此接口，不支持触发触发器。

Query 参数说明

返回参数说明

状态码说明

200: 成功。

400: 查询参数不合法，比如：数据类型不对。

404: 指定的数据表不存在。

查询异步批量更新、删除结果

接口

GET https://cloud.minapp.com/userve/v1/bulk-operation/:operation_id/

其中 :operation_id 是异步批量更新或删除接口中返回的 operation_id 字段的值。

返回示例

{
  "id": 1,
  "schema_id": 1,
  "schema_name": "random_name",
  "operation": "update",
  "status": "success",
  "created_at": 111111,
  "updated_at": 111112,
  "matched_count": 111,
  "modified_count": 111,
}

返回参数说明

状态码说明

200: 成功

404: 操作记录不存在