删除记录
适用版本>=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_id | string | 是 | 文件id,字符串长度不超过32位 |
| sheet_id | string | 是 | sheet_id,通过查询表基本信息查询到的sheet_id |
请求体(Body)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| mode | string | 否 | 删除模式,可选值:all删除所有记录,默认为 include |
| isBatch | bool | 否 | 是否批量删除 |
| records | []object | 是 | 数组内每一个元素代表一条要修改的记录 |
| ∟ id | string | 是 | 要修改的记录id |
请求体示例
{
"preferId": false,
"valuePreferId": false,
"omitFailure": false,
"textValue": "original",
"linkValue": "id",
"records": [
{
"fields": {
"名称": "Hello",
"数量": 123
}
},
{
"fields": {
"数量": 666
}
}
]
}响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| detail | object | 多维表格基本信息返回 |
| ∟ records | []object | sheets信息 |
| ∟ ∟ fields | []object | 记录字段 |
| ∟ ∟ id | string | 记录id |
| result | string | 返回结果 |
响应体示例
{
"detail": {
"records": [
{
"fields": {
"名称": "Hello",
"数量": 123,
"状态": "未开始"
},
"id": "B"
},
{
"fields": {
"名称": "B",
"数量": 666,
"状态": "进行中"
},
"id": "C"
}
]
},
"result": "ok"
}