开发工具

获取历史列表

GET/sdk/v2/collab-files/{fileId}/doc-sidebar-info

获取文件侧边栏历史列表信息，历史类型分为操作历史和编辑历史。

:::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

必需

示例值:

X-Shimo-Token

string

必需

示例值:

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

histories

array [object {7}]

必需

content

string

协作文件格式数据

必需

createdAt

string

必需

本条侧边栏历史创建时间

historyType

integer

必需

侧边栏历史类型，1 为操作历史，2 为编辑产生

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"
  }
}

最后修改时间： 9 个月前