功能描述
用于查看文件详情。
说明:
此接口可同时用于查看文件或文件夹详情,路径如果为文件,则返回文件详情,如果为文件夹,则返回文件夹详情
请求
请求示例
GET /api/v1/directory/`{LibraryId}`/`{SpaceId}`/`{FilePath}`?info&access_token=`{AccessToken}`&with_inode=`{WithInode}`&with_favorite_status=`{WithFavoriteStatus}`
请求参数
请求参数 | 描述 | 类型 | 是否必选 |
LibraryId | String | 是 | |
SpaceId | String | 否 | |
FilePath | 完整文件路径,例如 foo/bar2/file.docx | String | 否 |
WithInode | 0 或 1,是否返回 inode,即文件目录 ID,默认不返回 | String | 否 |
AccessToken | String | 否 | |
WithFavoriteStatus | 0 或 1,是否返回收藏状态,默认不返回 | String | 否 |
请求体
空
响应码
获取成功,返回 HTTP 200 OK。
响应体
application/json
响应体示例:
{"path": [ "root", "folder" ],"inode": "xxxx","name": "folder","type": "dir","userId": "123","userOrgId":"","creationTime": "2020-09-22T07:44:45.000Z","modificationTime": "2020-09-22T07:44:45.000Z","versionId": 23,"size": "1048576","eTag": "xxx","isFavorite": true,"crc64": "xxx","contentType": "image/jpg","metaData": {"x-smh-meta-foo": "bar"},"fileType": "powerpoint","previewByDoc": true,"previewByCI": true,"previewAsIcon": true,"labels": ["动物", "大象", "亚洲象"],"category": "zip","localCreationTime": "2022-07-26T02:58:09.000Z","localModificationTime": "2022-07-26T02:58:09.000Z","linkTo": "968fcbb5013759a40006375657764f4e"}
响应体字段说明:
响应参数 | 描述 | 类型 |
path | 完整路径 | String Array |
inode | 文件目录ID | String |
name | 目录或相簿名或文件名 | String |
type | 条目类型: dir: 目录或相簿;file: 文件,仅用于文件类型媒体库;image: 图片,仅用于媒体类型媒体库;video: 视频,仅用于媒体类型媒体库;symlink: 符号链接 | String |
userId | 创建人 ID | String |
userOrgId | 原创建人ID | String |
creationTime | ISO 8601格式的日期与时间字符串,表示文件的创建时间或文件的上传时间,例如 2020-10-14T10:17:57.953Z | String |
modificationTime | 文件最近一次被覆盖的时间,或者目录内最近一次增删子目录或文件的时间 | String |
versionId | 版本号,可能为 null | String |
size | 文件大小,为了避免数字精度问题,这里为字符串格式 | String |
eTag | 文件 eTag | String |
isFavorite | 是否被收藏,当 WithFavoriteStatus = 1 时返回 | Boolean |
crc64 | 文件的 CRC64-ECMA182 校验值,为了避免数字精度问题,这里为字符串格式 | String |
contentType | 媒体类型 | String |
metaData | 文件元数据信息 | String |
fileType | 文件类型:Excel、PowerPoint 等 | String |
previewByDoc | 是否可通过 WPS 预览 | Boolean |
previewByCI | 是否可通过万象预览 | Boolean |
previewAsIcon | 是否可用预览图作为 icon | Boolean |
labels | 简易文件标签列表,跟tagList不同,它是通过上传、修改文件时指定的 | String Array |
category | 文件自定义的分类 | String |
localCreationTime | 文件对应的本地创建时间 | String |
localModificationTime | 文件对应的本地修改时间 | String |
linkTo | 符号链接文件指向的文件 inode | String |
错误码