查询字段

接口说明

本接口用于获取 Smartsheet 中某个子表下字段信息，该接口可以完成下面三种功能：获取全部字段信息、依据字段名获取对应字段、依据字段 ID 获取对应字段信息。

请求格式

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

请求头部

详见Headers。

请求参数

路径参数

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

查询参数

无

请求体

参数名	类型	必选	描述
getFields	JSON Object(GetFieldsRequest)	是	查询字段请求

响应参数

请求体

参数名	类型	描述
ret	integer	业务返回码
msg	string	业务返回码描述
data.getFields	JSON Object(GetFieldsResponse)	查询字段响应

请求包体

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

{'getFields': {'offset': 0, 'limit': 10}}

示例

curl --location --request POST 'https://{domain}/openapi/smartsheet/v2/files/DAAAAAAAAAAAA/sheets/at5j8y/fields:list' \
--header 'Access-Token: ACCESS_TOKEN' \
--header 'Client-Id: CLIENT_ID' \
--header 'Content-Type: application/json' \
--data-raw '{
    "getFields": {
        "offset": 0,
        "limit": 10
    }
}'