查询指定数据项

获取单个数据记录。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/search/v2/data_sources/:data_source_id/items/:item_id
HTTP Method	GET
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	search:data_item:readonly 查询数据项 search:data_source 查询、创建、修改和删除自定义搜索数据源、数据范式或数据项 search:data_source:readonly 查询自定义搜索数据源、数据范式或数据项

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数

名称	类型	描述
data_source_id	string	数据源的id 示例值："service_ticket"
item_id	string	数据记录的唯一标识 注意： - 该字段大小写敏感。 - 如果调用成功但返回结果为空数据，请检查该字段传值是否正确。 示例值："01010111"

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ item	item	数据项实例
└ id	string	item 在 datasource 中的唯一标识，只允许英文字母、数字和下划线
└ acl	acl\[\]	item 的访问权限控制。 acl 字段为空数组，则默认数据不可见。如果数据是全员可见，需要设置 access="allow"; type="user"; value="everyone"
└ access	string	权限类型，优先级：Deny > Allow。 可选值有： - allow: 允许访问 - deny: 禁止访问
└ value	string	设置的权限值，例如 userID ，依赖 type 描述。 注：在 type 为 user 且 access 为 allow 时，可填 "everyone" 来表示该数据项对全员可见；
└ type	string	权限值类型 可选值有： - user_id: 用户在租户内的身份ID，详细说明请参考：https://open.feishu.cn/document/home/user-identity-introduction/introduction - open_id: 用户在应用内的身份ID，详细说明请参考：https://open.feishu.cn/document/home/user-identity-introduction/introduction - union_id: 用户在同一应用开发商提供的多个应用间的统一身份ID，详细说明请参考：https://open.feishu.cn/document/home/user-identity-introduction/introduction - department_id: 部门在租户内的唯一ID，详细说明请参考：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0 - open_department_id: 部门在应用内的唯一ID，详细说明请参考：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0 - group_id: GroupID（灰度中，对部分租户开放） - app_group_id: AppGroupID（灰度中，对部分租户开放） - user: 访问权限控制中指定“用户”可以访问或拒绝访问该条数据 - group: (已下线)访问权限控制中指定“用户组”可以访问或拒绝访问该条数据
└ metadata	item_metadata	item 的元信息
└ title	string	该条数据记录对应的标题
└ source_url	string	该条数据记录对应的跳转url
└ create_time	int	数据项的创建时间。Unix 时间，单位为秒
└ update_time	int	数据项的更新时间。Unix 时间，单位为秒
└ source_url_mobile	string	移动端搜索命中的跳转地址。如果您PC端和移动端有不同的跳转地址，可以在这里写入移动端专用的url，我们会在搜索时为您选择合适的地址
└ structured_data	string	结构化数据（以 json 字符串传递），这些字段是搜索结果的展示字段(特殊字段无须在此另外指定);具体格式可参参考 接入指南 请求创建数据项部分。这里的示例遵循了”创建数据范式“部分中的数据范式示例，请按自己定义的数据范式填写数据
└ content	item_content	非结构化数据，如文档文本，飞书搜索会用来做召回
└ format	string	内容的格式 可选值有： - html: html格式 - plaintext: 纯文本格式
└ content_data	string	全文数据

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "item": {
            "id": "01010111",
            "acl": [
                {
                    "access": "allow",
                    "value": "d35e3c23",
                    "type": "user"
                }
            ],
            "metadata": {
                "title": "工单：无法创建文章",
                "source_url": "http://www.abc.com.cn",
                "create_time": 1618831236,
                "update_time": 1618831236
            },
            "structured_data": "{\"key\":\"value\"}",
            "content": {
                "format": "html",
                "content_data": "这是一个很长的文本"
            }
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	1270001	系统内部错误	联系系统开发人员协助定位
400	1270002	参数错误	根据错误信息和文档排查非法参数
400	1270004	数据源不存在	确认 datasource ID 是否正确
400	1270005	该功能仅对旗舰版可用	请联系销售人员升级套餐以使用此高级功能
401	1272001	无权限操作数据源	确认 datasource ID 是否合法
500	1272002	操作鉴权失败	如果重试后仍然失败，请联系系统开发人员协助定位