创建 API

本文档介绍如何使用 API 在表格中创建新记录。

接口说明

在指定表格中创建一条新记录。

请求方法

POST /api/bases/{base_id}/tables/{table_name}/records

路径参数

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

请求头

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

请求体

{
  "fields": {
    "field_name1": "value1",
    "field_name2": "value2"
  }
}

示例请求

基础字段创建

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

{
  "id": 156,
  "name": "测试记录",
  "description": "这是一条测试记录",
  "age": 25,
  "is_active": true
}

选项字段创建

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

{
  "status": "opt123",  // 单选字段使用选项 ID
  "tags": ["opt456", "opt789"]  // 多选字段使用选项 ID 数组
}

响应格式

成功响应

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

错误响应

{
  "message": "Validation failed",
}

字段值格式说明

不同类型字段的请求格式：

基础类型

{
  "text_field": "文本内容",
  "number_field": 123.45,
  "boolean_field": true,
  "date_field": "2023-01-01T00:00:00Z"
}

选项类型

{
  "single_select": "opt123",  // 选项 ID
  "multiple_select": ["opt123", "opt456"]  // 选项 ID 数组
}

关联类型

{
  "single_link": "rec123",  // 记录 ID
  "multiple_link": ["rec123", "rec456"]  // 记录 ID 数组
}

注意事项

1. 创建记录时会自动填充以下字段：
   • 创建时间
   • 更新时间
   • 创建者
   • 更新者
   • 自增 ID（如果有）