创建字段
本文提供调用「创建字段」接口的操作示例。
示例:在维格表中创建字段
假设你有一张渠道销售库存汇总表,你想在其中创建一个字段:
你的操作步骤如下:
获取你的 API Token。(获取方法)
获取你的空间站 ID。(获取方法)
获取该维格表的 ID。(获取方法)
打开你电脑上的终端,执行下列代码,向服务器发送查询请求(假设 spaceId 为
spcjXzqVrjaP3
,datasheetId 为dstNiC6R9MryevVaCQ
):- cURL
- Javascript SDK
- Python SDK
curl -X POST \
"https://vika.cn/fusion/v1/spaces/spcjXzqVrjaP3/datasheets/dstNiC6R9MryevVaCQ/fields" \
-H "Authorization: Bearer {你的 API Token}" \
-H 'Content-Type: application/json' \
-d '{
"type": "SingleText",
"name": "标题",
"property": {
"defaultValue": "默认文本文本"
}
}'注意:需要先下载和初始化 Javascript SDK,再执行如下命令。
import { Vika } from '@vikadata/vika';
const vika = new Vika({
token: '你的 API Token',
});
// 参照IAddOpenFieldProperty,不同FieldType对应到不同的Property结构
const property = {
defaultValue: '我是默认值',
};
const fieldRo = {
name: '新增文本字段',
type: 'SingleText',
property,
};
try {
const res = await vika.space('spcjXzqVrjaP3').datasheet('dstNiC6R9MryevVaCQ').fields.create(fieldRo);
if (res.success) {
// TODO: save field.id
}
} catch (error) {
// TODO: handle error
}注意:需要先下载和初始化 Python SDK,再执行如下命令。
from vika import Vika
vika = Vika("你的 API Token")
prop = {
'defaultValue': '我是默认值',
}
req_data = {
'name': '新增文本字段',
'type': 'SingleText',
'property': prop,
}
try:
field = vika.space('spcjXzqVrjaP3').datasheet('dstNiC6R9MryevVaCQ').fields.create(req_data)
except Exception:
# 处理异常情况
pass服务器会返回下列 JSON 数据包,
"data"
下即为返回的新增字段信息:有关返回结果中各参数的含义,可查看 API 手册。
{
"success": true,
"code": 200,
"message": "SUCCESS",
"data": {
"id": "fldupsvkR2ATB",
"name": "标题"
}
}