更新时间:2024-07-30 GMT+08:00

获取分享详情

功能介绍

获取分享详情。

URI

GET /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位)

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应信息

shareLink

ShareByMeLinkDetail object

我分享的链接详情

表4 ShareByMeLinkDetail

参数

参数类型

描述

shareId

String

分享ID

shortUrl

String

分享短码

linkUrl

String

分享链接

shareTime

String

分享时间

scope

Integer

分享范围,1:收到连接的所有用户,2:仅企业内用户可访问,3:指定企业用户访问

depts

Array of DeptInfo objects

部门列表

groups

Array of GroupInfo objects

用户组列表

users

Array of UserInfo objects

用户列表

displayName

String

展示名称

permission

SharePermission object

分享权限(后续支持)

extractCode

String

提取码

expireTime

String

失效时间

status

Integer

分享状态,0:根据失效时间判断,1:文件已被删除,2:已失效

comment

String

分享留言

表5 DeptInfo

参数

参数类型

描述

id

String

部门id

name

String

部门名称

表6 GroupInfo

参数

参数类型

描述

id

String

用户组id

name

String

用户组名称

表7 UserInfo

参数

参数类型

描述

id

String

用户id

name

String

用户名称

表8 SharePermission

参数

参数类型

描述

preview

Boolean

预览权限

edit

Boolean

编辑权限

download

Boolean

下载权限

请求示例

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

Authorization:Bearer+10f88*************5a544791e9ff

响应示例

状态码: 200

OK

{
  "code" : "string",
  "msg" : "string",
  "shareLink" : {
    "shareId" : "string",
    "shortUrl" : "string",
    "linkUrl" : "string",
    "shareTime" : "2024-06-03T01:59:05.324Z",
    "scope" : 0,
    "depts" : [ {
      "id" : "string",
      "name" : "string"
    } ],
    "groups" : [ {
      "id" : "string",
      "name" : "string"
    } ],
    "users" : [ {
      "id" : "string",
      "name" : "string"
    } ],
    "displayName" : "string",
    "permission" : {
      "preview" : true,
      "edit" : true,
      "download" : true
    },
    "extractCode" : "string",
    "expireTime" : "2024-06-03T01:59:05.324Z",
    "status" : 0,
    "comment" : "string"
  }
}

状态码

状态码

描述

200

OK