1. 通用
石墨文档中台(SDK)
>=CO-1.6
  • >=CO-1.6
  • CO-1.5
  • CO-1.4
  • CO-1.2-1.3
  • <CO-1.2
  • 一文认识石墨文档中台
  • 文档中台支持的格式
  • 10 分钟创建协同文档
  • 10分钟创建预览文档
  • 示例代码仓库
  • 更新日志
  • 典型场景案例
    • 云盘场景
    • IM场景
  • 接口文档
    • 接口文档概览
    • 错误码说明
    • 石墨后端API
      • 请求签名凭证
        • 签名凭证类型
        • 签名凭证-Signature
        • 签名凭证-Token
      • 系统管理
        • 应用管理
          • 获取应用详情
          • 更新应用回调地址
        • 用户席位管理
          • 用户席位状态说明
          • 获取用户列表和席位状态
          • 激活用户席位​
          • 取消用户席位​
          • 批量设置用户席位
      • 协同文档创建删除
        • 访问协同文档
        • 创建协同文档
        • 创建协同文档副本
        • 删除协同文档
      • 预览文件
        • 访问预览文件
        • 创建文件预览缓存
      • 文档导入导出
        • 文档导入
          • 文档导入说明
          • 创建导入任务
          • 获取导入进度
          • 创建导入任务(旧版)
          • 获取导入进度(旧版)
        • 文档导出
          • 文档导出流程
          • 创建导出任务
          • 获取导出进度
      • 文档操作
        • 专业表格(Excel)
          • 专业表格接口参数说明
          • 获取表格内容
          • 获取表格中的评论数
          • 更新表格内容
          • 追加表格内容
          • 删除表格行
          • 新增表格工作表
        • 轻文档(Markdown)
          • 获取文档中的评论列表
        • 通用
          • 获取文件纯文本内容
            GET
          • 文件纯文本字数统计
            POST
          • 获取历史列表
            GET
          • 获取版本列表
            GET
          • 获取文档内容中所有的at人信息列表
            GET
        • 传统文档(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. 通用

获取历史列表

GET
/sdk/v2/collab-files/{fileId}/doc-sidebar-info
获取文件侧边栏历史列表信息,历史类型分为操作历史和编辑历史。

操作历史说明 (historyType = 1)#

表示手动操作而通常不造成文件内容等发生变化的记录,例如创建版本、锁定单元格等操作,此类历史的类型及上下文信息存于 content 字段中,格式为 JSON 字符串形式。
JSON 数据为 histories[i].content 字段,经过 JSON.parse()解析后的结果如下:
createRevision 创建版本#
{
  "action": "createRevision"
}
renameRevision 重命名版本#
{
  "action": "renameRevision",
  "before": "修改前的版本名称",
  "after": "修改后的版本名称"
}
deleteRevision 删除版本#
{
  "action": "deleteRevision",
  "label": "被删除的版本名称"
}
lock_cell 锁定单元格#
{
  "action": "lock_cell",
  "range": "E14:E14",
  "name": "工作表1"
}
unlock_cell 解锁单元格#
{
  "action": "unlock_cell",
  "range": ["E14:E14"],
  "name": "工作表1"
}
lock_sheet 锁定工作表#
{
  "action": "lock_sheet",
  "name": "工作表1"
}
unlock_sheet 解锁工作表#
{
  "action": "unlock_sheet",
  "name": "工作表1"
}
update_lock_cell 更新单元格锁定#
{
  "action": "update_lock_cell",
  "range": ["E17:E17"],
  "name": "工作表1"
}

编辑历史说明 (historyType = 2)#

表示一个或多个用户在一段时间内对文件内容进行了编辑。

请求参数

Path 参数

Query 参数

Header 参数

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/sdk/v2/collab-files//doc-sidebar-info?pageSize&count&historyType' \
--header 'X-Shimo-Signature: {{signature}}' \
--header 'X-Shimo-Token: {{token}}'

返回响应

🟢200成功
application/json
Body

示例
{
    "histories": [
        {
            "content": "{\"range\":[1,1],\"changeset\":\"[[10, \\\"\\\\n\\\", \\\"line:\\\\\\\"init\\\\\\\"\\\"]]\",\"frozen\":true}",
            "createdAt": "2021-06-07T06:12:24Z",
            "historyType": 2,
            "id": "60bdb8c847a7850006bf12c1",
            "name": "",
            "updatedAt": "2021-06-07T06:12:24Z",
            "userId": "user123,user134"
        },
        {
            "content": "{\"range\":[2,3],\"changeset\":\"省略若干内容 ...\"}",
            "createdAt": "2021-06-07T06:12:39Z",
            "historyType": 2,
            "id": "60bdb8d747a7850006bf12c2",
            "name": "",
            "updatedAt": "2021-06-07T06:12:39Z",
            "userId": "user123,user134"
        },
        {
            "content": "{\"action\":\"unlock_cell\",\"range\":[\"E14:E14\"],\"name\":\"工作表1\"}",
            "createdAt": "2022-03-11T03:58:59Z",
            "historyType": 1,
            "id": "622ac9034079aa0006d54f3b",
            "name": "",
            "updatedAt": "2022-03-11T03:58:59Z",
            "userId": "user123"
        },
        {
            "content": "{\"action\":\"lock_sheet\",\"name\":\"工作表1\"}",
            "createdAt": "2022-03-11T03:59:04Z",
            "historyType": 1,
            "id": "622ac9084079aa0006d54f3c",
            "name": "",
            "updatedAt": "2022-03-11T03:59:04Z",
            "userId": "user123"
        }
    ],
    "isLastPage": true,
    "limit": null,
    "users": {
        "user123": "testuser",
        "user134": "testuser2"
    }
}
修改于 2026-04-21 09:23:36
上一页
文件纯文本字数统计
下一页
获取版本列表
Built with