移动云空间文档至知识空间
该接口允许移动云空间文档至知识空间,并挂载在指定位置
Warning: ### 移动操作 ### 移动后,文档将从“我的空间”或“共享空间”转移至“知识库”后,无法从下列入口查看到文档:
- 云空间主页:快速访问
- 我的空间
- 共享空间
权限变更
移动后,文档会向所有可查看“页面树”的用户显示,默认继承父页面的权限设置。
Tip: 此接口为异步接口。若移动已完成(或文档已在Wiki中),则直接返回结果(Wiki token)。若尚未完成,则返回task id。请使用获取任务结果接口进行查询。
知识库权限要求,当前使用的 access token 所代表的应用或用户拥有:
- 文档可管理权限
- 原文件夹编辑权限
- 目标父节点容器编辑权限
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/wiki/v2/spaces/:space_id/nodes/move_docs_to_wiki |
| HTTP Method | POST |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | wiki:node:move 移动知识空间节点 wiki:wiki 查看、编辑和管理知识库 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
space_id | string | 知识库id 示例值:"1565676577122621" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
parent_wiki_token | string | 否 | 节点的父亲token。 传空或不传时将移动为知识空间一级节点。 示例值:"wikcnKQ1k3p******8Vabce" |
obj_type | string | 是 | 文档类型 示例值:"doc" 可选值有: - doc: 旧版文档 - sheet: 表格 - bitable: 多维表格 - mindnote: 思维导图 - docx: 新版文档 - file: 文件 - slides: slides(幻灯片) |
obj_token | string | 是 | 文档token 示例值:"doccnzAaOD******Wabcdef" |
apply | boolean | 否 | 没有权限时,是否申请移动文档。 如果申请移动,文档将在处理人同意时自动移动至指定位置。 示例值:true |
请求体示例
json
{
"parent_wiki_token": "wikcnKQ1k3p******8Vabce",
"obj_type": "doc",
"obj_token": "doccnzAaOD******Wabcdef"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ wiki_token | string | 移动后的知识库节点token |
└ task_id | string | 任务id |
└ applied | boolean | 是否提交了文档迁入申请 |
响应体示例
json
// 操作已完成
{
"code": 0,
"data": {
"wiki_token": "wikbcLZuhp4r9QuJumHzVabcdef"
},
"msg": "success"
}
// 或者操作尚未完成
{
"code": 0,
"data": {
"task_id": "7037044037068177428-075c9481e6a0007c1df689dfbe5b55a08b6b06f7"
},
"msg": "success"
}
// 如果无文档权限且申请移动(apply为true),申请已发出:
{
"code": 0,
"data": {
"applied": true
},
"msg": "success"
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 131001 | rpc fail | 服务报错,请稍后重试,或者拿响应体的header头里的x-tt-logid咨询oncall定位。 |
| 400 | 131002 | param err | 通常为传参有误,例如数据类型不匹配。请查看具体接口报错信息,报错不明确时请咨询oncall。 |
| 400 | 131003 | out of limit | 超出操作限制,例如节点数量限制。请参阅下表。 - 原/目标知识空间总节点数不超过40万。 - 原/目标知识空间目录树不超过50层。 - 目的父节点下单层节点数不超过2000。 - 单次移动节点数(带子节点)不超过2000。 |
| 400 | 131004 | invalid user | 非法用户。请咨询oncall。 |
| 400 | 131005 | not found | 未找到相关数据,例如id不存在。相关报错信息参考: - member not found:用户不是知识空间成员(管理员),无法删除。 - identity not found: userid不存在,无法添加/删除成员。 - space not found:知识空间不存在 - node not found:节点不存在 - document not found:文档不存在 报错不明确时请咨询oncall。 |
| 400 | 131006 | permission denied | 权限拒绝,相关报错信息参考: - wiki space permission denied:知识库权限鉴权不通过,需要成为知识空间管理员(成员)。 - node permission denied:文档节点权限鉴权不通过,读操作需要具备节点阅读权限,写操作(创建、移动等)则需要具备节点容器编辑权限。 - no source parent node permission:需要具备原父节点的容器编辑权限。 - no destination parent node permission:需要具备目标父节点的容器编辑权限,若移动到知识空间下,则需要成为知识空间管理员(成员)。 - only task creator can query status:只有任务创建者才能获取任务结果(用户或应用)。 - no move permission for document:缺少移动文档的权限,需要具备文档可管理权限和父文件夹编辑权限。参阅 如何为应用身份(tenant_access_token)开通个人云空间中文件夹的查看或编辑权限 注意:应用访问或操作文档时,除了申请 API 权限,还需授权具体文档资源的阅读、编辑或管理权限。 请参考以下步骤操作: 1. 当遇到资源权限不足的情况:参阅如何给应用授权访问知识库文档资源。 2. 也可直接将应用添加为知识库管理员(成员):参阅如何将应用添加为知识库管理员(成员)。 3. 若无法解决或报错信息不明确时:请咨询技术支持。 |
| 400 | 131007 | internal err | 服务内部错误,请勿重试,拿返回值的header头里的x-tt-logid咨询oncall定位。 |
