查询字段

... 2022-7-14 大约 3 分钟

# 查询字段

fileID

150

# 接口说明

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

# 权限说明

本接口需要拥有以下任意一项权限：

scope.smartsheet

# 请求格式

描述	定义
Path	/openapi/smartbook/v2/files/{fileID}/sheets/{sheetID}
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/smartbook/v2/files/300000000$AAAAAAAAA/sheets/at5j8y HTTP/1.1
Host: docs.qq.com
Access-Token: ACCESS_TOKEN
Client-Id: CLIENT_ID
Open-Id: OPEN_ID
Content-Type: application/json
Content-Length: 1

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

1
2
3
4
5
6
7
8
9

# 示例

curl --location --request POST 'https://docs.qq.com/openapi/smartbook/v2/files/300000000$AAAAAAAAA/sheets/at5j8y' \
--header 'Access-Token: ACCESS_TOKEN' \
--header 'Client-Id: CLIENT_ID' \
--header 'Open-Id: OPEN_ID' \
--header 'Content-Type: application/json' \
--data-raw '{
    "getFields": {
        "offset": 0,
        "limit": 10
    }
}'

1
2
3
4
5
6
7
8
9
10
11

# 响应包体

HTTP/1.1 200 OK
Date: Thu, 28 Jul 2022 15:34:46 GMT
Content-Type: text/plain; charset=utf-8
Content-Length: 3
Connection: keep-alive
 
{'ret': 0, 'msg': 'Succeed', 'data': {'getFields': {'fields': [{'fieldID': 'fUb1bY', 'fieldTitle': 'aaa', 'fieldType': 1, 'propertyText': {}}, {'fieldID': 'fRBSYP', 'fieldTitle': '数字', 'fieldType': 2, 'propertyNumber': {'decimalPlaces': 0, 'useSeparate': True}}, {'fieldID': 'fAG7eu', 'fieldTitle': 'Test', 'fieldType': 9, 'propertySelect': {'isMultiple': False, 'isQuickAdd': True, 'options': [{'id': 'ojmXaI', 'style': 8, 'text': '对'}]}}, {'fieldID': 'fwwGm0', 'fieldTitle': '日期', 'fieldType': 4, 'propertyDateTime': {'autoFill': False, 'format': 'yyyy"年"m"月"d"日"'}}, {'fieldID': 'fOtkeR', 'fieldTitle': '图片', 'fieldType': 5, 'propertyImage': {}}, {'fieldID': 'fguSYF', 'fieldTitle': '设计', 'fieldType': 1, 'propertyText': {}}, {'fieldID': 'fNtoOh', 'fieldTitle': 'test', 'fieldType': 3, 'propertyCheckbox': {'checked': False}}, {'fieldID': 'f4lrEr', 'fieldTitle': 'Hyper Link', 'fieldType': 8, 'propertyUrl': {'type': 1}}, {'fieldID': 'fB4mtA', 'fieldTitle': 'jjjjj', 'fieldType': 16, 'propertyEmail': {}}, {'fieldID': 'fPEXQP', 'fieldTitle': 'datetime', 'fieldType': 4, 'propertyDateTime': {'autoFill': False, 'format': 'YYYY年MM月D日'}}], 'hasMore': False, 'next': 0, 'total': 10}}}

1
2
3
4
5
6
7

# 错误码

错误码	错误说明	排查建议
10313	Access-Token 为空	HTTP Header 里 `Access-Token` 校验失败，请参考示例中的携带方式，检查相应字段。详情请见Headers。
10303	Open-Id 错误	HTTP Header 里 `Open-Id` 与预期不符，可能的原因有： - `Open-Id` 为空。请参考示例中的携带方式，检查相应字段。详情请见Headers。 - `Open-Id` 与 `Access-Token` 不匹配，请检查 Header 内容和获取 Token 接口回包是否一致。
10302	Client-Id 错误	HTTP Header 里 `Client-Id` 与预期不符，可能的原因有： - `Client-Id` 为空。请参考示例中的携带方式，检查相应字段。详情请见Headers。 - `Client-Id` 与 `Access-Token` 不匹配，请检查 Header 内容和调用获取 Token 接口接口时参数中的 `Client-Id` 是否一致。
37019	Token 校验失败，错误或过期	检查位于 HTTP Header 中的 `Access-Token` 是否正确，获取 Token 的方式请查阅授权流程以及获取 Token 接口

查询更多业务返回码

删除字段更新字段