获取文件目录详情

最近更新时间:2022-03-21 12:30:05

我的收藏

功能描述

获取文件目录详情。

请求

请求示例

GET /user/v1/directory/{OrganizationId}/{SpaceId}/{DirPath | FilePath}?info&user_token={UserToken}`
请求参数:
OrganizationId:组织 ID,必选参数。
SpaceId:空间 ID。
DirPath:文件夹目录。
FilePath:文件目录。

请求体

该请求无请求体。

响应

响应码

获取成功,返回 HTTP 200 OK。

响应体

application/json
响应体示例:
{
"organizationName": "testOrg",
"name": "初始化视频2.video",
"type": "video",
"creationPerson": "张三",
"size": "3178496",
"historySize": "7348726348",
"creationTime": "2021-03-09T07:14:38.000Z",
"modificationTime": "2021-07-15T12:48:07.000Z",
"path": [
"初始化文件夹2"
],
"previewByDoc": false,
"previewByCI": true,
"previewAsIcon": false,
"fileType": "image",
"spaceTag": "team",
"team": {
"id": 1,
"name": "TeamB_sub",
"path": [
"testOrg",
"TeamB",
"TeamB_sub"
]
},

"localSync": {
"syncId": 2,
"folderSyncType": "local_to_cloud",
"isSyncRootFolder": true,
"syncUserId": "11",
"user": {
"id": 11,
"name": "xxx"
}
}
}
响应体字段说明:
name:字符串,文件名称。
type:字符串,文件类型。
creationPerson:创建人昵称。
size:字符串,文件大小。
historySize:字符串,历史版本文件大小。
creationTime:日期字符串,创建时间。
modificationTime:日期字符串,修改时间。
path:字符串数组,文件路径。
previewByDoc:布尔值,是否可通过 wps 预览。
previewByCI:布尔值,是否可通过万象预览。
previewAsIcon:布尔值,是否可用预览图做 icon。
fileType:字符串,文件类型:excel、powerpoint 等。
spaceTag:字符串,personal | team
team:如果是团队空间,则列出团队信息。
id:整数,团队 ID。
name:字符串,团队名称。
path:字符串数组,团队的层级目录,假设团层级为 T1/T2/T3,则 T3 的 path 为 ['T1','T2','T3'],仅当 WithPath = true 时返回。
user:如果是用户个人空间,则列出用户信息。
id:整数,用户 ID。
name:字符串,用户昵称。
localSync:如果是同步盘 or 同步盘的子文件目录,返回该字段。
isSyncRootFolder:当前文件夹是否为同步盘,如果是同步盘根目录返回 true,如果是同步盘子级节点,返回 false,如果不是同步盘,不返回该字段。
folderSyncType:当该文件夹为同步盘时,返回同步方式,local_to_cloud,非必返。
syncId:当该文件夹为同步盘时,返回同步任务 ID。
syncUserId:当该文件夹为同步盘时,返回设置同步任务的 userId。
user:设置同步任务的用户信息。
syncId:当该文件夹为同步盘时,返回同步任务 ID。
syncUserId:当该文件夹为同步盘时,返回设置同步任务的 userId。