Skip to content

获取子文件列表

适用版本>=v7.0.2308b.20230824

接口说明:获取子文件列表

请求说明

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

请求头(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
parent_idstring文件(夹)id(根目录时为0),<= 1024 characters

查询参数(Query)

名称参数类型是否必填说明
with_permissionbool是否返回文件操作权限
with_ext_attrsbool是否返回文件扩展属性
filter_extsstring过滤条件,扩展名以英文逗号分隔,不需要空格,扩展名全部小写,不传或者空字符串表示不过滤
orderstringEnum: “desc” “asc” 排序方式:升序和降序
order_bystring排序字段,Enum: "ctime" "mtime" "dtime" "fname" "fsize"
page_sizeint分页大小,最大值:1024
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果

响应体(Response)

名称类型说明
codeinteger错误码
detailstring详细信息
msgstring状态信息
dataobject获取子文件列表信息
itemsobject[]文件列表,<= 1024 items
idstring<= 1024 characters
drive_idstring驱动盘id,<= 1024 characters
parent_idstring父文件(夹)id,<= 1024 characters
created_byobject创建者信息
avatarstring创建者头像,<= 1024 characters
company_idstring创建者企业id,<= 1024 characters
idstring创建者id,<= 1024 characters
namestring创建者名称,<= 1024 characters
typestring创建者身份类型,user:用户
modified_byobject修改者信息
avatarstring修改者头像,<= 1024 characters
company_idstring修改者企业id,<= 1024 characters
idstring修改者id,<= 1024 characters
namestring修改者名称,<= 1024 characters
typestring修改者身份类型,user:用户
sizeint64文件大小
versionint文件版本
typestring文件类型
namestring文件名称,<= 1024 characters
ctimeint64文件创建时间,时间戳,单位为秒
mtimeint64文件修改时间,时间戳,单位为秒
hashobject文件哈希信息
sumstring哈希结果
typestring哈希类型,固定为s2s
ext_attrsobject[]文件扩展属性,<= 1024 items,若没有拓展属性,则不返回ext_attrs。
permissionobject文件权限
link_urlstring分享链接,<= 1024 characters
link_idstring分享链接id,<= 1024 characters
next_page_tokenstring下一页token;当查询结果中next_page_token为空或无该返回值时,代表无下一页

响应体示例

{
  "data": {
    "items": [
      {
        "created_by": {
          "avatar": "string",
          "company_id": "string",
          "id": "string",
          "name": "string",
          "type": "user"
        },
        "ctime": 0,
        "drive_id": "string",
        "ext_attrs": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "hash": {
          "sum": "string",
          "type": "s2s"
        },
        "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,
          "list": true,
          "move": true,
          "new_empty": true,
          "perm_ctl": true,
          "preview": true,
          "print": true,
          "rename": true,
          "share": true,
          "update": true,
          "upload": true
        },
        "size": 0,
        "type": "folder",
        "version": 0
      }
    ],
    "next_page_token": "string"
  },
  "code": 0,
  "detail": "string",
  "msg": "string"
}