Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

更新字段

请求说明

请求地址https://openapi.wps.cn/v7/coop/dbsheet/{file_id}/sheets/{sheet_id}/fields/update
请求方法POST
签名方式KSO-1
权限要求管理多维表格(用户授权) kso.dbsheet.readwrite

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称参数类型说明
file_idstring文件 id
sheet_idinteger数据表 id

请求体(Body)

名称参数类型是否必填说明
fieldsarray[object]字段,详见多维表格参数说明
prefer_idboolean是否使用 id 来标识字段。为 true 时 Lookup 类型 linkField 与 lookupField 需传递字段 id

请求地址示例

[POST] https://openapi.wps.cn/v7/coop/dbsheet/{file_id}/sheets/{sheet_id}/fields/update

请求体示例

json
{
  "fields": [
    {
      "name": "日期",
      "id": "q",
      "type": "Date",
      "data": {
        "number_format": "yyyy\"\"m\"\"d\"\";@",
        "default_value_type": "Normal",
        "default_value": "2024/11/23"
      }
    }
  ],
  "prefer_id": true
}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ fieldsarray[object]字段,详见多维表格参数说明
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "msg": "",
  "data": {
    "fields": [
      {
        "name": "日期",
        "type": "Date",
        "id": "q",
        "data": {
          "default_value": "2024/11/23",
          "default_value_type": "Normal",
          "number_format": "yyyy\"\"m\"\"d\"\";@"
        }
      }
    ]
  }
}
回到旧版