功能描述
查看收藏文件列表。
请求
请求示例
GET /user/v1/favorite/
{OrganizationId}
?favorite_group_id={FavoriteGroupId}
&page={Page}
&page_size={PageSize}
&order_by=${ORderBy}
&order_by_type=OrderByType
&user_token={UserToken}
请求参数:
OrganizationId:组织 ID,必选参数。
FavoriteGroupId:收藏夹 ID,可选参数。
Page:分页码,默认第一页,可选参数。
PageSize:分页大小,默认 20,可选参数。
UserToken:用户访问令牌,必选参数。
OrderBy:排序字段,按收藏时间排序为 favoriteTime(默认)可选参数。
OrderByType:排序方式,升序为 asc,降序为 desc(默认),可选参数。
请求体
该请求无请求体。
响应
响应码
获取成功,返回 HTTP 200 OK。
响应体
application/json
响应体示例:
{"totalNum": 2,"page": 1,"pageSize": 20,"contents": [{"id": 123,"favoriteGroupId": 2,"spaceId": "spaceXXX","visible": false,"type": "file","modificationTime": "2021-08-12T08:13:55.000Z","path": ["yhltest", "test.png"],"name": "test.png","fileType": "image","contentType": "image/png","previewByDoc": false,"previewByCI": true,"size": "0","crc64": "0","eTag": "","localSync": null,"team": {"id": 49,"name": "F_MOVE_DEST","spaceId": "space2h8s0q74cstcv","parentId": 3},"authorityList": {"canView": true,"canPreview": true,"canDownload": false,"canUpload": false,"canDelete": false,"canModify": false,"canAuthorize": false,"canShare": false}},{"id": 222,"spaceId": "spaceXXX","favoriteGroupId": 0,"visible": false,"type": "file","modificationTime": "2021-08-12T08:13:55.000Z","path": ["yhltest"],"name": "test.png","fileType": "image","contentType": "image/png","previewByDoc": false,"previewByCI": true,"size": "0","crc64": "0","eTag": "","user": {"id": 11,"name": "xxx"},"localSync": {"syncId": 4,"strategy": "local_to_cloud","isSyncRootFolder": true,"syncUserId": "123"},"authorityList": {"canView": true,"canPreview": true,"canDownload": false,"canUpload": false,"canDelete": false,"canModify": false,"canAuthorize": false,"canShare": false}}]}
响应体字段说明:
id:整數,收藏 ID。
spaceId:字符串,空间 ID。
type:字符串,文件目录类型:
dir
:目录或相簿。file
:文件,仅用于文件类型媒体库。favoriteGroupId:整数,收藏夹 ID。
path 文件目录路径。
name 文件目名称。
visible 是否可见(文件目录被删除或无权限时为 false)。
modificationTime:文件最近一次被覆盖的时间。
fileType:文件类型:excel、powerpoint 等。
contentType:媒体类型。
crc64:文件的 CRC64-ECMA182 校验值,为了避免数字精度问题,这里为字符串格式。
size:文件目录大小,非必返。
previewByDoc:是否可通过 onlyoffice 预览。
previewByCI:是否可通过万象预览。
previewAsIcon:是否可用预览图做 icon,非必返。
authorityList:允许操作的权限,非必返。
canView:可查看,非必返。
canPreview:可预览,非必返。
canDownload:可下载,非必返。
canUpload:可上传,非必返。
canDelete:可删除,非必返。
canModify:可修改,非必返。
canAuthorize:可共享,非必返。
canShare:可分享,非必返。
localSync:当该文件夹是同步盘,或是同步盘的子级文件目录时,返回该字段。
isSyncRootFolder:当前文件夹是否为同步盘,如果是同步盘根目录返回 true,如果是同步盘子级节点,返回 false,如果不是同步盘,不返回该字段。
strategy:当该文件夹为同步盘时,返回同步方式,
local_to_cloud
,非必返。syncId:当该文件夹为同步盘时,返回同步任务 ID。
syncUserId:当该文件夹为同步盘时,返回设置同步任务的 userID。