文件标题搜索,此方法速度由搜索范围决定,请根据事情实际搜索时间调整参数。
请求方式: POST(HTTP/HTTPS)
请求地址: /api/ff/file/titleSearch?token=ACCESS_TOKEN
请求包示例:
{
"fid": "F00003",
"key": "docker",
"style": 2,
"maxCount":1024,
"iter":true
}
参数说明:
参数 | 类型 | 必须 | 说明 |
token |
string |
是 |
调用接口凭证 |
fid |
string |
是 |
父文件id,如果为空,从系统根文件夹搜索 |
style |
int8 |
是 |
搜索匹配方式,=1 前匹配,=2 部分匹配 |
maxCount |
int32 |
否 |
默认1024 |
iter |
bool |
是 |
=true 包括子文件夹(递归),=false 不递归 |
返回结果示例:
{
"errcode": 0,
"errmsg": "",
"items": [
{
"id": "X00041",
"name": "Windows系统安装Docker.docx",
"from": "页面操作",
"modTime": "2024-07-20 11:50:58",
"createAt": "2025-06-19 12:59:43",
"dataHash": "31064981559bc8b1c2cc9ff995b49a72a10eb62c",
"sc": "",
"size": 2261011,
"verId": 1,
"inRecycle": false,
"lock": 0,
"fatherId": "F00046",
"uploader": "U0002,系统管理员",
"desc": "",
"keywords": ""
},
{
"id": "X00040",
"name": "Linux Docker模式下安装Onlyoffice.docx",
"from": "页面操作",
"modTime": "2025-04-30 14:22:14",
"createAt": "2025-06-19 12:59:43",
"dataHash": "b48c6a252df1eae4a064e73494760b4797eff31c",
"sc": "",
"size": 1384502,
"verId": 1,
"inRecycle": false,
"lock": 0,
"fatherId": "F00003",
"uploader": "U0002,系统管理员",
"desc": "OnlyOffice官网说明",
"keywords": "onlyOffice;docker"
}
]
}
返回参数说明:
参数 | 类型 | 说明 |
errcode |
int32 |
出错返回码,为0表示成功,非0表示调用失败 |
errmsg |
string |
返回码提示语 |
items |
array |
搜到的文件结果数组 |
--- items集合字段 |
id |
string |
文件ID |
name |
string |
文件名称 |
from |
string |
文件来源,(页面上传,数据导入) |
dataHash |
string |
文件内容HASH值,二进制转十六进制字符串 |
modTime |
string |
文件修改实际 |
createAt |
string |
文件上传/导入时间 |
sc |
string |
文件密级(启用密级情况) |
size |
int64 |
大小 |
verId |
int32 |
当前版本编号 |
inRecycle |
bool |
是否在回收站中 |
lock |
int8 |
=0,没有归档,=1文件已经归档 |
fatherId |
string |
父文件ID |
uploader |
string |
上传人 |
desc |
string |
文件备注 |
keywords |
string |
关键词/标签 |
权限要求:搜索结果文件如果有【文件基本信息查看】权限才能显示,没有权限不会出现在结果中。