更新字段

接口说明

本接口用于更新 Smartsheet 中的某个子表里的一个或多个字段的标题和字段属性信息。

注意

该接口只能更新字段名、字段属性，不能更新字段类型。

请求格式

描述	定义
Path	/openapi/smartsheet/v2/files/{fileID}/sheets/{sheetID}/fields
Method	POST
Content-Type	application/json
Accept	application/json

请求头部

详见Headers。

请求参数

路径参数

参数名	类型	必选	描述
fileID	string	是	文档唯一标识，详见fileID
sheetID	string	是	Smartsheet 子表 ID，详见子表 ID

查询参数

无

请求体

参数名	类型	必选	描述
updateFields	JSON Object(UpdateFieldsRequest)	是	更新字段请求

响应参数

请求体

参数名	类型	描述
ret	integer	业务返回码
msg	string	业务返回码描述
data.updateFields	JSON Object(UpdateFieldsResponse)	更新字段响应

请求包体

POST /openapi/smartsheet/v2/files/DAAAAAAAAAAAA/sheets/at5j8y/fields HTTP/1.1
Access-Token: ACCESS_TOKEN
Client-Id: CLIENT_ID
Content-Type: application/json
Content-Length: 1

{'updateFields': {'fields': [{'fieldID': 'fUb1bY', 'fieldTitle': 'Update A Field'}]}}

示例

curl --location --request POST 'https://{domain}/openapi/smartsheet/v2/files/DAAAAAAAAAAAA/sheets/at5j8y/fields' \
--header 'Access-Token: ACCESS_TOKEN' \
--header 'Client-Id: CLIENT_ID' \
--header 'Content-Type: application/json' \
--data-raw '{
    "updateFields": {
        "fields": [{
            "fieldID": "fUb1bY",
            "fieldTitle": "Update A Field"
        }]
    }
}'