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

列举我分享的文件列表

功能介绍

列举我分享的文件列表,一条分享记录一行,一次分享多个文件时展示名为第一个文件名+“等多个文件”,格式显示为folder,一次单个文件时显示该文件的信息。

URI

GET /koodrive/ose/v1/share

表1 Query参数

参数

是否必选

参数类型

描述

pageSize

Integer

每页返回的个数,默认是100,可接受值最大值是100。注意在到达最后的列表之前,实际有可能返回部分或者空结果

最大值:100

pageCursor

String

当前页游标,由前一个响应的nextCursor获取

sortType

Integer

排序类型,4:分享时间(默认)

sortDirection

Integer

排序方向,1:升序,2:降序(默认)

displayName

String

支持按照展示名称模糊匹配

请求参数

表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

响应信息

nextCursor

String

分页游标,如果不存在,代表已返回最后一个

shareLinks

Array of ShareByMeLink objects

分享链接列表

表5 ShareFileInfo

参数

参数类型

描述

id

String

*文件id

fileName

String

*文件名,最长160个字节

fileType

String

文件类型,外部输入

mimeType

String

*内容类型

size

Integer

文件大小

parentFolder

Array of strings

父目录ID列表,注意:当前只取第一个父母Id

fileSuffix

String

文件后缀,fullFileExtension最后一个字符串

containers

Array of strings

空间标识

表6 SharePermission

参数

参数类型

描述

preview

Boolean

预览权限

edit

Boolean

编辑权限

download

Boolean

下载权限

请求示例

GET /koodrive/ose/v1/share?pageSize=&pageCursor=0&sortType=2&sortDirection=4&displayName=

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

响应示例

状态码: 200

OK

{
  "code" : "string",
  "msg" : "string",
  "nextCursor" : "string",
  "shareLinks" : [ {
    "shareId" : "string",
    "shortUrl" : "string",
    "linkUrl" : "string",
    "shareTime" : "2024-06-03T01:58:35.419Z",
    "scope" : 0,
    "files" : [ {
      "id" : "string",
      "fileName" : "string",
      "fileType" : "string",
      "mimeType" : "string",
      "size" : 0,
      "parentFolder" : [ "string" ],
      "fileSuffix" : "string",
      "containers" : [ "string" ]
    } ],
    "displayName" : "string",
    "permission" : {
      "preview" : true,
      "edit" : true,
      "download" : true
    },
    "extractCode" : "string",
    "expireTime" : "2024-06-03T01:58:35.419Z",
    "status" : 0,
    "comment" : "string",
    "viewCnt" : 0,
    "downloadCnt" : 0,
    "saveCnt" : 0,
    "containerId" : "string",
    "containerName" : "string"
  } ]
}

状态码

状态码

描述

200

OK