功能描述
用于获取我共享的文件夹。
请求
请求示例
GET /api/v1/authority/
{LibraryId}
/authorized-directory?page={Page}
&page_size={PageSize}
&order_by={OrderBy}
&order_by_type={OrderByType}
&access_token={AccessToken}
请求参数:
LibraryId:媒体库 ID,必选参数。
Page:分页码,默认第一页,可选参数。
PageSize:分页大小,默认 20,可选参数。
OrderBy:排序字段,按名称排序为 name,按修改时间排序为 modificationTime,按文件大小排序为 size,按创建时间排序为 creationTime,可选参数。
OrderByType:排序方式,升序为 asc,降序为 desc,可选参数。
AccessToken:访问令牌,必选参数。
请求体
该请求无请求体。
响应
响应码
获取成功,返回 HTTP 200 OK。
响应体
application/json
响应体示例:
{"totalNum": 1,"contents": [{"spaceId": "","name": "yhltest","type": "dir","creationTime": "2021-08-12T08:13:55.000Z","modificationTime": "2021-08-12T08:13:55.000Z","versionId":2,"path": ["yhltest"],"localSync": {"syncId": 4,"strategy": "local_to_cloud","isSyncRootFolder": true,"syncUserId": "123"},},{"spaceId": "","name": "yhltest","type": "dir","creationTime": "2021-08-12T08:13:55.000Z","modificationTime": "2021-08-12T08:13:55.000Z","versionId":2,"path": ["yhltest"],"syncId": 4,"localSync": {"syncId": 4,"strategy": "local_to_cloud","isSyncRootFolder": false,"syncUserId": "123",},}]}
响应体字段说明:
totalNum:整数,当前目录中的所有文件和子目录数量(不包含孙子级)。
contents:对象数组,目录或相簿内的具体内容:
name:字符串,目录或相簿名或文件名。
versionId:版本号。
type:字符串,条目类型:
dir
:目录或相簿。file
:文件,仅用于文件类型媒体库。image
:图片,仅用于媒体类型媒体库。video
:视频,仅用于媒体类型媒体库。creationTime:ISO 8601格式的日期与时间字符串,表示目录或相簿的创建时间或文件的上传时间,例如
2020-10-14T10:17:57.953Z
。modificationTime:文件最近一次被覆盖的时间,或者目录内最近一次增删子目录或文件的时间。
path:文件路径,用于跳转到对应的目录。
localSync:当该文件夹是同步盘,或是同步盘的子级文件目录时,返回该字段。
isSyncRootFolder:当前文件夹是否为同步盘,如果是同步盘根目录返回 true,如果是同步盘子级节点,返回 false,如果不是同步盘,不返回该字段。
strategy:当该文件夹为同步盘时,返回同步方式,
local_to_cloud
,非必返。syncId:当该文件夹为同步盘时,返回同步任务 ID。
syncUserId:当该文件夹为同步盘时,返回设置同步任务的 userID。