开发工具
  1. 通用
开发工具
  • 文档专区
    • 10 分钟创建协同文档
    • 签名续期说明
    • 签名方式
    • 用户席位说明
  • 石墨API 接口
    • App 管理
      • 获取 App 详情
      • 更新 App 回调地址
      • 获取用户列表和席位状态
      • 激活用户席位​
      • 取消用户席位​
      • 批量设置用户席位
    • 文档创建删除
      • 创建协同文档
      • 创建协同文档副本
      • 删除协同文档
      • 访问预览文档
      • 创建预览文档
    • 文档导入导出
      • 导入文件
      • 获取导入进度
      • 导出文件
      • 获取导出进度
      • 导出应用表格为Excel
    • 文档操作
      • 通用
        • 获取文件纯文本内容
          GET
        • 文件纯文本字数统计
          POST
        • 获取历史列表
          GET
        • 获取版本列表
          GET
        • 获取文档内容中所有的at人信息列表
          GET
      • 表格(Excel)
        • 获取表格内容
        • 获取文档中的评论数
        • 更新表格内容
        • 追加表格内容
        • 删除表格行
        • 新增表格工作表
      • 传统文档(Word)
        • 读取传统文档书签内容
        • 替换传统文档书签内容
  • 接入方实现接口(回调接口)
    • 文件信息
      • 获取文件元信息-协同文档
      • 获取文件元信息-预览文档
      • 获取当前用户的文件列表
      • 获取文件的协作者列表
      • 获取接入方指定文件的完整访问地址
      • 获取文件元信息-协同文档自动任务
      • 根据指定用户获取文件元信息-协同文档
    • 用户信息
      • 获取当前用户信息
      • 获取当前用户所在团队信息
      • 获取指定用户信息
      • 获取用户水印信息
      • 获取用户部门路径
      • 批量获取用户信息
    • 团队和部门
      • 获取团队下的成员列表
      • 获取部门信息
      • 获取部门的下级部门节点
      • 获取部门下的成员分页列表
    • 搜索功能
      • 获取与文件相关的用户列表
      • 获取与文件相关的文件列表
      • 按关键字搜索文件和用户列表
    • 消息推送
      • 评论
        • 轻文档
          • 添加评论
          • 删除评论
          • 结束评论
        • 表格
          • 添加评论
          • 删除评论
          • 结束评论
        • 传统文档
          • 添加评论
          • 删除评论
          • 更新评论
        • 幻灯片
          • 添加评论
          • 删除评论
          • 结束评论
        • 应用表格
          • 添加评论
          • 对于评论的回复评论
          • 删除评论
      • 讨论(Discussion)
        • 轻文档
          • 发送讨论消息
      • 提及(MentionAt @ 人)
        • 轻文档
          • 在评论中 at
          • 在讨论中 at
          • 在正文中 at
        • 表格
          • 在评论中 at
          • 在正文中 at
        • 传统文档
          • 在评论中 at
          • 在正文中 at
        • 应用表格
          • 在评论中 at
          • 在正文中 at
      • 日期提醒 (DateMention)
        • 轻文档
          • 创建
          • 修改
          • 删除
        • 表格
          • 创建
          • 修改
          • 删除
        • 传统文档
          • 创建
          • 修改
          • 删除
      • 文件内容更新 (FileContent)
        • 文件内容更新
      • 文档协作者协同状态变化 (Collaborator)
        • 文档协作者协同状态变化
      • 版本 (Revision)
        • 版本
      • 系统事件 (System)
        • 系统事件
      • (实验性) 回调请求错误
        • 回调请求错误
  1. 通用

获取历史列表

GET
/sdk/v2/collab-files/{fileId}/doc-sidebar-info
获取文件侧边栏历史列表信息,历史类型分为操作历史和编辑历史。
提示
path 中的 shimo-files 改为 collab-files,原 shimo-files 仍可用

操作历史说明 (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 参数
fileId
string 
接入方文件 id
必需
Query 参数
pageSize
integer 
可选
每一页返回的条数,推荐值 10、20 ,设的过大将会影响响应时间。默认值为 10
count
integer 
可选
当前页需要跳过的记录数,可通过 count = (page - 1) * pageSize 求得。默认值为 0
historyType
integer 
可选
1 操作历史 (如锁定单元格此类未实际编写内容的修改产生的操作历史),2 编辑历史。未传时,默认返回所有类型
Header 参数
X-Shimo-Signature
string 
必需
示例值:
{{signature}}
X-Shimo-Token
string 
必需
示例值:
{{token}}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://office.shimoapi.com/sdk/v2/collab-files//doc-sidebar-info?pageSize&count&historyType' \
--header 'X-Shimo-Signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZkZWEwODk5NTYwMzRkMzliOWZjYmZmOTg1M2NhYWZiIn0.eyJleHAiOjE3NDAwMTk1MDF9.wBfjvKigaNDeRldcKlJLr6FFHRGw50q7RYfuYb7Jy5U' \
--header 'X-Shimo-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZkZWEwODk5NTYwMzRkMzliOWZjYmZmOTg1M2NhYWZiIn0.eyJ1c2VySWQiOjQ5LCJtb2RlIjoic2hpbW8iLCJleHAiOjE3NDAwMTk1MDF9.Ta124wvF-lbpge6Ytah-7LyasBfu0SnZgDyu3GuwXDM'

返回响应

🟢200成功
application/json
Body
histories
array [object {7}] 
必需
content
string 
协作文件格式数据
必需
createdAt
string 
必需
本条侧边栏历史创建时间
historyType
integer 
必需
侧边栏历史类型,1 为操作历史,2 为编辑产生
id
string 
侧边栏历史 ID
必需
name
string 
侧边栏历史名称
必需
updatedAt
string 
必需
侧边栏历史最后更新时间
userId
string 
必需
服务商用户 ID,可能有多个,以英文逗号 "," 分隔
isLastPage
boolean 
是否最后一页
必需
limit
null 
分页大小
必需
users
object 
必需
接入方用户 ID 对应的用户名映射
示例
{
  "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"
  }
}
上一页
文件纯文本字数统计
下一页
获取版本列表
Built with