资源工坊

批量获取文件信息 ​

标签：文件

请求说明 ​

字段值
请求地址
https://openapi.wps.cn/v7/files/batch_get
HTTP 方法
GET
接口描述
根据file_id(s)批量获取文件信息
签名方式
KSO-1
限频策略
无
权限要求
查询和管理文件(应用授权) kso.file.readwrite
查询文件(应用授权) kso.file.read
查询和管理文件(用户授权) kso.file.readwrite
查询文件(用户授权) kso.file.read

查询参数 (Query) ​

属性名类型是否必填描述可选值
file_ids
array是文件ID列表-
with_permission
boolean否是否返回文件操作权限-
with_ext_attrs
boolean否是否返回文件扩展属性-
with_drive
boolean否是否返回文件所属drive信息-
mode
string否批量获取结果的返回模式。（默认）fastfail-快速失败，遇到错误时立即终止并返回；detailed-返回详情，遇到错误时继续执行，最终返回成功的文件集合和失败列表。fastfail, detailed

响应体(Response) ​

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例 ​

json
{
  "data": {
    "failures": [
      {
        "err_code": 0,
        "err_msg": "string",
        "object_id": "string"
      }
    ],
    "items": [
      {
        "created_by": {
          "avatar": "string",
          "company_id": "string",
          "id": "string",
          "name": "string",
          "type": "user"
        },
        "ctime": 0,
        "drive": {
          "allotee_id": "string",
          "allotee_type": "user",
          "company_id": "string",
          "created_by": {
            "avatar": "string",
            "company_id": "string",
            "id": "string",
            "name": "string",
            "type": "user"
          },
          "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": "inuse"
        },
        "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": "user"
        },
        "mtime": 0,
        "name": "string",
        "parent_id": "string",
        "permission": {
          "comment": true,
          "copy": true,
          "copy_content": true,
          "delete": true,
          "download": true,
          "history": true,
          "list": true,
          "move": true,
          "new_empty": true,
          "perm_ctl": true,
          "preview": true,
          "print": true,
          "rename": true,
          "saveas": true,
          "secret": true,
          "share": true,
          "update": true,
          "upload": true
        },
        "shared": true,
        "size": 0,
        "type": "folder",
        "version": 0
      }
    ]
  },
  "code": 0,
  "msg": "string"
}