Skip to content

列举sheet下的记录,支持复杂查询条件

适用版本>=v7.0.2308b.20230824

接口说明:列举sheet下的记录,支持复杂查询条件

请求说明

请求地址配置域名+/graph+/v7/wo/api/v3/openapi/office/file/{fileid}/core/dbt/sheets/{sheet_id}/records/complex_query
请求方法POST
签名方式WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名)
权限要求查询多维表格(用户授权) kso.dbsheet.read

请求头(Header)

名称是否必填说明
Content-Type固定为: application/json
Wps-Docs-Date取当前时间,示例: Wed,23 Jan 2013 06:43:08 GMT
Wps-Docs-Authorization计算方法参考签名说明
Authorization授权凭证,格式为: Bearer {access_token}

路径参数(Path)

名称类型是否必填说明
file_idstring文件id,字符串长度不超过32位
sheet_idstringsheet_id,通过查询表基本信息查询到的sheet_id

请求体(Body)

名称类型是否必填说明
preferIdbool使用id来标识字段和选项。为true时,参数内全部的field、fields参数均按照id做解析(默认true)
pageSizeint用于分页获取记录,避免记录过多时一次性返回大量内容。缺省值及最大值为100,取值范围1-1000
viewIdstring填写后将从被指定的视图获取该用户所见到的记录;若不填写,则从工作表获取记录
maxRecordsint指定要获取的“前maxRecords条记录”,若不填写,则默认返回全部记录
fields[]string指定所返回记录中的字段信息,若不填写,指定viewId时将返回view上全部可见字段的信息,未指定viewId时返回sheet上全部字段的信息。依据 preferId 的值,需要输入字段名或字段id
offsetstring存在分页时,指定本次查询的起始记录(含)。若不填写或填写为空字符串,则从第一条记录开始获取
filterstring筛选条件,说明见下文
showRecordExtraInfobool为true时,会额外显示创建者、创建时间信息(与是否有创建者、创建时间字段无关)
showFieldsInfobool为true时,会额外地返回一个fields结构体,展示字段信息(类似Base Schema中的fields)。若请求参数指定fields,则返回的fields即为指定的fields字段;请求参数未指定fields时,将根据是否指定了viewId决定返回view上的可见字段或sheet上的全部字段

响应体(Response)

名称类型说明
detailobject多维表格基本信息返回
offsetstring起始记录ID
records[]objectsheets信息
idstring记录id
resultstring返回结果

响应体示例

{
    "detail": {
        "offset": "E",
        "records": [
            {
                "id": "B"
            },
            {
                "id": "C"
            },
            {
                "id": "D"
            }
        ]
    },
    "result": "ok"
}