修改分享设置 - updateShare

功能介绍

修改分享设置。

授权信息

当前API调用无需身份策略权限。

URI

PUT /koodrive/ose/v1/share/{shareId}

表1 路径参数
参数	是否必选	参数类型	描述
shareId	是	String	分享ID

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Authorization	是	String	该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token}
X-Traceid	否	String	业务跟踪id（必须58位）
X-User-Id	是	String	用户id，用于app鉴权
X-Date	是	String	日期，用于app鉴权
Host	是	String	地址，用于app鉴权

表3 请求Body参数
参数	是否必选	参数类型	描述
deptIds	否	Array of strings	部门id列表
groupIds	否	Array of strings	用户组id列表
userIds	否	Array of strings	用户id列表
permission	否	SharePermission object	分享权限（后续支持）
expireTime	否	String	失效时间
extractCode	否	String	提取码
comment	否	String	分享留言
validDays	是	Integer	分享有效天数0-365. 0表示不变

表4 SharePermission
参数	是否必选	参数类型	描述
preview	否	Boolean	预览权限
edit	否	Boolean	编辑权限
download	否	Boolean	下载权限

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
code	String	响应码
msg	String	响应信息
shareLink	shareLink object	分享链接信息

表6 shareLink
参数	参数类型	描述
shareId	String	分享id
shortUrl	String	分享链接
extractCode	String	提取码
createTime	String	创建时间
updateTime	String	修改时间
expireTime	String	失效时间
linkUrl	String	分享链接
shareTime	String	分享时间
scope	Integer	范围
displayName	String	显示名称
status	Integer	状态 0：根据失效时间判断 1：文件已删除 2：已失效 3：已过期
viewCnt	String	浏览次数
downloadCnt	String	下载次数
saveCnt	String	保存次数

请求示例

PUT /koodrive/ose/v1/share/{shareId}

{
  "deptIds" : [ "string" ],
  "groupIds" : [ "string" ],
  "userIds" : [ "string" ],
  "permission" : {
    "preview" : true,
    "edit" : true,
    "download" : true
  },
  "expireTime" : "2024-06-03T02:00:39.952Z",
  "extractCode" : "string",
  "comment" : "string",
  "validDays" : 0
}

响应示例

状态码：200

{
  "code" : "string",
  "msg" : "string",
  "shareLink" : {
    "shareId" : "string",
    "shortUrl" : "string",
    "extractCode" : "string",
    "createTime" : "2024-06-03T02:00:39.953Z",
    "updateTime" : "2024-06-03T02:00:39.953Z",
    "expireTime" : "2024-06-03T02:00:39.953Z"
  }
}