cn.felord.reactive.api

Interface SmartSheetApi

public interface SmartSheetApi

智能表格操作相关API

Since:

2024 /8/30

Author:

dax

Method Summary

Modifier and Type	Method and Description
io.reactivex.rxjava3.core.Single<GenericResponse<List<SheetField>>>	addFields(AddOrUpdateFieldsRequest request) 添加字段
io.reactivex.rxjava3.core.Single<GenericResponse<List<RecordResult>>>	addRecords(AddRecordRequest request) 添加记录
io.reactivex.rxjava3.core.Single<GenericResponse<SmartSheetProperties>>	addSheet(AddSheetRequest request) 添加子表
io.reactivex.rxjava3.core.Single<GenericResponse<SheetViewInfo>>	addView(AddViewRequest request) 添加视图
io.reactivex.rxjava3.core.Single<WeComResponse>	deleteFields(DelFieldsRequest request) 删除字段
io.reactivex.rxjava3.core.Single<WeComResponse>	deleteRecords(DelRecordRequest request) 删除记录
io.reactivex.rxjava3.core.Single<WeComResponse>	deleteSheet(DelSheetRequest request) 删除子表
io.reactivex.rxjava3.core.Single<WeComResponse>	deleteViews(DelViewRequest request) 删除视图
io.reactivex.rxjava3.core.Single<SmartFieldsResponse>	getFields(SmartFieldsRequest request) 查询字段
io.reactivex.rxjava3.core.Single<SmartRecordsResponse>	getRecords(SmartRecordsRequest request) 查询记录
io.reactivex.rxjava3.core.Single<GenericResponse<List<SmartSheetInfo>>>	getSheet(QuerySheetRequest request) 查询子表
io.reactivex.rxjava3.core.Single<SmartViewsResponse>	getViews(SmartViewRequest request) 查询视图
io.reactivex.rxjava3.core.Single<GenericResponse<List<SheetField>>>	updateFields(AddOrUpdateFieldsRequest request) 更新字段
io.reactivex.rxjava3.core.Single<GenericResponse<List<RecordResult>>>	updateRecords(UpdateRecordRequest request) 更新记录
io.reactivex.rxjava3.core.Single<WeComResponse>	updateSheet(UpdateSheetRequest request) 更新子表
io.reactivex.rxjava3.core.Single<GenericResponse<SheetViewDetail>>	updateView(UpdateViewRequest request) 更新视图

Method Detail

addSheet

@POST(value="wedoc/smartsheet/add_sheet")
io.reactivex.rxjava3.core.Single<GenericResponse<SmartSheetProperties>> addSheet(@Body
                                                                                                                           AddSheetRequest request)

添加子表

本接口用于在表格的某个位置添加一个智能表， 该智能表不存在视图、记录和字段，可以使用 API 在该智能表中添加视图、记录和字段。

Parameters:

request - the request

Returns:

the generic response

deleteSheet

@POST(value="wedoc/smartsheet/delete_sheet")
io.reactivex.rxjava3.core.Single<WeComResponse> deleteSheet(@Body
                                                                                                         DelSheetRequest request)

删除子表

本接口用于删除在线表格中的某个智能表。

Parameters:

request - the request

Returns:

the we com response

updateSheet

@POST(value="wedoc/smartsheet/update_sheet")
io.reactivex.rxjava3.core.Single<WeComResponse> updateSheet(@Body
                                                                                                         UpdateSheetRequest request)

更新子表

本接口用于修改表格中某个子表的标题。

Parameters:

request - the request

Returns:

the we com response

addView

@POST(value="wedoc/smartsheet/add_view")
io.reactivex.rxjava3.core.Single<GenericResponse<SheetViewInfo>> addView(@Body
                                                                                                                  AddViewRequest request)

添加视图

本接口用于在 Smartsheet 中的某个子表里添加一个新视图。单表最多允许有200个视图。

Parameters:

request - the request

Returns:

generic response

deleteViews

@POST(value="wedoc/smartsheet/delete_views")
io.reactivex.rxjava3.core.Single<WeComResponse> deleteViews(@Body
                                                                                                         DelViewRequest request)

删除视图

本接口用于在 smartsheet 中的某个子表里删除若干个视图。

Parameters:

request - the request

Returns:

the we com response

updateView

@POST(value="wedoc/smartsheet/update_view")
io.reactivex.rxjava3.core.Single<GenericResponse<SheetViewDetail>> updateView(@Body
                                                                                                                          UpdateViewRequest request)

更新视图

本接口用于在 Smartsheet 中的某个子表里添加一个新视图。

Parameters:

request - the request

Returns:

the generic response

addFields

@POST(value="wedoc/smartsheet/add_fields")
io.reactivex.rxjava3.core.Single<GenericResponse<List<SheetField>>> addFields(@Body
                                                                                                                         AddOrUpdateFieldsRequest request)

添加字段

本接口用于在智能表中的某个子表里添加一列或多列新字段。单表最多允许有150个字段。

Parameters:

request - the request

Returns:

the generic response

deleteFields

@POST(value="wedoc/smartsheet/delete_fields")
io.reactivex.rxjava3.core.Single<WeComResponse> deleteFields(@Body
                                                                                                           DelFieldsRequest request)

删除字段

本接口用于删除智能表中的某个子表里的一列或多列字段。

Parameters:

request - the request

Returns:

the we com response

updateFields

@POST(value="wedoc/smartsheet/update_fields")
io.reactivex.rxjava3.core.Single<GenericResponse<List<SheetField>>> updateFields(@Body
                                                                                                                               AddOrUpdateFieldsRequest request)

更新字段

本接口用于更新智能中的某个子表里的一个或多个字段的标题和字段属性信息。 该接口只能更新字段名、字段属性，不能更新字段类型。

Parameters:

request - the request

Returns:

the generic response

addRecords

@POST(value="wedoc/smartsheet/add_records")
io.reactivex.rxjava3.core.Single<GenericResponse<List<RecordResult>>> addRecords(@Body
                                                                                                                             AddRecordRequest request)

添加记录

本接口用于在 Smartsheet 中的某个子表里添加一行或多行新记录。单表最多允许有40000行记录。 不能通过添加记录接口给创建时间、最后编辑时间、创建人和最后编辑人四种类型的字段添加记录。

Parameters:

request - the request

Returns:

the generic response

deleteRecords

@POST(value="wedoc/smartsheet/delete_records")
io.reactivex.rxjava3.core.Single<WeComResponse> deleteRecords(@Body
                                                                                                             DelRecordRequest request)

删除记录

本接口用于删除 Smartsheet 的某个子表中的一行或多行记录。

Parameters:

request - the request

Returns:

the we com response

updateRecords

@POST(value="wedoc/smartsheet/update_records")
io.reactivex.rxjava3.core.Single<GenericResponse<List<RecordResult>>> updateRecords(@Body
                                                                                                                                   UpdateRecordRequest request)

更新记录

本接口用于更新 Smartsheet 中的某个子表里的一行或多行记录。 注意：不能通过更新记录接口给创建时间、最后编辑时间、创建人和最后编辑人四种类型的字段更新记录。

Parameters:

request - the request

Returns:

the we com response

getSheet

@POST(value="wedoc/smartsheet/get_sheet")
io.reactivex.rxjava3.core.Single<GenericResponse<List<SmartSheetInfo>>> getSheet(@Body
                                                                                                                           QuerySheetRequest request)

查询子表

本接口用于查询一篇在线表格中全部智能表信息。

Parameters:

request - the request

Returns:

the sheet

getViews

@POST(value="wedoc/smartsheet/get_views")
io.reactivex.rxjava3.core.Single<SmartViewsResponse> getViews(@Body
                                                                                                        SmartViewRequest request)

查询视图

本接口用于获取 Smartsheet 中某个子表里全部视图信息。

Parameters:

request - the request

Returns:

the views

getFields

@POST(value="wedoc/smartsheet/get_fields")
io.reactivex.rxjava3.core.Single<SmartFieldsResponse> getFields(@Body
                                                                                                           SmartFieldsRequest request)

查询字段

本接口用于获取智能表中某个子表下字段信息， 该接口可以完成下面三种功能：获取全部字段信息、依据字段名获取对应字段、依据字段 ID 获取对应字段信息。

Parameters:

request - the request

Returns:

the fields

getRecords

@POST(value="wedoc/smartsheet/get_records")
io.reactivex.rxjava3.core.Single<SmartRecordsResponse> getRecords(@Body
                                                                                                              SmartRecordsRequest request)

查询记录

本接口用于获取 Smartsheet 中某个子表下记录信息， 该接口可以完成下面三种功能：获取全部记录信息、依据字段名和记录 ID 获取对应记录、对记录进行排序。

Parameters:

request - the request

Returns:

the records