vika维格表 API
  1. 记录
vika维格表 API
  • 维格表 API 参考手册 (beta)
  • 常见问答 FAQ
  • Apifox × 维格表使用指南
  • 记录
    • 获取记录
      GET
    • 创建记录
      POST
    • 更新记录
      PATCH
    • 删除记录
      DELETE
  • 字段
    • 获取字段
      GET
    • 创建字段
      POST
    • 删除字段
      DELETE
  • 视图
    • 获取视图
      GET
  • 表格
    • 创建表格
      POST
  • 附件
    • 上传附件
      POST
  • 空间站
    • 获取空间站列表
      GET
  • 工作目录
    • 获取文件列表
      GET
    • 获取文件详情
      GET
  1. 记录

创建记录

POST
/datasheets/{datasheetId}/records
记录

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Path 参数
datasheetId
string 
维格表 ID
必需
示例值:
dst0Yj5aNeoHldqvf6
Query 参数
viewId
string 
可选
不显式指定 viewId 时,返回全部不为空的字段;显式指定 viewId 时,返回指定视图中未隐藏且不为空的字段。
示例值:
viwG9l1VPD6nH
Header 参数
Authorization
string 
API Token
必需
默认值:
Bearer {{token}}
Body 参数application/json
records
array[object (FieldCreateRo) {4}] 
必需
需要创建的记录数据,包括记录的字段和字段值。
示例值:
[{"fields":{"事项":"「组织架构」模块 Organization Module - 通讯录面板的组织架构展示","问题描述":"本质上和上面的需求是同一个","分类":"产品需求","评审日期":"2019-10-30T00:00:00.000Z"}},{"fields":{"事项":"「成员」模块 - 设置所在部门","问题描述":"选择人后,可以调整他所属的多个部门\n选择部门后,也可添加成员至当前部门","分类":"产品需求","评审日期":"2019-10-29T16:00:00.000Z"}}]
success
boolean 
必需
全局状态值,如果为 false,则表示发生了业务错误或接口调用错误。
code
integer 
必需
业务状态码,200 表示业务请求成功。
message
string 
必需
返回信息,执行错误时返回错误信息。
data
object 
必需
fieldKey
enum<string> 
可选
写入字段和返回字段时所用的 key。默认使用 name(字段名称)。如果想以 fieldId 作为写入和返回方式,需要显式指定为 id(使用 id 可以避免因修改字段名称而导致的代码失效问题)。
枚举值:
nameid
示例
{{body}}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.vika.cn/fusion/v1/datasheets/dst0Yj5aNeoHldqvf6/records' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '请求数据 Json 参数'

返回响应

🟢201成功
application/json
Body
success
boolean 
必需
全局状态值,如果为 false,则表示发生了业务错误或接口调用错误。
示例值:
true
code
number 
必需
业务状态码,200 表示业务请求成功。
示例值:
200
message
string 
必需
返回信息,执行错误时返回错误信息。
示例值:
SUCCESS
data
object 
返回的业务数据体。
必需
records
array[object (ApiRecordDto) {4}] 
必需
成功创建或更新的记录列表。
示例
{
  "success": true,
  "code": 200,
  "message": "SUCCESS",
  "data": {
    "records": [
      {
        "recordId": "recV3ElniQavTNyJG",
        "fields": {},
        "createdAt": 0,
        "updatedAt": 0
      }
    ]
  }
}
上一页
获取记录
下一页
更新记录
Built with