本文档由
石墨办公
提供。
石墨文档中台-开发文档
co1.8.20260630
co1.8.20260830
co1.8.20260630
全部文档
前端接口
后端接口
回调接口
全部文档
前端接口
后端接口
回调接口
co1.8.20260630
co1.8.20260830
co1.8.20260630
石墨官网
预约演示
co1.8.20260630
co1.8.20260830
co1.8.20260630
文件导出
复制页面
整体概述
错误码说明
文件-预览 API
访问预览文件
GET
创建文件预览缓存
POST
文件-协同编辑文件管理 API
访问协同编辑文件
创建协同文件
POST
创建协同文件副本
POST
删除协同文件
DELETE
文件-导入导出 API
文件导入
文件导入说明
创建导入任务
获取导入进度
创建导入任务(旧版)
获取导入进度(旧版)
文件导出
文件导出流程
创建导出任务
POST
获取导出进度
POST
文件-文档文件(类 Markdown) API
获取文档中的评论列表
GET
文件-文稿文件(Word) API
文稿书签说明
读取文稿书签内容
GET
替换文稿书签内容
PUT
文件-表格文件(Excel) API
表格接口参数说明
获取表格内容
GET
获取表格中的评论数
GET
更新表格内容
POST
追加表格内容
PUT
删除表格行
DELETE
新增表格工作表
POST
文件-应用表格文件(多维表格)API
应用表格列及单元格值结构
应用表格接口调用规则
获取数据表列表
创建数据表
获取字段列表
创建字段
更新字段
删除字段
新增行
获取单行
更新行
删除行
获取行列表
文件-获取额外信息 API
获取文件的纯文本内容
文件纯文本字数统计
获取文件的历史列表
获取文件的版本列表
获取文件内容中所有的 @ 人信息列表
还原文件历史版本
系统管理 API
应用管理
获取应用详情
更新应用回调地址
用户席位管理
用户席位状态说明
获取用户列表和席位状态
激活用户席位
取消用户席位
批量设置用户席位
其他 API
上报事件
创建行为历史
推送文件内全部的用户
推送用户全部的 websocket 连接
文件导出
复制页面
文件导出流程
概述
#
文件导出采用异步处理模式,分为两个步骤:
接口1-创建导出任务:
导出文件
接口2-轮询查询导出进度:
获取导出进度
详细流程
#
导出流程图
导出时序图
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-06-22 02:43:30
上一页
获取导入进度(旧版)
下一页
创建导出任务