3. 接口-创建记录(api-create-records)

1. 接口地址

接口请求域名:https://api.vika.cn 请求方法:POST

POST /datasheets/{datasheetId}/records

2. 接口描述

给指定的维格表插入若干条记录。

单次请求可最多创建 10 条记录。在 Request Header 中需带上 Content-Type:application/json ,以 json 格式提交数据。

POST 的数据包是一个 JSON 对象,其中需包含一个数组: records ,其中包含若干条将要创建的记录。

对象 fields 包含一条记录中要新建的字段值,可以包含任意数量的字段值,没有显式指定的字段将会留空。

3. 输入参数说明

参数名称 数据类型 参数类型 说明
datasheetId String Path 维格表 ID
Content-Type String Request Header application/json
data Object Request Body 要提交的数据对象

4. 示例

示例1:在维格表( ID 为 dstWUHwzTHd2YQaXEE )创建两条新的记录。

在此例中,字段 ”登记员” 的数据类型为 「成员」 ,可以按如下任意一种格式写入:

{"unitType": 3,"unitName": "Bruce · K"}

{"unitId": "1286184164530659329"}

PS:unitId 优先级高于 unitName ,如果两者同时存在,则以 unitId 为准,更详细的字段说明请参考 《附录:字段类型列表》

请求示例(cURL):

curl -X POST \
  https://api.vika.cn/fusion/v1/datasheets/dstWUHwzTHd2YQaXEE/records \
  -H 'Authorization: Bearer {你的 API Token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "records": [
        {
            "fields": {
                "体重": "80公斤",
                "肩高": "65厘米",
                "登记日期": "2020/09/15 17:14",
                "胸围": "87厘米",
                "体长": "1.2米",
                "拍照": [
                    {
                        "name": "image.png",
                        "size": 207456,
                        "mimeType": "image/png",
                        "token": "space/2020/09/21/f577af8bd73f44c79dfc28408eaeff83",
                        "width": 374,
                        "height": 347
                    }
                ],
                "登记员": [
                    {
                        "unitType": 3,
                        "unitName": "Bruce · K"
                    }
                ],
                "性别": "男孩",
                "昵称": "安安",
                "年龄": "5岁"
            }
        },
        {
            "fields": {
                "体重": "88公斤",
                "肩高": "66厘米",
                "登记日期": "2020/09/15 17:14",
                "胸围": "89厘米",
                "体长": "1.4米",
                "拍照": [
                    {
                        "name": "image.png",
                        "size": 395220,
                        "mimeType": "image/png",
                        "token": "space/2020/09/21/c42f476c01c24e8ca7908188d460f8f1",
                        "width": 400,
                        "height": 347
                    }
                ],
                "登记员": [
                    {
                        "unitId": "1291258301781176321"
                    }
                ],
                "性别": "女孩",
                "昵称": "佳佳",
                "年龄": "6岁"
            }
        }
    ]
}'

返回示例:

正常情况下,维格表服务端会返回下述 JSON 数据包。调用成功后,会完整返回新创建记录的完整数据。

{
    "code": 200,
    "success": true,
    "data": {
        "records": [
            {
                "recordId": "reclxDBUBjQo6",
                "createdAt": 1600708683000,
                "fields": {
                    "体重": "80公斤",
                    "肩高": "65厘米",
                    "登记日期": "2020/09/15 17:14",
                    "胸围": "87厘米",
                    "体长": "1.2米",
                    "拍照": [
                        {
                            "id": "atcUJME9gbmFQ",
                            "name": "1.png",
                            "size": 207456,
                            "mimeType": "image/png",
                            "token": "space/2020/09/21/f577af8bd73f44c79dfc28408eaeff83",
                            "width": 374,
                            "height": 347,
                            "url": "https://s1.vika.cn/space/2020/09/21/f577af8bd73f44c79dfc28408eaeff83"
                        }
                    ],
                    "登记员": [
                        {
                            "unitId": "1286184164530659329",
                            "unitType": 3,
                            "unitName": "Bruce · K",
                            "avatar": "https://s1.vika.cn/public/2020/08/03/574bcee4cfc54f6fbb7d686bb237f6f3"
                        }
                    ],
                    "性别": "男孩",
                    "年龄": "5岁"
                }
            },
            {
                "recordId": "reckuCT1F1Asn",
                "createdAt": 1600708683000,
                "fields": {
                    "体重": "88公斤",
                    "肩高": "66厘米",
                    "登记日期": "2020/09/15 17:14",
                    "胸围": "89厘米",
                    "体长": "1.4米",
                    "拍照": [
                        {
                            "id": "atcSvAn7wEBtJ",
                            "name": "image.png",
                            "size": 395220,
                            "mimeType": "image/png",
                            "token": "space/2020/09/21/c42f476c01c24e8ca7908188d460f8f1",
                            "width": 400,
                            "height": 347,
                            "url": "https://s1.vika.cn/space/2020/09/21/c42f476c01c24e8ca7908188d460f8f1"
                        }
                    ],
                    "登记员": [
                        {
                            "unitId": "1291258301781176321",
                            "unitType": 3,
                            "unitName": "小葵🌻",
                            "avatar": "https://s1.vika.cn/public/2020/09/07/dbfe6ceccbdb4d5bbc1fd129566dea89"
                        }
                    ],
                    "性别": "女孩",
                    "年龄": "6岁"
                }
            }
        ]
    },
    "message": "SUCCESS"
}

返回对象说明:

属性 数据类型 说明
code Int 业务状态码,200 表示业务请求成功,其他状态码详见 《附录:全局业务状态码列表》
success Boolean 全局状态值,如果为 false ,则表示发生了业务错误或接口调用错误。
message String 返回信息,执行错误时返回错误信息。
data Object 返回的业务数据体
– records Array Of Record Objects 见下方 Record Object 的说明

Record Object 说明:

属性 数据类型 说明
recordId String 新记录的唯一 ID(注意:只在表内唯一)
createdAt Int 新记录的创建时间,精确到毫秒的时间戳
fields Object 新记录的字段数据,具体的类型介绍请参考 《附录:字段类型列表》

results matching ""

    No results matching ""