搜索内容

项目兼容性

Windows | 跨平台

概述

描述	API 方法	API 路径
使用指定的筛选器在 Box 中搜索内容。	获取	/搜索

输入

参数	描述	数据类型
类型	指定是针对文件还是文件夹创建协作。	options
文件/文件夹	要在其上创建协作的文件或文件夹。	字符串
角色详细信息	有关分配给协作者的角色（例如，编辑者、查看者、预览者）的其他信息。	options
访问类型	授予用户或组的访问权限类型（例如，可以查看、可以编辑）。	options
组 ID	要添加为协作者的组的 ID。在管理控制台中：用户和组 → 组 → 选择组 → 复制 URL 中的尾随 ID。	字符串
协作者的电子邮件地址	要添加为协作者的用户的电子邮件地址。用户不必是现有的 Box 用户。	字符串
通知	指示是否应向协作者发送有关此操作的电子邮件通知。	boolean
查询	要搜索的字符串	字符串
类型	选择项目类型以将搜索结果限制为指定类型的项目	options
文件夹	选择文件夹以将搜索结果限制为指定文件夹中的项目	数据列表
所有者	选择所有者以将搜索结果限制为指定所有者拥有的任何项目	字符串
创建于开始日期和时间	将搜索结果限制为在此日期和时间或之后创建的任何项目	datetime
创建于结束日期和时间	搜索项目的结束日期和时间范围。如果省略开始日期和时间，则返回此日期之前的所有更新内容。	datetime
文件类型	将搜索结果限制为与所提供的任何文件扩展名匹配的任何文件。此列表是以逗号分隔的文件扩展名列表，不带点。	options
更新时间	将搜索结果限制为在此日期和时间或之后修改的所有项目	datetime
更新于结束日期和时间	搜索项目的结束日期和时间范围。如果省略开始日期和时间，则返回此日期之前的所有更新内容。	datetime
精确匹配	指定查询是否需要执行精确匹配	boolean
包括最近共享的链接	定义搜索结果是否应包含用户最近通过共享链接访问的任何项目。	boolean
最大记录数	给定页面中要返回的资源数量	Int32
Mdfilter	用作筛选搜索结果的元数据模板列表。除非定义了查询参数，否则为必填项。	字符串
尺寸范围	将搜索结果限制为大小在给定文件大小范围内的任何项目。这适用于文件和文件夹。例如：1000000,5000000	整数
字段	要包含在响应中的属性的逗号分隔列表。这可用于请求通常不会在标准响应中返回的字段	字符串
内容类型	将搜索结果限制为与文件特定部分的搜索查询匹配的任何项目，例如文件说明。内容类型定义为 Box 可识别内容类型的逗号分隔列表	字符串
范围	将搜索结果限制为用户有权访问的文件或整个企业有权访问的文件。	字符串
方向	定义搜索结果的排序方向。除非显式指定此参数，否则此 API 默认按降序 (DESC) 返回项目。	字符串
回收站内容	确定是否应在回收站中查找垃圾邮件，默认情况下，此 API 仅返回当前不在回收站中的项目的搜索结果 ( non_trapped_only)。	字符串
排序	定义搜索结果的返回顺序。除非显式指定此参数，否则此 API 默认按相关性返回项目。	字符串
位置	CEQL 搜索表达式	字符串

输出

参数	描述	数据类型
协作	为创建协作活动返回的完整响应有效负载	object

备注：

• 在 API 工作流中，系统会返回一个响应对象作为输出。任何必填字段均可直接从此对象中提取。
• 在 RPA 工作流中，某些输出参数可能有所不同，但即使未显式公开，仍可以从响应对象中检索必要的值。