知识库知识库外部开放接口
删除文件夹
删除指定文件夹。文件夹下存在子文件夹时会失败,单租户并发删除上限为 10。
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| spaceId | int64 | 是 | 知识库空间 ID。 | 123456 |
| docId | int64 | 是 | 文档 ID。 | 987654 |
| qyId | int64 | 否 | 兼容字段,通常无需传。 | 0 |
| force | boolean | 否 | 是否强制删除。deleteFolder 会在服务端设置为 true。 | true |
| parentId | int64 | 否 | 父目录 ID,根目录为 0。 | 0 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。 | 200 |
| msg | string | 响应说明。成功通常为 ok;失败时为错误原因。 | ok |
| message | string | 兼容字段,部分异常场景可能返回错误说明。 | |
| data | boolean | 是否成功。 | true |
错误码
| 状态码 | 描述 |
|---|---|
| 400 | 请求参数错误。常见业务码:402 MISS_PARAM、403 ERR_PARAM。 |
| 401 | OPENAPI_AUTH 鉴权失败。常见业务码:405 AUTH_FAILED。 |
| 404 | 资源不存在。常见业务码:404 NOT_FOUND、408 SPACE_NOT_EXISTS。 |
| 500 | 服务内部异常。常见业务码:500 ERROR。 |
postEndpoint
/api/athena/openApi/external/deleteFoldercurl -X POST "https://b.163.com/api/athena/openApi/external/deleteFolder" \ -H "Content-Type: application/json" \ -d '{ "spaceId": 123456, "docId": 987654 }'{
"code": 200,
"msg": "ok",
"message": "string",
"data": true
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}这篇文档有帮助吗?