参数列表

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

# 参数列表

# AddRecordsRequest

在 Smartsheet 的某个表格中添加一行或多行记录的请求参数:

参数名 类型 描述
records JSON Array(AddRecords) 需要添加的记录的具体内容组成的 JSON 数组

# AddRecordsResponse

在 Smartsheet 的某个表格中添加一行或多行记录的响应参数:

参数名 类型 描述
records JSON Array(CommonRecords) 由添加成功的记录的具体内容组成的 JSON 数组

# DeleteRecordsRequest

删除 Smartsheet 的某个表格中一行或多行记录的请求参数:

参数名 类型 描述
recordIDs JSON Array(string) 记录 ID 组成的 JSON 数组

# GetRecordsRequest

查询 Smartsheet 的某个表格里全部或部分记录的请求参数:

参数名 类型 描述
viewID string 视图 ID
recordIDs JSON Array(string) 由记录 ID 组成的 JSON 数组
fieldTitles JSON Array(string) 由字段标题组成的 JSON 数组
sort JSON Array(Sort) 对返回记录进行排序
offset integer 偏移量,初始值为 0
limit integer 分页大小 , 每页返回多少条数据;当不填写该参数或将该参数设置为 0 时,如果总数大于 100,一次性返回 100 行记录,当总数小于 100 时,返回全部记录;limit 最大值为 100

# GetRecordsResponse

查询 Smartsheet 的某个表格里全部或部分记录的响应参数:

参数名 类型 描述
total integer 符合筛选条件的视图总数
hasMore bool 是否还有更多项
next integer 下次下一个搜索结果的偏移量
records JSON Array(Records) 由查询记录的具体内容组成的 JSON 数组

# UpdateRecordsRequest

在 Smartsheet 的某个表格中更新记录的请求参数:

参数名 类型 描述
records JSON Array(CommonRecords) 由需要更新的记录组成的 JSON 数组

# UpdateRecordsResponse

在 Smartsheet 的某个表格中更新一行或多行记录的响应参数:

参数名 类型 描述
records JSON Array(CommonRecords) 由更新成功的记录的具体内容组成的 JSON 数组
上次编辑于: 2023年6月1日 17:40
贡献者: mylochen , muyanyang