Skip to content

获取任务结果

该方法用于获取wiki异步任务的结果

Tip: 知识库权限要求,当前 access token 所代表的用户或应用(机器人):

  • 为任务创建者

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/wiki/v2/tasks/:task_id
HTTP MethodGET
接口频率限制100 次/分钟
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可wiki:space:read 查看知识空间信息 wiki:wiki 查看、编辑和管理知识库 wiki:wiki:readonly 查看知识库

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

名称类型描述
task_idstring任务id
示例值:"7037044037068177428-075c9481e6a0007c1df689dfbe5b55a08b6b06f7"

查询参数

名称类型必填描述
task_typestring任务类型
示例值:move
可选值有
- move: 移动云空间文档至知识空间任务

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ tasktask_result任务结果
    └ task_idstring任务id
    └ move_resultmove_result\[\]移动云空间文档至知识空间任务结果
      └ nodenode移动完成的节点信息
        └ space_idstring知识空间id 获取方式
        └ node_tokenstring节点token
        └ obj_tokenstring对应文档类型的token,可根据 obj_type 判断属于哪种文档类型。
        └ obj_typestring文档类型,对于快捷方式,该字段是对应的实体的obj_type。
可选值有
- doc: 旧版文档 - sheet: 表格 - mindnote: 思维导图 - bitable: 多维表格 - file: 文件 - docx: 新版文档 - slides: 幻灯片
        └ parent_node_tokenstring父节点 token。若当前节点为一级节点,父节点 token 为空。
        └ node_typestring节点类型
可选值有
- origin: 实体 - shortcut: 快捷方式
        └ origin_node_tokenstring快捷方式对应的实体node_token,当节点为快捷方式时,该值不为空。
        └ origin_space_idstring快捷方式对应的实体所在的space id
        └ has_childboolean是否有子节点
        └ titlestring文档标题
        └ obj_create_timestring文档创建时间
        └ obj_edit_timestring文档最近编辑时间
        └ node_create_timestring节点创建时间
        └ creatorstring节点创建者
        └ ownerstring节点所有者
        └ node_creatorstring节点创建者
      └ statusint节点移动状态码
      └ status_msgstring节点移动状态信息

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "task": {
            "task_id": "7037044037068177428-075c9481e6a0007c1df689dfbe5b55a08b6b06f7",
            "move_result": [
                {
                    "node": {
                        "space_id": "6946843325487912356",
                        "node_token": "wikcnKQ1k3p******8Vabcef",
                        "obj_token": "doccnzAaOD******Wabcdef",
                        "obj_type": "doc",
                        "parent_node_token": "wikcnKQ1k3p******8Vabcef",
                        "node_type": "origin",
                        "origin_node_token": "wikcnKQ1k3p******8Vabcef",
                        "origin_space_id": "6946843325487912356",
                        "has_child": false,
                        "title": "标题",
                        "obj_create_time": "1642402428",
                        "obj_edit_time": "1642402428",
                        "node_create_time": "1642402428",
                        "creator": "ou_xxxxx",
                        "owner": "ou_xxxxx",
                        "node_creator": "ou_xxxxx"
                    },
                    "status": 0,
                    "status_msg": "success"
                }
            ]
        }
    }
}

移动云空间文档至知识空间任务

  • 结果为什么是数组?

    未来计划支持多个节点批量迁入。因此结果由数组表示,表示批量迁入多个节点的结果。例如,迁入3个节点时,结果返回长度为3的数组,其中可能部分节点迁入成功,部分失败。当前仅支持单个节点迁入,结果返回长度为1。

状态说明

status取值status_msg取值描述
0success任务成功

错误码

HTTP状态码错误码描述排查建议
400131001rpc fail服务报错,请稍后重试,或者拿响应体的header头里的x-tt-logid咨询oncall定位。
400131002param err通常为传参有误,例如数据类型不匹配。请查看具体接口报错信息,报错不明确时请咨询oncall
400131004invalid user非法用户。请咨询oncall
400131005not found未找到相关数据,例如id不存在。相关报错信息参考: - member not found:用户不是知识空间成员(管理员),无法删除。 - identity not found: userid不存在,无法添加/删除成员。 - space not found:知识空间不存在 - node not found:节点不存在 - document not found:文档不存在 报错不明确时请咨询oncall
400131006permission 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. 若无法解决或报错信息不明确时:请咨询技术支持
400131007internal err服务内部错误,请勿重试,拿返回值的header头里的x-tt-logid咨询oncall定位。

内容来源:飞书开放平台 · 自动爬取整理