文档首页/ 云空间服务 KooDrive/ API参考/ API/ 文件管理/ 使用搜索引擎能力检索文件
更新时间：2024-10-24 GMT+08:00
查看PDF
分享

使用搜索引擎能力检索文件

功能介绍

根据搜索范围、父目录、文件名、文件大小区间、更新时间段、所有者等条件搜索空间的文件，普通用户和部门管理员用户可以搜索个人和所在团队的空间，租户管理员可以查询租户下的所有团队空间。

URI

POST /koodrive/ose/v1/files/search

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Traceid

否

String

消息日志跟踪标识(必须58位)

Authorization

是

String

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

X-User-Id

是

String

用户id,用于app鉴权

X-Date

是

String

日期,用于app鉴权

Host

是

String

地址,用于app鉴权

language

否

String

国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语
表2 请求Body参数

参数

是否必选

参数类型

描述

searchType

是

String

查询类型

  • personal：个人空间

  • team：团队空间

pageInfo

是

pageInfo object

分页信息

filter

否

filter object

过滤器

sortInfo

否

sortInfo object

排序信息

recycled

否

Boolean

是否查询回收站，不传默认false 枚举值：

  • true：查回收站文件

  • false：查对应空间非回收站

recursived

否

Boolean

是否递归查询子目录文件，默认false
表3 pageInfo

参数

是否必选

参数类型

描述

pageSize

是

Integer

每页大小，取值范围[1,100]

pageCursor

是

String

起始游标，为空时从第一页开始查询
表4 filter

参数

是否必选

参数类型

描述

keyWord

否

String

文件名称，模糊匹配,最长80个字符

containerId

否

String

空间id，指定父目录时必传

parentFolder

否

String

父目录

fileType

否

String

文件类型，枚举值

/**

* 文件夹

/ FOLDER("10"), /*

* 图片

/ PICTURE("15"), /*

* 视频

/ VIDEO("20"), /*

* word

/ WORD("26"), /*

* excel

/ EXCEL("27"), /*

* ppt

/ PPT("28"), /*

* 音频

/ AUDIO("30"), /*

* 压缩文件

/ ARCHIVE("35"), /*

* 应用

/ APPLICATION("40"), /*

* 其他

*/

OTHER("45");

updateTimeRange

否

String

最后更新时间区间

ownerId

否

String

文件所有者
表5 sortInfo

参数

是否必选

参数类型

描述

sortType

否

String

枚举类型：

  • fileName：文件名

  • size：文件大小

  • type：文件格式

  • updateTime：最后更新时间

  • createTime：创建时间

  • recycledTime：删除时间

  • fileSuffix：文件格式小类

sortDirection

否

String

枚举类型：

  • desc：降序

  • asc：升序列

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

code

Integer

响应码，成功返回0，失败返回错误码

msg

String

成功、错误信息

files

Array of files objects

搜索结果

total

Integer

总数

nextPageCursor

String

下一页起始游标，最后一页值为空
表7 files

参数

参数类型

描述

id

String

文件id

fileSuffix

String

文件后缀

fileName

String

文件名

fileType

String

文件类型

size

String

文件大小

updateTime

String

最后更新时间

namePath

String

名称全路径

idPath

String

id全路径

downloadLinks

Array of downLoadLinks objects

图片类型返回，缩略图地址

teamName

String

团队空间返回，部门名称或者群组空间名称

teamId

String

群组id，即部门的id或者群组的id

containerId

String

空间id

containerType

String

0：部门空间，1：个人空间，2：群组空间

favorite

Boolean

个人空间、团队空间返回文件是否被当前用户收藏

owner

String

团队空间返回owner名称
表8 downLoadLinks

参数

参数类型

描述

usage

String

用途，thumbnail缩略图，content内容

downloadLink

String

图片地址

请求示例

搜索文件请求示例。

POST /koodrive/ose/v1/files/search

Authorization:Bearer+10f88*********4791e9ff
{
  "searchType" : " personal/team",
  "pageInfo" : {
    "pageSize" : 100,
    "pageCursor" : 1
  },
  "filter" : {
    "keyWord" : "材料",
    "containerId" : "123456",
    "parentFolder" : "1",
    "fileType" : "1",
    "sizeRang" : "1024,2048",
    "updateTimeRange" : "2023-11-02,2023-11-21",
    "ownerId" : "归属用户id"
  }
}

响应示例

状态码： 200

搜索结果

{
  "code" : 0,
  "msg" : "success",
  "files" : [ {
    "id" : "Abc",
    "fileName" : "Abc",
    "fileType" : "1",
    "size" : "1024",
    "updateTime" : "2023-05-26T02:08:53.683Z",
    "namePath" : "",
    "downloadLinks" : "",
    "deptName" : ""
  } ],
  "total" : 1000
}

状态码

状态码

描述

200

搜索结果
父主题： 文件管理

相关文档