详情 API

本文档介绍如何使用 API 获取表格中的单条记录详情。

接口说明

获取表格中指定记录的详细信息。

请求方法

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

路径参数

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

查询参数

参数	类型	描述	默认值
fields	string	要返回的字段列表，用逗号分隔	*

请求头

x-bm-token: your_api_token

示例请求

基础查询

GET /api/bases/base123/tables/table456/records/rec789

指定字段

GET /api/bases/base123/tables/table456/records/rec789?fields=id,name,created_at

响应格式

成功响应

{
  "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": "Record not found",
}

字段类型说明

不同类型字段的返回格式：

基础类型

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

选项类型

{
  "single_select": "选项1",
  "multiple_select": [
    "选项1",
    "选项2"
  ]
}

关联类型

{
  "single_link": {
    "id": "rec123",
    "name": "关联记录"
  },
  "multiple_link": [
    {
      "id": "rec123",
      "name": "关联记录1"
    },
    {
      "id": "rec456",
      "name": "关联记录2"
    }
  ]
}

创建者

{
  "created_by": "usrIL1t20OwVvW9jXzT",
  "creator": {
    "id": "usrIL1t20OwVvW9jXzT",
    "email": "[email protected]",
    "name": "Dylan"
  }
}

更新者

{
  "updated_by": "usrIL1t20OwVvW9jXzT",
  "modifier": {
    "id": "usrIL1t20OwVvW9jXzT",
    "email": "[email protected]",
    "name": "Dylan"
  }
}

注意事项

1. 如果记录不存在，将返回 404 错误