获取子文件列表
适用版本>=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_id | string | 是 | 驱动盘id,<= 1024 characters |
| parent_id | string | 是 | 文件(夹)id(根目录时为0),<= 1024 characters |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| with_permission | bool | 否 | 是否返回文件操作权限 |
| with_ext_attrs | bool | 否 | 是否返回文件扩展属性 |
| filter_exts | string | 否 | 过滤条件,扩展名以英文逗号分隔,不需要空格,扩展名全部小写,不传或者空字符串表示不过滤 |
| order | string | 否 | Enum: “desc” “asc” 排序方式:升序和降序 |
| order_by | string | 否 | 排序字段,Enum: "ctime" "mtime" "dtime" "fname" "fsize" |
| page_size | int | 是 | 分页大小,最大值:1024 |
| page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果 |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | 错误码 |
| detail | string | 详细信息 |
| msg | string | 状态信息 |
| data | object | 获取子文件列表信息 |
| ∟ items | object[] | 文件列表,<= 1024 items |
| ∟ ∟ id | string | <= 1024 characters |
| ∟ ∟ drive_id | string | 驱动盘id,<= 1024 characters |
| ∟ ∟ parent_id | string | 父文件(夹)id,<= 1024 characters |
| ∟ ∟ created_by | object | 创建者信息 |
| ∟ ∟ ∟ avatar | string | 创建者头像,<= 1024 characters |
| ∟ ∟ ∟ company_id | string | 创建者企业id,<= 1024 characters |
| ∟ ∟ ∟ id | string | 创建者id,<= 1024 characters |
| ∟ ∟ ∟ name | string | 创建者名称,<= 1024 characters |
| ∟ ∟ ∟ type | string | 创建者身份类型,user:用户 |
| ∟ ∟ modified_by | object | 修改者信息 |
| ∟ ∟ ∟ avatar | string | 修改者头像,<= 1024 characters |
| ∟ ∟ ∟ company_id | string | 修改者企业id,<= 1024 characters |
| ∟ ∟ ∟ id | string | 修改者id,<= 1024 characters |
| ∟ ∟ ∟ name | string | 修改者名称,<= 1024 characters |
| ∟ ∟ ∟ type | string | 修改者身份类型,user:用户 |
| ∟ ∟ size | int64 | 文件大小 |
| ∟ ∟ version | int | 文件版本 |
| ∟ ∟ type | string | 文件类型 |
| ∟ ∟ name | string | 文件名称,<= 1024 characters |
| ∟ ∟ ctime | int64 | 文件创建时间,时间戳,单位为秒 |
| ∟ ∟ mtime | int64 | 文件修改时间,时间戳,单位为秒 |
| ∟ ∟ hash | object | 文件哈希信息 |
| ∟ ∟ ∟ sum | string | 哈希结果 |
| ∟ ∟ ∟ type | string | 哈希类型,固定为s2s |
| ∟ ∟ ext_attrs | object[] | 文件扩展属性,<= 1024 items,若没有拓展属性,则不返回ext_attrs。 |
| ∟ ∟ permission | object | 文件权限 |
| ∟ ∟ link_url | string | 分享链接,<= 1024 characters |
| ∟ ∟ link_id | string | 分享链接id,<= 1024 characters |
| ∟ next_page_token | string | 下一页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"
}