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

创建分享

功能介绍

创建分享。

URI

POST /koodrive/ose/v1/share

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token}

X-Traceid

String

业务跟踪id(必须58位)

表2 请求Body参数

参数

是否必选

参数类型

描述

scope

Integer

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

deptIds

Array of strings

部门id列表

groupIds

Array of strings

用户组id列表

userIds

Array of strings

用户id列表

fileIds

Array of strings

文件id列表

containerId

String

空间id

permission

SharePermission object

分享权限(后续支持)

extractCode

String

提取码

expireTime

String

失效时间

comment

String

分享留言

validDays

Integer

有效分享天数(1-365)

表3 SharePermission

参数

是否必选

参数类型

描述

preview

Boolean

预览权限

edit

Boolean

编辑权限

download

Boolean

下载权限

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应信息

shareLink

shareLink object

分享链接信息

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error

Error object

表7 Error

参数

参数类型

描述

errorData

errorData object

异常时候返回给访问者的扩展数据

errorDetail

Array of ErrorMsg objects

错误链

code

Integer

http状态码

description

String

http状态信息

表8 errorData

参数

参数类型

描述

conflictFileId

String

冲突文件ID

表9 ErrorMsg

参数

参数类型

描述

domain

String

reason

String

错误原因

errorCode

String

系统内部错误编码, 参见错误码规范

description

String

错误描述信息

errorPos

String

错误位置类型

errorParam

String

错误位置

请求示例

POST /koodrive/ose/v1/share

Authorization:Bearer+10f88**********4791e9ff

{
  "scope": 0,
  "deptIds": [
    "string"
  ],
  "groupIds": [
    "string"
  ],
  "userIds": [
    "string"
  ],
  "fileIds": [
    "string"
  ],
  "containerId": "string",
  "permission": {
    "preview": true,
    "edit": true,
    "download": true
  },
  "extractCode": "string",
  "expireTime": "2024-06-03T01:54:57.288Z",
  "comment": "string",
  "validDays": 0
}

响应示例

状态码: 200

OK

{
  "data" : {
    "taskId" : "1428103989525998336"
  },
  "code" : 0,
  "msg" : "成功"
}

状态码: 400

{
  "error" : {
    "errorData" : {
      "conflictFileId" : "string"
    },
    "errorDetail" : [ {
      "domain" : "string",
      "reason" : "string",
      "errorCode" : "string",
      "description" : "string",
      "errorPos" : "string",
      "errorParam" : "string"
    } ],
    "code" : 0,
    "description" : "string"
  }
}

状态码

状态码

描述

200

OK

400