服务商代开发
基础
数据与智能专区
应用接收专区通知
连接微信
客户联系
办公
服务商代开发
服务端API
文档
管理智能表格内容
更新视图
更新视图
最后更新:2025/08/20

目录

  • 更新视图
  • 参数详细说明
  •       View
  •       ViewProperty
  •       SortSpec
  •       GroupSpec
  •       FilterSpec
  •       Condition
  •       Operator
  •       FilterDataTimeValue
  •       DateTimeType
  •       ViewColorConfig
  •       ViewColorCondition
  •       ViewColorConditionType
  •       ViewColor
  • 更新视图

    本接口用于更新 Smartsheet 中的某个视图。

    请求方式:POST(HTTPS)
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/wedoc/smartsheet/update_view?access_token=ACCESS_TOKEN

    请求包体

    {
    	"docid": "DOCID",
    	"sheet_id": "123Abc",
    	"view_id": "VIEWID",
    	"view_title": "XXX",
    	"property": {
    	}
    }

    参数说明

    参数类型是否必须说明
    docidstring文档的docid
    sheet_idstringSmartsheet 子表ID
    view_idstring视图ID
    view_titlestring视图标题
    propertyobject(ViewProperty)视图的排序/过滤/分组/填色配置,详见ViewProperty

    权限说明

    • 自建应用需配置到“可调用应用”列表中的应用secret所获取的accesstoken来调用(accesstoken如何获取?
    • 第三方应用需具有“文档”权限
    • 代开发自建应用需具有“文档”权限

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"view": {
    	}
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    viewobject(View)更新成功的视图内容

    参数详细说明

    View

    示例

    {
    	"view_id": "vabcde",
    	"view_title": "默认视图",
    	"view_type": "VIEW_TYPE_GRID",
    	"property": {
    	}
    }

    视图信息:

    参数名类型描述
    view_idstring视图 ID
    view_titlestring视图标题
    view_typestring视图类型。见ViewType
    propertyobject(ViewProperty)视图属性

    ViewProperty

    示例

    {
    	"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_sortbool记录变更后自动重新排序
    sort_specobject(SortSpec)排序设置
    group_specobject(GroupSpec)分组设置
    filter_specobject(FilterSpec)过滤设置
    is_field_stat_enabledbool是否使用数据统计
    field_visibilityobject类似map。 key为字段ID, value为布尔值表示是否显示
    frozen_field_countint32冻结列数量,从首列开始
    color_configobject(ViewColorConfig)填色设置

    SortSpec

    示例

    {
    	 "sort_infos": [
    	 	{
    			"field_id": "FIELDID1",
    			"desc": false
    		},
    		{
    			"field_id": "FIELDID2",
    			"desc": true
    		}
    	 ]
    }

    参数说明

    参数名类型是否必须描述
    sort_infosobject[]参与排序的字段列表
    sort_infos.field_idstring字段id
    sort_infoes.descbool是否降序

    GroupSpec

    示例

    {
    	 "groups": [
    	 	{
    			"field_id": "FIELDID1",
    			"desc": false
    		},
    		{
    			"field_id": "FIELDID2",
    			"desc": true
    		}
    	 ]
    }

    参数说明

    参数名类型是否必须描述
    groupsobject[]参与分组的字段列表
    groups.field_idstring字段id
    groups.descbool是否降序

    FilterSpec

    示例

    {
    	"conjunction": "CONJUNCTION_AND",
    	"conditions": [
    	]
    }

    参数说明

    参数名类型是否必须描述
    conjunctionstring多个conditions之间是以and(CONJUNCTION_AND)还是or(CONJUNCTION_OR)进行组合
    conditionsobject[](Condition)判断条件

    Condition

    注:不同字段类型支持的筛选不同,需要根据智能表格不同字段类型实际支持的筛选条件进行组合

    示例1
    过滤FIELDID1字段包含文本hello world的记录

    {
    	"field_id": "FIELDID1",
    	"operator": "OPERATOR_CONTAINS",
    	"string_value": {
    		"value": ["hello world"]
    	}
    }

    示例2
    过滤FIELDID2字段为用户USERID1的记录

    {
    	"field_id": "FIELDID2",
    	"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_idstring字段ID
    field_typestiring字段类型
    operatorstring判断类型。见Operator
    string_value.valuestring[]文本、网址、电话、邮箱、地理位置、单选、多选等列类型使用。选项列为选项ID;其它为文本值
    number_value.valuedouble数字、进度列类型使用
    bool_value.valuebool复选框列类型使用
    user_value.valuestring[]人员、创建人、最后编辑人列类型使用,值为成员ID
    date_time_valueobject(FilterDataTimeValue)日期、创建时间、最后编辑时间列类型使用

    Operator

    筛选值判断操作类型说明
    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不为空

    FilterDataTimeValue

    参数名类型是否必须描述
    typestring日期类型。见DateTimeType
    valuestring[]具体日期值,type为具体日期(DATE_TIME_TYPE_DETAIL_DATE)

    DateTimeType

    日期值类型说明
    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 天内

    ViewColorConfig

    示例

    {
    	"conditions": [
    	]
    }

    参数说明

    参数名类型是否必须描述
    conditionsobject[](ViewColorCondition)判断条件

    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
    		}
    	}
    }

    参数说明

    参数名类型是否必须描述
    idstring填色id,新增时不需要传入,更新时传入
    typestring填色类型,见(ViewColorConditionType)
    colorstring颜色,见(ViewColor)
    conditionsobject[](Condition)判断条件

    ViewColorConditionType

    填色类型说明
    VIEW_COLOR_CONDITION_TYPE_ROW
    VIEW_COLOR_CONDITION_TYPE_COLUMN
    VIEW_COLOR_CONDITION_TYPE_CELL单元格

    ViewColor

    颜色值描述
    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
    上一篇删除视图
    下一篇查询视图
      本节内容
    服务端API
    基础
    数据与智能专区
    应用接收专区通知
    连接微信
    客户联系
    办公
    客户端API
    小程序
    基础
    连接微信
    办公
    JS-SDK
    基础
    连接微信
    办公
    更新日志
    联系我们