开发文档
能力中心
应用市场
WebOffice
开发者后台

批量获取文件信息 ​

根据 file_id(s) 批量获取文件信息

请求说明 ​

请求地址https://openapi.wps.cn/v7/files/batch_get
请求方法GET
签名方式KSO-1
权限要求查询和管理文件（应用授权） kso.file.readwrite
查询文件（应用授权） kso.file.read
查询和管理文件（用户授权） kso.file.readwrite
查询文件（用户授权） kso.file.read

请求头（Header） ​

Header 名称参数类型是否必填说明
Content-Typestring是使用：application/json
X-Kso-Datestring是RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-Authorizationstring是KSO-1 签名值，详见《签名方法》
Authorizationstring是授权凭证，格式为：Bearer {access_token}

查询参数（Query） ​

名称参数类型是否必填说明
file_idsarray[string]是文件 id 列表
modestring[enum]否批量获取结果的返回模式
fastfail：快速失败，遇到错误时立即终止并返回（默认）
detailed：返回详情，遇到错误时继续执行，最终返回成功的文件集合和失败列表
with_driveboolean否是否返回文件所属 drive 信息
with_ext_attrsboolean否是否返回文件扩展属性
with_permissionboolean否是否返回文件操作权限

请求地址示例 ​

[GET] https://openapi.wps.cn/v7/files/batch_get?file_ids={string_1}&file_ids={string_2}&mode={string}&with_drive={boolean}&with_ext_attrs={boolean}&with_permission={boolean}

响应体 ​

名称参数类型说明
codeinteger响应代码。非 0 表示失败，参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ failuresarray[object]失败列表，当 mode=detailed 时返回
∟ ∟ err_codeinteger错误码
∟ ∟ err_msgstring错误信息
∟ ∟ object_idstring文件 id
∟ itemsarray[object]文件集合
∟ ∟ created_byobject创建者
∟ ∟ ∟ avatarstring创建者头像
∟ ∟ ∟ company_idstring创建者企业 id
∟ ∟ ∟ idstring创建者 id
∟ ∟ ∟ namestring创建者名称
∟ ∟ ∟ typestring[enum]身份类型
user：用户；sp：服务主体
∟ ∟ ctimeinteger创建时间
∟ ∟ driveobject文件所属 drive 信息
∟ ∟ ∟ allotee_idstring盘归属身份 id
∟ ∟ ∟ allotee_typestring[enum]盘归属身份类型
user：用户；group：用户组；app：应用
∟ ∟ ∟ company_idstring企业 id
∟ ∟ ∟ created_byobject创建者
∟ ∟ ∟ ∟ avatarstring创建者头像
∟ ∟ ∟ ∟ company_idstring创建者企业 id
∟ ∟ ∟ ∟ idstring创建者 id
∟ ∟ ∟ ∟ namestring创建者名称
∟ ∟ ∟ ∟ typestring[enum]身份类型
user：用户；sp：服务主体
∟ ∟ ∟ ctimeinteger创建时间
∟ ∟ ∟ descriptionstring盘描述
∟ ∟ ∟ ext_attrsarray[object]盘扩展属性
∟ ∟ ∟ ∟ namestring属性名
∟ ∟ ∟ ∟ valuestring属性值
∟ ∟ ∟ idstring驱动盘 id
∟ ∟ ∟ mtimeinteger修改时间
∟ ∟ ∟ namestring驱动盘名称
∟ ∟ ∟ quotaobject盘容量
∟ ∟ ∟ ∟ deletedinteger回收站中的文件占用的总空间，以字节为单位。只读
∟ ∟ ∟ ∟ remaininginteger剩余的总空间，以字节为单位。只读
∟ ∟ ∟ ∟ totalinteger允许的总存储空间，以字节为单位。只读
∟ ∟ ∟ ∟ usedinteger已使用的总空间，以字节为单位。只读
∟ ∟ ∟ sourcestring盘来源
∟ ∟ ∟ statusstring[enum]盘状态
inuse：使用中；deleted：已删除
∟ ∟ drive_idstring盘 id
∟ ∟ ext_attrsarray[object]文件扩展属性
∟ ∟ ∟ namestring属性名
∟ ∟ ∟ valuestring属性值
∟ ∟ idstringid
∟ ∟ link_idstring分享 id
∟ ∟ link_urlstring分享链接 url
∟ ∟ modified_byobject修改者
∟ ∟ ∟ avatarstring修改者头像
∟ ∟ ∟ company_idstring修改者企业 id
∟ ∟ ∟ idstring修改者 id
∟ ∟ ∟ namestring修改者名称
∟ ∟ ∟ typestring[enum]身份类型
user：用户；sp：服务主体
∟ ∟ mtimeinteger修改时间
∟ ∟ namestring名称
∟ ∟ parent_idstring父路径 id
∟ ∟ permissionobject文件权限
∟ ∟ ∟ commentboolean评论
∟ ∟ ∟ copyboolean复制
∟ ∟ ∟ copy_contentboolean内容复制
∟ ∟ ∟ deleteboolean文件删除
∟ ∟ ∟ downloadboolean下载
∟ ∟ ∟ historyboolean历史版本，仅公网支持
∟ ∟ ∟ moveboolean文件移动
∟ ∟ ∟ new_emptyboolean新建
∟ ∟ ∟ perm_ctlboolean权限管理
∟ ∟ ∟ printboolean打印
∟ ∟ ∟ renameboolean文件重命名
∟ ∟ ∟ saveasboolean另存为，仅公网支持
∟ ∟ ∟ secretboolean安全文档，仅公网支持
∟ ∟ ∟ shareboolean分享
∟ ∟ ∟ updateboolean编辑 / 更新
∟ ∟ ∟ uploadboolean上传：手动上传新版本
∟ ∟ sharedboolean是否开启分享
当 link.status=open 时，shared 为 true，其他结果为 false。
若调用方想提前知道文档是否分享但又不想额外调用分享信息，可使用此字段
∟ ∟ sizeinteger大小
∟ ∟ typestring文件类型
folder：文件夹；file：文件；shortcut：快捷方式
∟ ∟ versioninteger版本
moreobject更多的错误信息

响应体示例 ​

json
{
  "code": 0,
  "data": {
    "failures": [
      {
        "err_code": 0,
        "err_msg": "string",
        "object_id": "string"
      }
    ],
    "items": [
      {
        "created_by": {
          "avatar": "string",
          "company_id": "string",
          "id": "string",
          "name": "string",
          "type": "string[enum]"
        },
        "ctime": 0,
        "drive": {
          "allotee_id": "string",
          "allotee_type": "string[enum]",
          "company_id": "string",
          "created_by": {
            "avatar": "string",
            "company_id": "string",
            "id": "string",
            "name": "string",
            "type": "string[enum]"
          },
          "ctime": 0,
          "description": "string",
          "ext_attrs": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "id": "string",
          "mtime": 0,
          "name": "string",
          "quota": {
            "deleted": 0,
            "remaining": 0,
            "total": 0,
            "used": 0
          },
          "source": "string",
          "status": "string[enum]"
        },
        "drive_id": "string",
        "ext_attrs": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "id": "string",
        "link_id": "string",
        "link_url": "string",
        "modified_by": {
          "avatar": "string",
          "company_id": "string",
          "id": "string",
          "name": "string",
          "type": "string[enum]"
        },
        "mtime": 0,
        "name": "string",
        "parent_id": "string",
        "permission": {
          "comment": false,
          "copy": false,
          "copy_content": false,
          "delete": false,
          "download": false,
          "history": false,
          "move": false,
          "new_empty": false,
          "perm_ctl": false,
          "print": false,
          "rename": false,
          "saveas": false,
          "secret": false,
          "share": false,
          "update": false,
          "upload": false
        },
        "shared": false,
        "size": 0,
        "type": "string",
        "version": 0
      }
    ]
  },
  "msg": "string"
}
回到旧版