有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

功能描述

用于继续获取搜索结果。

接口说明

权限要求:超级管理员或系统管理员。

请求

请求示例

GET /api/v1/search/{LibraryId}/{SpaceId}/{SearchId}?marker={Marker}&access_token={AccessToken}&user_id={UserId}
请求参数:
LibraryId: 媒体库 ID,必选参数;
SpaceId: 空间 ID,必须指定该参数,如果媒体库为单租户模式,则该参数固定为连字符(-);
SearchId: 搜索任务 ID,必选参数;
Marker: 分页标识,创建搜索任务时或继续获取搜索结果时返回的 nextMarker 字段,必选参数;
AccessToken: 访问令牌,必选参数;
UserId: 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数。


请求体

该请求无请求体。

响应

响应码

获取搜索结果成功,返回 HTTP 200 OK。

响应体

application/json
响应体示例:
{
"searchId": "FnMwV3NweXJOU2hTOTRpTnF0TW9EZVEeVUFhYUl5TGFSaTZtZUpDcEpUcEtxdzo3NjQ3NjU1",
"searchFinished": true,
"hasMore": true,
"nextMarker": 20,
"contents": [
{
"type": "file",
"name": "api.zip",
"spaceTag": "personal",
"creationTime": "2021-08-19T04:40:01.000Z",
"modificationTime": "2021-08-19T04:40:01.000Z",
"contentType": "application/zip",
"size": "67084",
"eTag": "\\"52c2d19d61fae57d11caabe87f71de73\\"",
"crc64": "8970780629994048831",
"versionId":2,
"metaData": {
"x-smh-meta-creation-date": "Thu, 19 Aug 2021 04:39:59 GMT"
},
"path": [],
"userId": "12",
"userOrgId": "123"
},
{
"type": "file",
"spaceTag": "personal",
"name": "bmw (1).PDF",
"creationTime": "2021-08-21T07:56:32.000Z",
"modificationTime": "2021-08-21T07:56:32.000Z",
"contentType": "application/pdf",
"size": "241674",
"eTag": "\\"030ca96f0af3b3d3cfbf31c2be3129d6\\"",
"crc64": "12098979488941977387",
"metaData": {
"x-smh-meta-creation-date": "Sat, 21 Aug 2021 07:56:30 GMT"
},
"path": [],
"userId": "12",
"userOrgId": "123"
},
{
"type": "file",
"spaceTag": "personal",
"name": "bmw.pdf",
"creationTime": "2021-08-17T13:19:07.000Z",
"modificationTime": "2021-08-17T13:19:07.000Z",
"contentType": "application/pdf",
"size": "241674",
"eTag": "\\"030ca96f0af3b3d3cfbf31c2be3129d6\\"",
"crc64": "12098979488941977387",
"metaData": {
"x-smh-meta-creation-date": "Tue, 17 Aug 2021 13:19:06 GMT"
},
"path": [],
"userId": "12",
"userOrgId": "123"
},
{
"type": "dir",
"spaceTag": "personal",
"name": "fysn",
"creationTime": "2021-08-20T10:01:40.000Z",
"modificationTime": "2021-08-21T07:30:25.000Z",
"path": [],
"userId": "12",
"userOrgId": "123"
},
{
"type": "file",
"name": "智能媒资托管-144px (1).png",
"spaceTag": "personal",
"creationTime": "2021-08-20T09:59:25.000Z",
"modificationTime": "2021-08-20T09:59:25.000Z",
"contentType": "image/png",
"size": "7199",
"eTag": "\\"7d9ce6ef46c00d3924702b7b4224d029\\"",
"crc64": "13076174829147183381",
"metaData": {
"x-smh-meta-creation-date": "Fri, 20 Aug 2021 09:59:22 GMT"
},
"path": [
"fysn"
],
"previewByDoc": true,
"previewByCI": true,
"previewAsIcon": true,
"fileType": "powerpoint",
"modifierName": "Tim",
"userId": "12",
"userOrgId": "123"
}
/* ... */
]
}


响应体字段说明:
searchId: 搜索任务 ID,用于异步获取搜索结果;
searchFinished: 布尔型,搜索是否已完成;
hasMore: 布尔型,是否有更多搜索结果;
nextMarker: 用于获取后续页的分页标识,仅当 hasMore 为 true 时才返回该字段;
contents: 第一页搜索结果,可能为空数组,有关异步搜索的说明请参阅【接口说明】;
type: 字符串,条目类型:
dir: 目录或相簿;
file: 文件,仅用于文件类型媒体库;
image: 图片,仅用于媒体类型媒体库;
video: 视频,仅用于媒体类型媒体库;
symlink: 符号链接;
name: 字符串,目录或相簿名或文件名;
spaceTag: 字符串,非必返;
creationTime: ISO 8601格式的日期与时间字符串,表示目录或相簿的创建时间或文件的上传时间,例如 2020-10-14T10:17:57.953Z
modificationTime: 文件最近一次被覆盖的时间,或者目录内最近一次增删子目录或文件的时间;
contentType: 媒体类型;
versionId: 版本号;
size: 文件大小,字符串格式;
eTag: 文件 ETag;
crc64: 文件的 CRC64-ECMA182 校验值,为了避免数字精度问题,这里为字符串格式;
metaData: 文件元数据信息;
path: 当前项目所在的目录,包含当前项目的 name;
userOrgId: 创建/更新者所在的组织 ID
userId: 创建/更新者用户 ID
previewByDoc: 是否可进行文档预览;
previewByCI: 是否可进行图片、视频预览;
previewAsIcon: 是否可使用预览图当做 icon;
fileType: 文件类型:excel、powerpoint 等;
modifierName: 字符串,更新者昵称。