Skip to content

获取文件版本列表

适用版本>=v7.0.2311a.20231109

接口说明:获取文件历史版本列表

请求说明

请求地址配置域名+/graph+/v7/drives/{drive_id}/files/{file_id}/versions
请求方法GET
签名方式WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名)
权限要求更新文件(用户授权) kso.file.write

请求头(Header)

名称是否必填说明
Content-Type固定为: application/json
Wps-Docs-Date取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT
Wps-Docs-Authorization计算方法参考签名说明
Authorization授权凭证,格式为: Bearer {access_token}

路径参数(Path)

名称参数类型是否必填说明
drive_idstring驱动盘id,<= 1024 characters
file_idstring文件id,<= 1024 characters

查询参数(Query)

名称参数类型是否必填说明
page_sizeint分页大小,最大值:1024
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果
with_commentbool是否查询版本备注
with_ext_attrsbool是否查询版本扩展属性

响应体(Response)

名称类型说明
dataobject获取文件版本信息返回
itemsobject<= 1024 items
commentstring版本备注,<= 1024 characters
created_byobject创建者信息
avatarstring创建者头像,<= 1024 characters
company_idstring创建者企业id,<= 1024 characters
idstring创建者id,<= 1024 characters
namestring创建者名称,<= 1024 characters
typestring创建者身份类型,user:用户
ctimeint创建时间,时间戳,单位为秒
ext_attrsobject版本扩展属性
file_idstring文件id
hashobject哈希值
sumstring哈希结果
typestring哈希类型,固定为s2s
idintid
modified_byobject修改者信息
avatarstring修改者头像,<= 1024 characters
company_idstring修改者企业id,<= 1024 characters
idstring修改者id,<= 1024 characters
namestring修改者名称,<= 1024 characters
typestring修改者身份类型,user:用户
mtimestring修改时间,时间戳,单位为秒
sizeint64文件大小
versionint64文件版本
next_page_tokenstring下一页分页标记,<= 1024 characters;当查询结果中next_page_token为空或无该返回值时,代表无下一页
codeinteger错误码,参照《错误码说明》
msgstring状态信息
detailstring详细信息

响应体示例

{
  "data": {
    "items": [
      {
        "comment": "string",
        "created_by": {
          "avatar": "string",
          "company_id": "string",
          "id": "string",
          "name": "string",
          "type": "user"
        },
        "ctime": 0,
        "ext_attrs": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "file_id": "string",
        "hash": {
          "sum": "string",
          "type": "s2s"
        },
        "id": "string",
        "modified_by": {
          "avatar": "string",
          "company_id": "string",
          "id": "string",
          "name": "string",
          "type": "user"
        },
        "mtime": 0,
        "size": 0,
        "version": 0
      }
    ],
    "next_page_token": "string"
  },
  "code": 0,
  "detail": "string",
  "msg": "string"
}