更新视图 - 文档 - 企业微信开发者中心

最后更新：2024/09/12

添加视图

参数详细说明

ViewProperty

SortSpec

GroupSpec

FilterSpec

Condition

Operator

FilterDataTimeValue

DateTimeType

添加视图

本接口用于在 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": {
	}
}

参数	类型	是否必须	说明
docid	string	是	文档的docid
sheet_id	string	是	Smartsheet 子表ID
view_id	string	是	视图ID
view_title	string	否	视图标题
property	object(ViewProperty)	否	视图的排序/过滤/分组配置，详见ViewProperty

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

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

参数	类型	说明
errcode	int32	错误码
errmsg	string	错误码说明
view	object(View)	更新成功的视图内容

参数详细说明

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

参数名	类型	描述
view_id	string	视图 ID
view_title	string	视图标题
view_type	string	视图类型。见ViewType
property	object(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
}

参数名	类型	是否必须	描述
auto_sort	bool	否	记录变更后自动重新排序
sort_spec	object(SortSpec)	否	排序设置
group_spec	object(GroupSpec)	否	分组设置
filter_spec	object(FilterSpec)	否	过滤设置
is_field_stat_enabled	bool	否	是否使用数据统计
field_visibility	object	否	类似map。 key为字段ID, value为布尔值表示是否显示
frozen_field_count	int32	否	冻结列数量，从首列开始

{
	 "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",
	"operator": "OPERATOR_CONTAINS",
	"string_value": {
		"value": ["hello world"]
	}
}

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

{
	"field_id": "FIELDID2",
	"operator": "OPERATOR_IS",
	"user_value": {
		"value": ["USERID1"]
	}
}

参数名	类型	是否必须	描述
field_id	string	是	字段ID
operator	string	是	判断类型。见Operator
string_value.value	string[]	否	文本、网址、电话、邮箱、地理位置、关联、单选、多选等列类型使用。关联列为记录ID；选项列为选项ID；其它为文本值
number_value.value	double	否	数字、进度列类型使用
bool_value.value	bool	否	复选框列类型使用
user_value.value	string[]	否	人员、创建人、最后编辑人列类型使用，值为成员ID
date_time_value	object(FilterDataTimeValue)	否	日期、创建时间、最后编辑时间列类型使用

筛选值判断操作类型	说明
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_RANGE`)时必填

日期值类型	说明
DATE_TIME_TYPE_DETAIL_DATE	具体时间
DATE_TIME_TYPE_DETAIL_DATE_RANGE	具体时间范围
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 天内

网络研讨会 (Webinar) 管理

电话入会（PSTN）管理

会议室连接器（MRA）管理