内容操作
适用版本>=v7.0.2407b.20240725
接口说明:内容操作
请求说明
| 请求地址 | 配置域名+/graph+/v7/drives/{drive_id}/files/{file_id}/content/operate |
|---|---|
| 请求方法 | POST |
| 签名方式 | WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名) |
| 权限要求 | 应用文档(appfile)格式处理能力(应用授权) kso.appfile.cps.readwrite |
请求头(Header)
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
| Authorization | 是 | 授权凭证,格式为: Bearer {access_token} |
路径参数(Path)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| drive_id | string | 是 | 驱动盘id,长度不超过1024位 |
| file_id | string | 是 | 文件id,长度不超过1024位 |
查询参数(Query)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| _w_third_user_id | string | 否 | 用户id,长度范围[1,64] |
请求体(Body)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| dst_drive_id | string | 否 | 指定结果文件存储的drive盘,不传时默认与原文档存同一个盘内,长度不超过1024位 |
| steps | []object | 是 | 操作步骤,可以选择operate里面的一种或者多种进行组合操作 |
| ∟ operate | string | 是 | 操作类型,可选值:OFFICE_CLEAN:清稿;SET_FLOAT_IMAGE: 将表格中的单元格图片处理为浮动图片,仅支持.xlsx后缀的文件; |
| ∟ args | object | 否 | 操作参数 |
| ∟ ∟ clean_options | []string | 否 | operate参数为OFFICE_CLEAN时可用。可选项:accept_all_revisions:指定接受所有修订; delete_all_comments:删除所有批注;delete_all_ink:删除所有墨迹;不传则默认所有参数都会生效 |
请求体示例
{
"dst_drive_id": "string",
"steps": [
{
"args": {
"clean_options": [
"string"
]
},
"operate": "string"
}
]
}响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object | |
| ∟ created_by | object | 创建者信息 |
| ∟ ∟ id | string | 身份ID |
| ∟ ∟ type | string | Enum: "user" "sp",身份类型 |
| ∟ ctime | integer | 创建时间,时间戳,单位为秒 |
| ∟ drive_id | string | 驱动盘id |
| ∟ id | string | 文件id |
| ∟ link_id | string | 链接id(应用文档:忽略此参数) |
| ∟ link_url | string | 链接url(应用文档:忽略此参数) |
| ∟ modified_by | object | 修改者信息 |
| ∟ ∟ id | string | 身份ID |
| ∟ ∟ type | string | Enum: "user" "sp",身份类型 |
| ∟ mtime | integer | 修改时间,时间戳,单位为秒 |
| ∟ name | string | 文件名 |
| ∟ parent_id | string | 父目录id(应用文档:0) |
| ∟ shared | boolean | 是否开启分享(应用文档:false) |
| ∟ size | integer | 文件大小 |
| ∟ type | string | Enum: "folder" "file" "shortcut",文件类型(应用文档:file) |
| ∟ version | integer | 文件版本号 |
| code | integer | 错误码,参照《错误码说明》 |
| msg | string | 状态信息 |
| detail | string | 详细信息 |
响应体示例
{
"code": 0,
"data": {
"id": "string",
"drive_id": "string",
"mtime": 0,
"link_url": "",
"link_id": "",
"shared": false,
"parent_id": "0",
"created_by": {
"id": "string",
"type": "sp"
},
"modified_by": {
"id": "string",
"type": "sp"
},
"size": 0,
"version": 0,
"type": "file",
"name": "string",
"ctime": 0
},
"detail": "",
"msg": "ok"
}