- 开发指南
- 工作区
- 表格数据
- 数据仓库数据
- 文件
- 订阅
- 服务商
获取表格配置
POST
/openapi/v1/table/{table_id}
请求参数
Path 参数
table_id
string
表格ID或别名
示例值:
{{TABLE_ID}}
Header 参数
Open-Authorization
string
必需
默认值:
Bearer {{API_KEY}}
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://api.huoban.com/openapi/v1/table/' \
--header 'Open-Authorization;'返回响应
🟢200成功
application/json
Body
code
integer
错误码
message
string
错误信息
data
object
返回数据
table
object (表格配置)
必需
meta
object
元数据
trace_id
string
请求ID
示例
{
"code": 0,
"message": "success",
"data": {
"table": {
"table_id": "2100000000000001",
"name": "所有字段类型枚举",
"alias": "all_fields",
"space_id": 4000000000000001,
"created_on": "2022-04-02 14:17:17",
"fields": [
{
"field_id": "2200000137788628",
"name": "单行文本",
"alias": "all_fields.input_text",
"field_type": "input",
"data_type": "text",
"required": false,
"description": "",
"config": {}
},
{
"field_id": "2200000137788629",
"name": "多行文本",
"alias": "all_fields.textarea_text",
"field_type": "textarea",
"data_type": "text",
"required": false,
"description": "",
"config": {}
},
{
"field_id": "2200000137788630",
"name": "富文本",
"alias": "all_fields.rich_text",
"field_type": "rich",
"data_type": "text",
"required": false,
"description": "",
"config": {}
},
{
"field_id": "2200000137788631",
"name": "号码",
"alias": "all_fields.number_text",
"field_type": "number",
"data_type": "text",
"required": false,
"description": "",
"config": {}
},
{
"field_id": "2200000137788632",
"name": "条码",
"alias": "all_fields.barcode_text",
"field_type": "barcode",
"data_type": "text",
"required": false,
"description": "",
"config": {}
},
{
"field_id": "2200000137788634",
"name": "数值",
"alias": "all_fields.numeric_numeric",
"field_type": "numeric",
"data_type": "numeric",
"required": false,
"description": "",
"config": {
"is_percent": 0,
"precision": 0,
"unit_prefix": "",
"unit_surfix": "个"
}
},
{
"field_id": "2200000137788635",
"name": "百分比",
"alias": "all_fields.numeric_numeric",
"field_type": "numeric",
"data_type": "numeric",
"required": false,
"description": "",
"config": {
"is_percent": 1,
"precision": 2,
"unit_prefix": "",
"unit_surfix": "%"
}
},
{
"field_id": "2200000137788642",
"name": "金额",
"alias": "all_fields.money_numeric",
"field_type": "money",
"data_type": "numeric",
"required": false,
"description": "",
"config": {
"is_percent": 0,
"precision": 2,
"unit_prefix": "",
"unit_surfix": "元"
}
},
{
"field_id": "2200000137788643",
"name": "日期 - 仅日期",
"alias": "all_fields.date_date",
"field_type": "date",
"data_type": "date",
"required": false,
"description": "",
"config": {
"precision": "date"
}
},
{
"field_id": "2200000137788644",
"name": "日期 - 日期和时间",
"alias": "all_fields.date_date",
"field_type": "date",
"data_type": "date",
"required": false,
"description": "",
"config": {
"precision": "datetime"
}
},
{
"field_id": "2200000137788645",
"name": "计算 - 数字",
"alias": "all_fields.calculation_numeric",
"field_type": "calculation",
"data_type": "numeric",
"required": false,
"description": "",
"config": {
"is_percent": 0,
"precision": 2,
"unit_prefix": "￥",
"unit_surfix": ""
}
},
{
"field_id": "2200000137788646",
"name": "计算 - 百分比",
"alias": "all_fields.calculation_numeric",
"field_type": "calculation",
"data_type": "numeric",
"required": false,
"description": "",
"config": {
"is_percent": 1,
"precision": 2,
"unit_prefix": "",
"unit_surfix": "%"
}
},
{
"field_id": "2200000137788647",
"name": "计算 - 仅日期",
"alias": "all_fields.calculation_date",
"field_type": "calculation",
"data_type": "date",
"required": false,
"description": "",
"config": {
"precision": "date"
}
},
{
"field_id": "2200000137788648",
"name": "计算 - 日期和时间",
"alias": "all_fields.calculation_date",
"field_type": "calculation",
"data_type": "date",
"required": false,
"description": "",
"config": {
"precision": "datetime"
}
},
{
"field_id": "2200000137788650",
"name": "平铺选项 - 单选",
"alias": "all_fields.category_category",
"field_type": "category",
"data_type": "category",
"required": false,
"description": "",
"config": {
"is_multi": 0,
"is_tile": 1,
"options": [
{
"id": "1",
"name": "A"
},
{
"id": "2",
"name": "B"
},
{
"id": "3",
"name": "C"
}
]
}
},
{
"field_id": "2200000137788651",
"name": "平铺选项 - 多选",
"alias": "all_fields.category_category",
"field_type": "category",
"data_type": "category",
"required": false,
"description": "",
"config": {
"is_multi": 1,
"is_tile": 1,
"options": [
{
"id": "1",
"name": "A"
},
{
"id": "2",
"name": "B"
},
{
"id": "3",
"name": "C"
}
]
}
},
{
"field_id": "2200000137788652",
"name": "下拉菜单 - 单选",
"alias": "all_fields.category_category",
"field_type": "category",
"data_type": "category",
"required": false,
"description": "",
"config": {
"is_multi": 0,
"is_tile": 0,
"options": [
{
"id": "1",
"name": "A"
},
{
"id": "2",
"name": "B"
},
{
"id": "3",
"name": "C"
}
]
}
},
{
"field_id": "2200000137788653",
"name": "下拉菜单 - 多选",
"alias": "all_fields.category_category",
"field_type": "category",
"data_type": "category",
"required": false,
"description": "",
"config": {
"is_multi": 1,
"is_tile": 0,
"options": [
{
"id": "1",
"name": "A"
},
{
"id": "2",
"name": "B"
},
{
"id": "3",
"name": "C"
}
]
}
},
{
"field_id": "2200000137788654",
"name": "成员 - 单选",
"alias": "all_fields.user_user",
"field_type": "user",
"data_type": "user",
"required": false,
"description": "",
"config": {
"is_multi": 0
}
},
{
"field_id": "2200000137788655",
"name": "成员 - 多选",
"alias": "all_fields.user_user",
"field_type": "user",
"data_type": "user",
"required": false,
"description": "",
"config": {
"is_multi": 1
}
},
{
"field_id": "2200000137788659",
"name": "关联 - 单选",
"alias": "all_fields.relation_relation",
"field_type": "relation",
"data_type": "relation",
"required": false,
"description": "",
"config": {
"is_multi": 0,
"table_id": "2100000000000002",
"space_id": "4000000000000001"
}
},
{
"field_id": "2200000137788660",
"name": "关联 - 多选",
"alias": "all_fields.relation_relation",
"field_type": "relation",
"data_type": "relation",
"required": false,
"description": "",
"config": {
"is_multi": 1,
"table_id": "2100000000000002",
"space_id": "4000000000000001"
}
},
{
"field_id": "2200000137788661",
"name": "位置 - 仅可获取当前位置",
"alias": "all_fields.location_location",
"field_type": "location",
"data_type": "location",
"required": false,
"description": "",
"config": {
"is_current": 1
}
},
{
"field_id": "2200000137788662",
"name": "位置 - 可搜索指定位置",
"alias": "all_fields.location_location",
"field_type": "location",
"data_type": "location",
"required": false,
"description": "",
"config": {
"is_current": 0
}
},
{
"field_id": "2200000137788663",
"name": "图片 - 不加水印",
"alias": "all_fields.image_file",
"field_type": "image",
"data_type": "file",
"required": false,
"description": "",
"config": {
"is_multi": 1,
"is_watermark": 0
}
},
{
"field_id": "2200000137788664",
"name": "图片 - 加水印",
"alias": "all_fields.image_file",
"field_type": "image",
"data_type": "file",
"required": false,
"description": "",
"config": {
"is_multi": 1,
"is_watermark": 1
}
},
{
"field_id": "2200000137788666",
"name": "附件",
"alias": "all_fields.file_file",
"field_type": "file",
"data_type": "file",
"required": false,
"description": "",
"config": {
"is_multi": 1
}
},
{
"field_id": "2200000137788667",
"name": "手写签名",
"alias": "all_fields.signature_signature",
"field_type": "signature",
"data_type": "signature",
"required": false,
"description": "",
"config": {}
}
]
}
},
"meta": {
"trace_id": "1650338671134855"
}
}修改于 2025-04-24 01:00:37