资源工坊

文件搜索 ​

适用版本>=v7.0.2501a.20250116

接口说明：文件搜索

请求说明 ​

请求地址配置域名+/openapi+/v7/files/search
请求方法GET
签名方式KSO-1（配置域名+/openapi不参与签名）
权限要求搜索文件（应用授权） kso.file.search
搜索文件（用户授权） kso.file.search

请求头（Header） ​

Header参数类型是否必填说明
X-Kso-Datestring是RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-Authorizationstring是KSO-1 签名值，详见《签名方法》
Authorizationstring是授权凭证，格式为：Bearer {access_token}

查询参数（Query） ​

名称参数类型是否必填说明
keywordstring是搜索关键字，<= 1024 characters
typestring是搜索类型，可选值：
file_name：按文件名搜索
content：全文检索，需先在系统后台开启全文检索开关。配置入口：系统配置-通用配置
file_typestring否文件类型，folder：文件夹；file：文件
file_extsobject否Array of strings <= 40 items [ items <= 1024 characters ]文件后缀。搜索超过40种后缀时，筛选失效，默认搜索全格式。
drive_idsobject否Array of strings <= 1024 items [ items <= 1024 characters ] 搜索盘列表，v7接口支持数组
parent_idsstring否Array of strings <= 1024 items [ items <= 1024 characters ]搜索目录列表
creator_idsstring否Array of strings <= 1024 items [ items <= 1024 characters ]创建者id，公网只支持选择是否自己创建的文件
time_typestring否Enum: “ctime” “mtime”，时间范围
start_timestring否最小时间，时间戳，单位为秒
end_timestring否最大时间，时间戳，单位为秒
with_permissionstring否是否返回文件操作权限
with_linkstring否参数无效，默认为true
page_sizestring是分页大小，page_size和page_token值相加最大值为10000（即最多查到前10000条数据）
page_tokenstring否分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回next_page_token作为新的page_token，下次遍历可采用该page_token获取查询结果

响应体（Response） ​

名称类型说明
dataobject
∟ itemsobjectArray of objects <= 1024 items，数据集合
∟ ∟ fileobject文件信息
∟ ∟ ∟ idstring文件id
∟ ∟ ∟ drive_idstring驱动盘id
∟ ∟ ∟ parent_idstring父文件id
∟ ∟ ∟ created_byobject创建者信息
∟ ∟ ∟ ∟ avatarstring创建者头像，<= 1024 characters
∟ ∟ ∟ ∟ company_idstring创建者企业id，<= 1024 characters
∟ ∟ ∟ ∟ idstring创建者id，<= 1024 characters
∟ ∟ ∟ ∟ namestring创建者名称，<= 1024 characters
∟ ∟ ∟ ∟ typestring创建者身份类型，user：用户；
∟ ∟ ∟ modified_byobject修改者信息
∟ ∟ ∟ ∟ avatarstring修改者头像，<= 1024 characters
∟ ∟ ∟ ∟ company_idstring修改者企业id，<= 1024 characters
∟ ∟ ∟ ∟ idstring修改者id，<= 1024 characters
∟ ∟ ∟ ∟ namestring修改者名称，<= 1024 characters
∟ ∟ ∟ ∟ typestring修改者身份类型，user：用户；
∟ ∟ ∟ sizeint64文件大小
∟ ∟ ∟ versionint文件版本
∟ ∟ ∟ typestring文件类型
∟ ∟ ∟ namestring文件名称
∟ ∟ ∟ ctimeint64文件创建时间，时间戳，单位为秒
∟ ∟ ∟ mtimeint64文件修改时间，时间戳，单位为秒
∟ ∟ ∟ hashobject文件哈希信息
∟ ∟ ∟ ∟ sumstring哈希结果
∟ ∟ ∟ ∟ typestring哈希类型，固定为s2s
∟ ∟ ∟ ext_attrsobject[]文件扩展属性
∟ ∟ ∟ permissionobject文件权限
∟ ∟ ∟ link_urlstring分享链接
∟ ∟ ∟ link_idstring分享链接id
∟ ∟ file_srcobject文件位置
∟ ∟ ∟ namestring<= 1024 characters，来源名称
∟ ∟ ∟ typestringEnum: “link” “user_private” “user_roaming” “group_normal” “group_dept” “group_whole”，来源类型
∟ ∟ ∟ pathstring文件路径
∟ ∟ highlightsobject匹配关键字
∟ next_page_tokenstring下一页分页标记，<= 1024 characters；当查询结果中next_page_token为空或无该返回值时，代表无下一页
codeint错误码
msgstring状态信息
detailstring详细信息

响应体示例 ​

json
{
  "data": {
    "items": [
      {
        "file": {
          "created_by": {
            "avatar": "string",
            "company_id": "string",
            "id": "string",
            "name": "string",
            "type": "user"
          },
          "ctime": 0,
          "drive_id": "string",
          "ext_attrs": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "hash": {
            "sum": "string",
            "type": "s2s"
          },
          "id": "string",
          "link_id": "string",
          "link_url": "string",
          "modified_by": {
            "avatar": "string",
            "company_id": "string",
            "id": "string",
            "name": "string",
            "type": "user"
          },
          "mtime": 0,
          "name": "string",
          "parent_id": "string",
          "permission": {
            "comment": true,
            "copy": true,
            "copy_content": true,
            "delete": true,
            "download": true,
            "list": true,
            "move": true,
            "new_empty": true,
            "perm_ctl": true,
            "preview": true,
            "print": true,
            "rename": true,
            "share": true,
            "update": true,
            "upload": true
          },
          "size": 0,
          "type": "folder",
          "version": 0
        },
        "file_src": {
          "name": "string",
          "type": "link",
          "path": "string"
        },
        "highlights": {}
      }
    ],
    "next_page_token": ""
  },
  "code": 0,
  "detail": "string",
  "msg": "string"
}