Skip to content

删除记录

适用版本>=v7.0.2406b.20240627

接口说明:删除记录

请求说明

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

请求头(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)

名称类型是否必填说明
modestring删除模式,可选值:all删除所有记录,默认为 include
isBatchbool是否批量删除
records[]object数组内每一个元素代表一条要修改的记录
idstring要修改的记录id

请求体示例

{
    "preferId": false,
    "valuePreferId": false,
    "omitFailure": false,
    "textValue": "original",
    "linkValue": "id",
    "records": [
        {
            "fields": {
                "名称": "Hello",
                "数量": 123
            }
        },
        {
            "fields": {
                "数量": 666
            }
        }
    ]
}

响应体(Response)

名称类型说明
detailobject多维表格基本信息返回
records[]objectsheets信息
fields[]object记录字段
idstring记录id
resultstring返回结果

响应体示例

{
    "detail": {
        "records": [
            {
                "fields": {
                    "名称": "Hello",
                    "数量": 123,
                    "状态": "未开始"
                },
                "id": "B"
            },
            {
                "fields": {
                    "名称": "B",
                    "数量": 666,
                    "状态": "进行中"
                },
                "id": "C"
            }
        ]
    },
    "result": "ok"
}