登录
基础
连接微信
办公目录
本接口用于获取 Smartsheet 中某个子表里全部视图信息。
请求方式：POST(HTTPS)
请求地址：https://qyapi.weixin.qq.com/cgi-bin/wedoc/smartsheet/get_views?access_token=ACCESS_TOKEN
请求包体：
{
"docid": "DOCID",
"sheet_id": "ezPcdA",
"view_ids": [
"vPpw9C",
"vfM2tt"
],
"offset": 0,
"limit": 1
}参数说明
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| docid | string | 是 | 文档的docid |
| sheet_id | string | 是 | Smartsheet 子表ID |
| view_ids | string[] | 否 | 需要查询的视图 ID 数组 |
| offset | uint32 | 否 | 偏移量，初始值为 0 |
| limit | uint32 | 否 | 分页大小 , 每页返回多少条数据；当不填写该参数或将该参数设置为 0 时，如果总数大于 1000，一次性返回 1000 个视图，当总数小于 1000 时，返回全部视图；limit 最大值为 1000 |
权限说明
返回示例
{
"errcode": 0,
"errmsg": "ok",
"total": 2,
"has_more": true,
"next": 1,
"views": [
]
}参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | int32 | 错误码 |
| errmsg | string | 错误码说明 |
| total | uint32 | 符合筛选条件的视图总数 |
| has_more | bool | 是否还有更多项 |
| next | uint32 | 下次下一个搜索结果的偏移量 |
| views | Object[](View) | 视图数据 |
示例
{
"view_id": "vabcde",
"view_title": "默认视图",
"view_type": "VIEW_TYPE_GRID"
}视图信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| view_id | string | 视图 ID |
| view_title | string | 视图标题 |
| view_type | string | 视图类型。见ViewType |
| property | object(ViewProperty) | 视图属性 |
视图类型：
| 枚举类型 | 描述 |
|---|---|
| VEW_UNKNOWN | 未知类型视图，传递该值不合法 |
| VIEW_TYPE_GRID | 表格视图 |
| VIEW_TYPE_KANBAN | 看板视图 |
| VIEW_TYPE_GALLERY | 画册视图 |
| VIEW_TYPE_GANTT | 甘特视图 |
示例
{
"auto_sort": false,
"sort_spec": {},
"filter_spec": {
},
"group_spec": {},
"is_field_stat_enabled": false,
"field_visibility": {
"f1gHSR": false,
"fabcde": false
},
"frozen_field_count": 0,
"color_config": {
"conditions": [{
"id": "4840474257",
"type": "VIEW_COLOR_CONDITION_TYPE_CELL",
"color": "chromeAmberLighten_5",
"condition": {
"field_id": "fRCjJz",
"field_type": "FIELD_TYPE_TEXT",
"operator": "OPERATOR_CONTAINS",
"string_value": {
"value": [
"5555"
]
}
}
}]
}
}参数说明
| 参数名 | 类型 | 描述 |
|---|---|---|
| auto_sort | bool | 记录变更后自动重新排序 |
| sort_spec | object(SortSpec) | 排序设置 |
| gourp_spec | object(GroupSpec) | 分组设置 |
| filter_spec | object(FilterSpec) | 过滤设置 |
| is_field_stat_enabled | bool | 是否使用数据统计 |
| field_visibility | object | 类似map。 key为字段ID, value为布尔值表示是否显示 |
| frozen_field_count | int32 | 冻结列数量，从首列开始 |
| color_config | object(ViewColorConfig) | 填色设置 |
示例
{
"sort_infos": [
{
"field_id": "FIELDID1",
"desc": false
},
{
"field_id": "FIELDID2",
"desc": true
}
]
}参数说明
| 参数名 | 类型 | 描述 |
|---|---|---|
| sort_infos | object[] | 参与排序的字段列表 |
| sort_infos.field_id | string | 字段id |
| sort_infoes.desc | bool | 是否降序 |
示例
{
"groups": [
{
"field_id": "FIELDID1",
"desc": false
},
{
"field_id": "FIELDID2",
"desc": true
}
]
}参数说明
| 参数名 | 类型 | 描述 |
|---|---|---|
| groups | object[] | 参与分组的字段列表 |
| groups.field_id | string | 字段id |
| groups.desc | bool | 是否降序 |
示例
{
"conjunction": "CONJUNCTION_AND",
"conditions": [
]
}参数说明
| 参数名 | 类型 | 描述 |
|---|---|---|
| conjunction | string | 多个conditions之间是以and(CONJUNCTION_AND)还是or(CONJUNCTION_OR)进行组合 |
| conditions | object[](Condition) | 判断条件 |
注：不同字段类型支持的筛选不同，需要根据智能表格不同字段类型实际支持的筛选条件进行组合
示例1
过滤FIELDID1字段包含文本hello world的记录
{
"field_id": "FIELDID1",
"field_type": "FIELD_TYPE_TEXT",
"operator": "OPERATOR_CONTAINS",
"string_value": {
"value": [
"hello world"
]
}
}示例2
过滤FIELDID2字段为用户USERID1的记录
{
"field_id": "FIELDID2",
"field_type": "FIELD_TYPE_USER",
"operator": "OPERATOR_IS",
"user_value": {
"value": ["USERID1"]
}
}示例3
过滤FIELDID3字段为日期2025年5月14日的记录
{
"field_id": "FIELDID3",
"field_type": "FIELD_TYPE_DATE_TIME",
"operator": "OPERATOR_IS",
"date_time_value": {
"type": "DATE_TIME_TYPE_DETAIL_DATE",
"value": [
"1747152000000"
]
}
}
参数说明
| 参数名 | 类型 | 描述 |
|---|---|---|
| field_id | string | 字段ID |
| field_type | string | 字段类型。见FieldType |
| operator | string | 判断类型。见Operator |
| string_value.value | string[] | 文本、网址、电话、邮箱、地理位置、单选、多选等列类型使用。选项列为选项ID；其它为文本值 |
| number_value.value | double | 数字、进度列类型使用 |
| bool_value.value | bool | 复选框列类型使用 |
| user_value.value | string[] | 人员、创建人、最后编辑人列类型使用，值为成员ID |
| date_time_value | object(FilterDataTimeValue) | 日期、创建时间、最后编辑时间列类型使用 |
| 字段类型 | 说明 |
|---|---|
| FIELD_TYPE_TEXT | 文本 |
| FIELD_TYPE_NUMBER | 数字 |
| FIELD_TYPE_CHECKBOX | 复选框 |
| FIELD_TYPE_DATE_TIME | 日期 |
| FIELD_TYPE_IMAGE | 图片 |
| FIELD_TYPE_ATTACHMENT | 文件 |
| FIELD_TYPE_USER | 人员 |
| FIELD_TYPE_URL | 链接 |
| FIELD_TYPE_SELECT | 多选 |
| FIELD_TYPE_CREATED_USER | 创建人 |
| FIELD_TYPE_MODIFIED_USER | 最后编辑人 |
| FIELD_TYPE_CREATED_TIME | 创建时间 |
| FIELD_TYPE_MODIFIED_TIME | 最后编辑时间 |
| FIELD_TYPE_PROGRESS | 进度 |
| FIELD_TYPE_PHONE_NUMBER | 电话 |
| FIELD_TYPE_EMAIL | 邮箱 |
| FIELD_TYPE_SINGLE_SELECT | 单选 |
| FIELD_TYPE_LOCATION | 地理位置 |
| 筛选值判断操作类型 | 说明 |
|---|---|
| OPERATOR_UNKNOWN | 未知 |
| OPERATOR_IS | 等于 |
| OPERATOR_IS_NOT | 不等于 |
| OPERATOR_CONTAINS | 包含 |
| OPERATOR_DOES_NOT_CONTAIN | 不包含 |
| OPERATOR_IS_GREATER | 大于 |
| OPERATOR_IS_GREATER_OR_EQUAL | 大于或等于 |
| OPERATOR_IS_LESS | 小于 |
| OPERATOR_IS_LESS_OR_EQUAL | 小于或等于 |
| OPERATOR_IS_EMPTY | 为空 |
| OPERATOR_IS_NOT_EMPTY | 不为空 |
| 参数名 | 类型 | 描述 | |
|---|---|---|---|
| type | string | 日期类型。见DateTimeType | |
| value | string[] | 是 | 具体日期值，type为具体日期(DATE_TIME_TYPE_DETAIL_DATE)时必填 |
| 日期值类型 | 说明 |
|---|---|
| DATE_TIME_TYPE_DETAIL_DATE | 具体时间 |
| DATE_TIME_TYPE_TODAY | 今天 |
| DATE_TIME_TYPE_TOMORROW | 明天 |
| DATE_TIME_TYPE_YESTERDAY | 昨天 |
| DATE_TIME_TYPE_CURRENT_WEEK | 本周 |
| DATE_TIME_TYPE_LAST_WEEK | 上周 |
| DATE_TIME_TYPE_CURRENT_MONTH | 本月 |
| DATE_TIME_TYPE_THE_PAST_7_DAYS | 过去 7 天内 |
| DATE_TIME_TYPE_THE_NEXT_7_DAYS | 接下来 7 天内 |
| DATE_TIME_TYPE_LAST_MONTH | 上月 |
| DATE_TIME_TYPE_THE_PAST_30_DAYS | 过去 30 天内 |
| DATE_TIME_TYPE_THE_NEXT_30_DAYS | 接下来 30 天内 |
示例
{
"conditions": [
]
}参数说明
| 参数名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| conditions | object[](ViewColorCondition) | 是 | 判断条件 |
示例
{
"id": "5599107762",
"type": "VIEW_COLOR_CONDITION_TYPE_CELL",
"color": "chromeOrangeLighten_5",
"condition": {
"field_id": "fMPZMg",
"field_type": "FIELD_TYPE_NUMBER",
"operator": "OPERATOR_IS",
"number_value": {
"value": 5
}
}
}参数说明
| 参数名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | string | 否 | 填色id，新增时不需要传入，更新时传入 |
| type | string | 是 | 填色类型,见(ViewColorConditionType) |
| color | string | 是 | 颜色，见(ViewColor) |
| conditions | object[](Condition) | 是 | 判断条件 |
| 填色类型 | 说明 |
|---|---|
| VIEW_COLOR_CONDITION_TYPE_ROW | 行 |
| VIEW_COLOR_CONDITION_TYPE_COLUMN | 列 |
| VIEW_COLOR_CONDITION_TYPE_CELL | 单元格 |
| 颜色值 | 描述 |
|---|---|
| fillColorGray_5 | 灰色_5 |
| accentBlueLighten_5 | 蓝色_5 |
| chromeCyanLighten_5 | 青色_5 |
| chromeMintLighten_5 | 薄荷色_5 |
| chromeRedLighten_5 | 红色_5 |
| chromeOrangeLighten_5 | 橙色_5 |
| chromeAmberLighten_5 | 琥珀色_5 |
| chromeVioletLighten_5 | 紫色_5 |
| chromePinkLighten_5 | 粉色_5 |
| fillColorGray_4 | 灰色_4 |
| accentBlueLighten_4 | 蓝色_4 |
| chromeCyanLighten_4 | 青色_4 |
| chromeMintLighten_4 | 薄荷色_4 |
| chromeRedLighten_4 | 红色_4 |
| chromeOrangeLighten_4 | 橙色_4 |
| chromeAmberLighten_4 | 琥珀色_4 |
| chromeVioletLighten_4 | 紫色_4 |
| chromePinkLighten_4 | 粉色_4 |
| fillColorGray_3 | 灰色_3 |
| accentBlueLighten_3 | 蓝色_3 |
| chromeCyanLighten_3 | 青色_3 |
| chromeMintLighten_3 | 薄荷色_3 |
| chromeRedLighten_3 | 红色_3 |
| chromeOrangeLighten_3 | 橙色_3 |
| chromeAmberLighten_3 | 琥珀色_3 |
| chromeVioletLighten_3 | 紫色_3 |
| chromePinkLighten_3 | 粉色_3 |
基础连接微信办公基础连接微信办公基础连接微信办公