文档软删除 - DeleteDocumentSoft
功能介绍
软删除文档,执行后文档被放到回收站。
URI
POST /v1/app/documents/softdelete/{document_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| document_id | 是 | String | 参数解释: 文档ID。 约束限制: 不涉及。 取值范围: [1-64]个字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 参数解释: 认证凭证。 约束限制: 格式:Bearer {access_token}。 取值范围: [1-1024]个字符。 默认取值: 不涉及。 |
| X-Cloud-Doc-AppId | 是 | String | 参数解释: APP ID。 约束限制: 不涉及。 取值范围: [1-128]个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-Trace-Id | String | 消息追踪id。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-Trace-Id | String | 消息追踪id。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
删除文档d3XXX1-0fb8-4926-8f34-6XXXX11。
POST https://{Endpoint}/v1/app/documents/softdelete/d3XXX1-0fb8-4926-8f34-6XXXX11 响应示例
状态码:200
无
状态码:400
{
"error_code" : "KPGE.00001000",
"error_msg" : "Parameter error."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 错误响应。 |
错误码
请参见错误码。