有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

功能描述

获取组织分享列表。

请求

请求示例

GET /user/v1/organization/{OrganizationId}/share-list?page={Page}&page_size={PageSize}&order_by={OrderBy}&order_by_type={OrderByType}&name={Name}&expire_time_start={ExpireTimeStart}&expire_time_end={ExpireTimeEnd}&user_filter={NickNameOrEmailOrPhoneNumber}&user_token={UserToken}
请求参数:
OrganizationId:组织 ID,必选参数。
UserToken:用户令牌,必选参数。
Page:分页码,默认第一页,可选参数。
PageSize:分页大小,默认 20,可选参数。
OrderBy:排序方式,默认过期时间,可选参数。
OrderByType:排列顺序,正序或倒序 desc or asc,可选参数。
Name:分享名称,可选参数。
ExpireTimeStart:分享过期时间开始,可选参数。
ExpireTimeEnd:分享过期时间结束,可选参数。
NickNameOrEmailOrPhoneNumber:用户昵称/用户手机号/email,可选参数。

请求体

该请求无请求体。

响应

响应码

获取成功,返回 HTTP 200 OK。

响应体

application/json
响应体示例:
{
"totalNum": 10,
"contents": [
{
"id": 15,
"name": "nbiuh",
"expireTime": "2021-12-11T16:00:00.000Z",
"creationTime": "2021-10-29T02:12:23.000Z",
"nickname": "王五",
"type": "multi-file",
"fileType": "other",
"previewByDoc": false,
"previewByCI": false,
"previewAsIcon": false,
"disabled":false
}
]
}
响应体字段说明:
totalNum:整数,总数。
contents
id:整数,分享 ID。
name:整数,分享文件名称集合。
expireTime:日期字符串,过期时间。
creationTime:日期字符串,创建时间。
nickname:字符串,创建人昵称。
type:字符串,文件类型;混合文件:multi-file、文件:file、文件夹:dir。
previewByDoc:布尔值,是否可通过 onlyoffice 预览。
previewByCI:布尔值,是否可通过万象预览。
fileType:字符串,文件类型:excel、powerpoint 等。
previewAsIcon:布尔值,是否可用预览图当做 icon。
disabled:布尔值,是否被禁用。