文档导出
复制页面
石墨文档中台(SDK)
<CO-1.2
>=CO-1.6
CO-1.5
CO-1.4
CO-1.2-1.3
<CO-1.2
一文认识石墨文档中台
文档中台支持的格式
10 分钟创建协同文档
10分钟创建预览文档
示例代码仓库
更新日志
典型场景案例
云盘场景
IM场景
接口文档
接口文档概览
错误码说明
石墨后端API
请求签名凭证
签名凭证类型
签名凭证-Signature
签名凭证-Token
系统管理
应用管理
获取应用详情
更新应用回调地址
用户席位管理
用户席位状态说明
获取用户列表和席位状态
激活用户席位
取消用户席位
批量设置用户席位
协同文档创建删除
访问协同文档
创建协同文档
创建协同文档副本
删除协同文档
预览文件
访问预览文件
创建文件预览缓存
文档导入导出
文档导入
文档导入说明
创建导入任务
获取导入进度
文档导出
文档导出流程
创建导出任务
POST
获取导出进度
POST
导出应用表格为Excel
POST
文档操作
专业表格(Excel)
专业表格接口参数说明
获取表格内容
获取表格中的评论数
更新表格内容
追加表格内容
删除表格行
新增表格工作表
轻文档(Markdown)
获取文档中的评论列表
通用
获取文件纯文本内容
文件纯文本字数统计
获取历史列表
获取版本列表
获取文档内容中所有的at人信息列表
传统文档(Word)
传统文档书签说明
读取传统文档书签内容
替换传统文档书签内容
石墨前端API
【前端】JS-API
编辑器API
表单
应用表格
表格
轻文档
幻灯片
传统文档
回调接口(接入方需实现)
【后端】回调接口说明
【后端】回调总览
文件信息
获取文件元信息-协同文档
获取文件元信息-预览文档
获取当前用户的文件列表
获取文件的协作者列表
获取接入方指定文件的完整访问地址
获取文件元信息-协同文档自动任务(admin)
根据指定用户获取文件元信息-协同文档(admin)
用户信息
批量获取用户信息(admin)
获取当前用户信息
获取当前用户所在团队信息
获取指定用户信息
获取用户水印信息
获取用户部门路径
批量获取用户信息
团队和部门
获取团队下的成员列表
获取部门信息
获取部门的下级部门节点
获取部门下的成员分页列表
搜索功能
获取与文件相关的用户列表
获取与文件相关的文件列表
按关键字搜索文件和用户列表
消息推送
评论(Comment)
轻文档
添加评论
删除评论
结束评论
对于评论的回复评论
表格
添加评论
删除评论
结束评论
对于评论的回复评论
传统文档
添加评论
更新评论
删除评论
对于评论的回复评论
幻灯片
添加评论
删除评论
结束评论
对于评论的回复评论
应用表格
添加评论
对于评论的回复评论
删除评论
讨论(Discussion)
轻文档
发送讨论消息
提及(MentionAt @ 人)
轻文档
在评论中 at
在讨论中 at
在正文中 at
表格
在评论中 at
在正文中 at
传统文档
在评论中 at
在正文中 at
应用表格
在评论中 at
在正文中 at
日期提醒 (DateMention)
轻文档
创建
修改
删除
表格
创建
修改
删除
传统文档
创建
修改
删除
文件内容更新 (FileContent)
文件内容更新
文档协作者协同状态变化 (Collaborator)
文档协 作者协同状态变化
版本 (Revision)
版本
系统事件 (System)
系统事件
(实验性) 回调请求错误
回调请求错误
常见问题
复制粘贴、全屏操作不正常
如何实现文档模板功能
文档内容何时保存
移动端不支持blob协议导致预览失败
如何实现文件重命名
访问接口提示 signature 无效怎么办
文件预览或导入报错如何处理
首次接入 SDK 报错 应该排查哪些接口
文档预览如何做防盗链
如何通过接口修改文档内容
文档导出
复制页面
文档导出流程
概述
#
文件导出采用异步处理模式,分为两个步骤:
接口1-创建导出任务:
导出文件
接口2-轮询查询导出进 度:
获取导出进度
特别注意
应用表格
:应用表格导出单独走
导出应用表格为Excel
详细流程
#
导出流程图
导出时序图
1
创建导出任务
1.
接入方调用
创建导出任务接口
,上传需要导出的文件
2.
系统接收文件后,创建异步导出任务
3.
接口立即返回唯一的
taskId
,用于后续查询进度
2
轮询查询进度
1.
接入方使用获得的
taskId
调用
查询导出进度接口
2.
系统返回当前任务的状态信息,包括:
status
:任务状态码(0表示正常,非0表示失败)
progress
:导出进度(0-100,100表示完成)
3
结果判断
根据接口返回的状态信息,进行以下判断:
情况1:导出成功
当
status == 0
且
progress == 100
时,表示文件导出成功
此时文件已完全导出系统,可以正常使用
情况2:导出进行中
当
status == 0
且
progress < 100
时,表示任务正在处理中
建议等待适当时间(如3-5秒)后重新调用查询接口
持续轮询直到任务完成或失败
情况3:导出失败
当
status != 0
时,表示任务执行失败
接入方需要处理错误,可根据错误码进行相应处理
如需重试,可重新发起导出任务
使用建议
1.
轮询间隔
:建议查询间隔不少于3秒,避免频繁请求
2.
超时处理
:建议设置合理的总超时时间,避免无限等待
3.
错误重试
:网络错误可重试查询,业务错误需要重新导出
4.
并发限制
:同一接入方建议控制并发导出任务数量
特别注意
文件ID
:导出、重新导出时必须使用不同的文件ID,石墨不支持对已存在的文件覆盖式导出
示例时序
#
修改于
2026-04-02 03:52:16
上一页
获取导入进度
下一页
创建导出任务