更新 API

本文档介绍如何使用 API 更新表格中的记录。

接口说明

更新表格中指定记录的字段值。

请求方法

PATCH /api/bases/{base_id}/tables/{table_name}/records/{record_id}

路径参数

参数	类型	描述
base_id	string	数据库 ID
table_name	string	表格名称
record_id	string	记录 ID

请求头

x-bm-token: your_api_token
Content-Type: application/json

请求体

{
  "field_name1": "new_value1",
  "field_name2": "new_value2"
}

示例请求

基础字段更新

PATCH /api/bases/base123/tables/table456/records/rec789
Content-Type: application/json

{
  "name": "更新后的名称",
  "description": "这是更新后的描述",
  "age": 26,
  "is_active": false
}

响应格式

成功响应

{
  "id": "11",
  "name": "55po",
  "created_by": "usrIL1t20OwVvW9jXzT",
  "updated_by": "usrIL1t20OwVvW9jXzT",
  "created_at": "2024-11-20T17:30:12.000Z",
  "updated_at": "2024-11-20T17:30:27.000Z",
  "avatar": null,
  "creator": {
    "id": "usrIL1t20OwVvW9jXzT",
    "email": "[email protected]",
    "name": "Dylan"
  },
  "modifier": {
    "id": "usrIL1t20OwVvW9jXzT",
    "email": "[email protected]",
    "name": "Dylan"
  }
}

错误响应

{
  "message": "Validation failed"
}

字段值格式说明

不同类型字段的更新格式：

基础类型

{
  "text_field": "新的文本内容",
  "number_field": 456.78,
  "boolean_field": false,
  "date_field": "2023-02-01T00:00:00Z"
}

选项类型

{
  "single_select": "opt789",  // 新的选项 ID
  "multiple_select": ["opt111", "opt222"]  // 新的选项 ID 数组
}

关联类型

{
  "single_link": "rec999",  // 新的记录 ID
  "multiple_link": ["rec111", "rec222"]  // 新的记录 ID 数组
}

注意事项

1. 只需要包含要更新的字段，未包含的字段保持原值
2. 系统字段无法通过 API 更新：
   • 创建时间
   • 创建者
   • 自增 ID
3. 更新记录时会自动更新以下字段：
   • 更新时间
   • 更新者