查询视图
... 2022-7-14 大约 2 分钟
# 查询视图
# 接口说明
本接口用于获取 Smartsheet 中某个子表里全部视图信息。
# 权限说明
本接口需要拥有以下任意一项权限：
scope.smartsheet
# 请求格式
| 描述 | 定义 |
|---|---|
| Path | /openapi/smartbook/v2/files/{fileID}/sheets/{sheetID} |
| Method | POST |
| Content-Type | application/json |
| Accept | application/json |
# 请求头部
详见Headers。
# 请求参数
# 查询参数
无
# 请求体
| 参数名 | 类型 | 必选 | 描述 |
|---|---|---|---|
| getViews | JSON Object(GetViewsRequest) | 是 | 查询视图请求 |
# 响应参数
# 请求体
| 参数名 | 类型 | 描述 |
|---|---|---|
| ret | integer | 业务返回码 |
| msg | string | 业务返回码描述 |
| data.getViews | JSON Object(GetViewsResponse) | 查询视图响应 |
# 请求包体
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
{'getViews': {'offset': 0, 'limit': 2}}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
1
2
3
4
5
6
7
8
9
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 '{
"getViews": {
"offset": 0,
"limit": 2
}
}'
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
1
2
3
4
5
6
7
8
9
10
11
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': {'getViews': {'total': 2, 'hasMore': False, 'next': 0, 'views': [{'viewID': 'vb2cd4', 'viewTitle': '表格视图', 'viewType': 2}, {'viewID': 'vb3hj1', 'viewTitle': '看板视图', 'viewType': 1}]}}}
1
2
3
4
5
6
7
2
3
4
5
6
7
1
2
3
4
5
6
7
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 接口 |