1. 文件-获取额外信息 API
石墨文档中台-开发文档
  • 1. 适用范围
  • 00. 概述
    • 石墨文档中台能做什么?
    • 三种典型的业务接入场景
    • 石墨文档中台支持哪些格式?
  • 01. 快速开始
    • 基本概念
    • 场景一:10 分钟创建预览文件
    • 场景二:10 分钟创建协同编辑文件
  • 02. 鉴权与安全
    • 整体概述
    • 签名凭证 Token
    • 签名凭证 Signature
  • 03. 文件预览
    • 整体概述
    • 如何预热预览缓存
    • 如何防盗链
    • 常见问题处理
  • 04. 文件编辑
    • 整体概述
    • 协同文档权限设计
    • 协同文件保存与更新机制
    • 协同文件复制与删除
  • 05. 文件导入导出
    • 整体概述
    • 常见问题处理
  • 06. 石墨前端 API
    • 整体概述
    • 公共 API
      • 公共处理方法
      • 顶部栏定制 HeaderBars
    • 编辑器 API
      • 轻文档
      • 传统文档
      • 表格
      • 幻灯片
      • 表单
      • 应用表格
  • 07. 石墨后端 API
    • 整体概述
    • 错误码说明
    • 文件-预览 API
      • 访问预览文件
      • 创建文件预览缓存
    • 文件-协同编辑文件管理 API
      • 访问协同编辑文件
      • 创建协同文件
      • 创建协同文件副本
      • 删除协同文件
    • 文件-导入导出 API
      • 文件导入
        • 文件导入说明
        • 创建导入任务
        • 获取导入进度
        • 创建导入任务(旧版)
        • 获取导入进度(旧版)
      • 文件导出
        • 文件导出流程
        • 创建导出任务
        • 获取导出进度
    • 文件-表格文件(Excel) API
      • 表格接口参数说明
      • 获取表格内容
      • 获取表格中的评论数
      • 更新表格内容
      • 追加表格内容
      • 删除表格行
      • 新增表格工作表
    • 文件-文稿文件(Word) API
      • 文稿书签说明
      • 读取文稿书签内容
      • 替换文稿书签内容
    • 文件-文档文件(类 Markdown) API
      • 获取文档中的评论列表
    • 文件-应用表格文件(多维表格)API
      • 应用表格列及单元格值结构
      • 应用表格接口调用规则
      • 获取数据表列表
      • 创建数据表
      • 获取字段列表
      • 创建字段
      • 更新字段
      • 删除字段
      • 新增行
      • 获取单行
      • 更新行
      • 删除行
    • 文件-获取额外信息 API
      • 获取文件的纯文本内容
        GET
      • 文件纯文本字数统计
        POST
      • 获取文件的历史列表
        GET
      • 获取文件的版本列表
        GET
      • 获取文件内容中所有的 @ 人信息列表
        GET
      • 还原文件历史版本
        POST
    • 系统管理 API
      • 应用管理
        • 获取应用详情
        • 更新应用回调地址
      • 用户席位管理
        • 用户席位状态说明
        • 获取用户列表和席位状态
        • 激活用户席位​
        • 取消用户席位​
        • 批量设置用户席位
    • 其他 API
      • 上报事件
      • 创建行为历史
      • 推送文件内全部的用户
      • 推送用户全部的 websocket 连接
    • 获取行列表
      GET
  • 08. 回调接口(你的应用需实现的接口)
    • 整体概述
    • 文件信息
      • 文件权限说明
      • [重要] 获取文件元信息-协同文档
      • [重要] 获取文件元信息-预览文档
      • 获取当前用户的文件列表
      • 获取文件的协作者列表
      • 获取接入方指定文件的完整访问地址
      • 获取文件元信息-协同文档自动任务(admin)
      • 根据指定用户获取文件元信息-协同文档(admin)
    • 用户信息
      • 批量获取用户信息(admin)
      • [重要] 获取当前用户信息
      • 获取当前用户所在团队信息
      • 获取指定用户信息
      • 获取用户水印信息
      • 获取用户部门路径
      • 批量获取用户信息
    • 团队和部门
      • 特殊部门 ID 说明
      • 获取团队下的成员列表
      • 获取部门信息
      • 获取部门的下级部门节点
      • 获取部门下的成员分页列表
    • 搜索功能
      • 获取与文件相关的用户列表
      • 获取与文件相关的文件列表
      • 按关键字搜索文件和用户列表
    • 事件推送
      • 整体概述
      • 评论(Comment)
        • 轻文档
          • 添加评论
          • 删除评论
          • 结束评论
          • 对于评论的回复评论
        • 表格
          • 添加评论
          • 删除评论
          • 结束评论
          • 对于评论的回复评论
        • 传统文档
          • 对于评论的回复评论
          • 添加评论
          • 更新评论
          • 删除评论
        • 幻灯片
          • 添加评论
          • 删除评论
          • 结束评论
          • 对于评论的回复评论
        • 应用表格
          • 添加评论
          • 对于评论的回复评论
          • 删除评论
      • 讨论(Discussion)
        • 轻文档
          • 发送讨论消息
      • 提及(MentionAt @ 人)
        • 轻文档
          • 在评论中 at
          • 在讨论中 at
          • 在正文中 at
        • 表格
          • 在评论中 at
          • 在正文中 at
        • 传统文档
          • 在评论中 at
          • 在正文中 at
        • 应用表格
          • 在评论中 at
          • 在正文中 at
      • 日期提醒 (DateMention)
        • 轻文档
          • 创建
          • 修改
          • 删除
        • 表格
          • 创建
          • 修改
          • 删除
        • 传统文档
          • 创建
          • 修改
          • 删除
      • 文件内容更新 (FileContent)
        • 文件内容更新
      • 文档协作者协同状态变化 (Collaborator)
        • 文档协作者协同状态变化
      • 文件版本 (Revision)
        • 版本
      • 系统事件 (System)
        • 系统事件
      • 回调请求错误(实验性)
        • 回调请求错误
  • 09. 核心模型
    • 你的应用如何设计应用(app)模型?
    • 你的应用如何设计文件数据模型?
    • 你的应用如何设计通讯录模型?
    • 你的应用系统如何设计文件权限模型?
  • 10. 典型场景方案
    • 云盘场景
    • IM 场景
    • 示例代码仓库
  • 11. 常见问题
    • 访问接口提示 Signature
    • 文件预览或导入报错
    • 首次接入 SDK 报错
    • 文档预览如何做防盗链
    • 复制粘贴、全屏操作不正常
    • 如何实现文档模板功能
    • 文档内容何时保存
    • 移动端不支持 blob 协议导致预览失败
    • 如何实现文件重命名
    • 如何通过接口修改文档内容
    • @人员时如何直接跳转至对应锚点
  1. 文件-获取额外信息 API

获取文件的历史列表

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 '/sdk/v2/collab-files//doc-sidebar-info?pageSize=undefined&count=undefined&historyType=undefined' \
--header 'X-Shimo-Signature: {{signature}}' \
--header 'X-Shimo-Token: {{token}}'

返回响应

🟢200成功
application/json
Bodyapplication/json

示例
{
    "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-06-22 02:43:30
上一页
文件纯文本字数统计
下一页
获取文件的版本列表
Built with