搜索信息中心元素

版本 3.1.23.4

搜索信息中心元素

返回与指定搜索条件匹配的 DashboardElement 对象数组

如果指定了多个搜索参数且 filter_or 为 FALSE 或未指定,则搜索参数会在逻辑 AND 运算中合并。系统将仅返回与所有搜索参数条件匹配的行。

如果 filter_or 为 TRUE,系统会将多个搜索参数合并到一个逻辑 OR 运算中。 结果将包含与任何搜索条件匹配的行。

字符串搜索参数使用不区分大小写的匹配方式。字符串搜索参数可以包含 % 和“_”,因为 SQL LIKE 模式将匹配通配符表达式。example="dan%" 将与“danger”和“Danzig”匹配,但与“David”不匹配 example="D_m%”将与“Damage”和“dump”匹配

整数搜索参数可以接受单个值,也可以接受逗号分隔值列表。系统会在逻辑 OR 运算下合并多个值,结果会至少与给定值中的一个匹配。

大多数搜索参数可以接受“IS NULL”和“NOT NULL”作为特殊表达式,以匹配或排除相应的列为 null 的行。

布尔值搜索参数仅接受“true”和“false”作为值。

请求

获取 /dashboard_elements/search
数据类型
说明
请求
HTTP 请求
查询
HTTPQuery
展开 HTTPQuery 定义...
信息中心 ID
整数
选择引用指定信息中心 ID 的元素
Look_id
整数
选择引用给定外观 ID 的元素
title
字符串
与元素的标题相匹配
已删除
布尔值
选择软删除的信息中心元素
字段
字符串
请求的字段。
过滤条件或
布尔值
以布尔值 OR 表达式合并指定的搜索条件
排序
字符串
排序依据。可排序字段:[:look_id, :dashboard_id, :deleted, :title]

响应

200:信息中心元素

数据类型
说明
(数组)
可以
对象
当前用户可以对此对象执行的操作
正文
字符串
文本图块正文
正文文本
字符串
文本图块,采用 HTML 格式的文本
信息中心 ID
字符串
信息中心 ID
修改_ URI
字符串
用于修改信息中心元素的 LookML 文件的 URI 相对路径(仅限 LookML 信息中心)。
id
字符串
唯一 ID
相似,
Look
展开 LookWithQuery 定义...
可以
对象
当前用户可以对此对象执行的操作
content_metadata_id
整数
内容元数据的 ID
id
整数
唯一 ID
title
字符串
外观标题
content_favorite_id
整数
内容收藏 ID
创建时间
字符串
Look 的创建时间。
已删除
布尔值
外观是否“软”删除。
已删除
字符串
Look 删除的时间。
deleter_id
整数
删除样式的用户的 ID。
说明
字符串
说明
嵌入网址
字符串
嵌入网址
excel_file_url
字符串
Excel 文件网址
收藏次数
整数
被收藏的次数
google_spreadsheet_formula
字符串
Google 电子表格公式
image_embed_url
字符串
图片嵌入网址
is_run_on_load
布尔值
在查看 Look 时自动运行查询
上次访问日期:
字符串
任何用户上次访问 Look 的时间
last_updater_id(上次更新 ID)
整数
上次更新外观的用户的 ID。
上次查看日期
字符串
Looker 网页界面中的上次查看时间
模型
模型
展开 LookModel 定义...
id
字符串
模型 ID
标签
字符串
模型标签
public
布尔值
是公开的
public_slug
字符串
公麋鹿
公开网址
字符串
公开网址
查询 ID
整数
查询 ID
短网址
字符串
短网址
文件夹
文件夹
此外观的文件夹
展开 FolderBase 定义...
name
字符串
唯一名称
parent_id
字符串
父级的 ID。如果父 ID 为 null,这是一个根级条目
id
字符串
唯一 ID
content_metadata_id
整数
内容元数据的 ID
创建时间
字符串
文件夹的创建时间
creator_id [创作者 ID]
整数
创建者的用户 ID
儿童人数
整数
儿童数量
external_id
字符串
如果此文件夹通过单点登录外部登录中的“external_group_id”自动生成为嵌入共享文件夹,则嵌入者的 ID
is_embed
布尔值
文件夹是嵌入文件夹
is_embed_shared_root
布尔值
文件夹是根嵌入的共享文件夹
is_embed_users_root
布尔值
文件夹是根嵌入用户文件夹
是个人
布尔值
文件夹是用户的个人文件夹
is_personal_descendant
布尔值
文件夹是用户个人文件夹的后代
is_shared_root
布尔值
文件夹是根共享文件夹
is_users_root
布尔值
Folder 是根用户文件夹
可以
对象
当前用户可以对此对象执行的操作
文件夹 ID
字符串
文件夹 ID
更新时间
字符串
Look 更新的时间。
user_id
整数
用户 ID
观看次数
整数
在 Looker 网页界面中查看次数
位用户
(已弃用)用户
展开 UserIdOnly 定义...
id
整数
唯一 ID
空格 ID
字符串
聊天室 ID
空格
这种造型的空间
展开 SpaceBase 定义...
name
字符串
唯一名称
parent_id
字符串
父级的 ID。如果父 ID 为 null,这是一个根级条目
id
字符串
唯一 ID
content_metadata_id
整数
内容元数据的 ID
创建时间
字符串
聊天室的创建时间
creator_id [创作者 ID]
整数
创建者的用户 ID
儿童人数
整数
儿童数量
external_id
字符串
如果此空间在单点登录嵌入登录信息中通过“external_group_id”自动生成为嵌入共享空间,则嵌入者的 ID
is_embed
布尔值
聊天室是嵌入的聊天室
is_embed_shared_root
布尔值
聊天室是根嵌入共享空间
is_embed_users_root
布尔值
根级用户空间是聊天室
是个人
布尔值
聊天室是用户的个人空间
is_personal_descendant
布尔值
空间是用户个人空间的后代
is_shared_root
布尔值
聊天室是根共享聊天室
is_users_root
布尔值
聊天室是指根用户空间
可以
对象
当前用户可以对此对象执行的操作
查询
查询
展开查询定义...
可以
对象
当前用户可以对此对象执行的操作
id
整数
唯一 ID
模型
字符串
模型
视图
字符串
探索名称
字段
字符串 []
数据透视
字符串 []
fill_fields
字符串 []
filters
对象
过滤器
过滤条件表达式
字符串
过滤条件表达式
排序
字符串 []
限制
字符串
限制
列限制
字符串
列数上限
总计
布尔值
总计
总行数
字符串
原始总计
小计
字符串 []
vis_config
对象
可视化配置属性。这些属性通常不透明,因所用的可视化类型而异。没有已指定的一组允许的键。这些值可以是 JSON 支持的任何类型。通常具有存在字符串值的“类型”键,供 Looker 用来确定显示哪个可视化图表。可视化图表会忽略未知 vis_config 属性。
过滤条件配置
对象
filter_config 表示给定查询的探索页面上的过滤条件界面的状态。通过 Looker 界面运行查询时,此参数的优先级高于“过滤器”。创建查询或修改现有查询时,应将“filter_config”设置为 null。将其设置为任何其他值都可能会导致意外的过滤行为。该格式应视为不透明。
visible_ui_sections
字符串
可见界面部分
处理后标题
字符串
Slug
动态字段
字符串
动态字段
client_id
字符串
客户端 ID:用于生成缩短的探索网址。如果由客户端设置,则必须是唯一的 22 位字母数字字符串。否则,系统会生成一个。
分享网址
字符串
分享网址
展开网址共享网址
字符串
展开后的共享网址
网址
字符串
展开后的网址
query_timezone
字符串
查询时区
has_table_calculations
布尔值
包含表计算
runtime
数值
(已弃用)运行时(已弃用)
网址
字符串
网址
Look_id
字符串
外观 ID
findml_link_id
字符串
LookML 关联 ID
merge_result_id
字符串
合并结果的 ID
note_display
字符串
记事显示
记事状态
字符串
备注状态
记事文本
字符串
备注文本
note_text_as_html
字符串
备注文本为 html
查询
查询
展开查询定义...
可以
对象
当前用户可以对此对象执行的操作
id
整数
唯一 ID
模型
字符串
模型
视图
字符串
探索名称
字段
字符串 []
数据透视
字符串 []
fill_fields
字符串 []
filters
对象
过滤器
过滤条件表达式
字符串
过滤条件表达式
排序
字符串 []
限制
字符串
限制
列限制
字符串
列数上限
总计
布尔值
总计
总行数
字符串
原始总计
小计
字符串 []
vis_config
对象
可视化配置属性。这些属性通常不透明,因所用的可视化类型而异。没有已指定的一组允许的键。这些值可以是 JSON 支持的任何类型。通常具有存在字符串值的“类型”键,供 Looker 用来确定显示哪个可视化图表。可视化图表会忽略未知 vis_config 属性。
过滤条件配置
对象
filter_config 表示给定查询的探索页面上的过滤条件界面的状态。通过 Looker 界面运行查询时,此参数的优先级高于“过滤器”。创建查询或修改现有查询时,应将“filter_config”设置为 null。将其设置为任何其他值都可能会导致意外的过滤行为。该格式应视为不透明。
visible_ui_sections
字符串
可见界面部分
处理后标题
字符串
Slug
动态字段
字符串
动态字段
client_id
字符串
客户端 ID:用于生成缩短的探索网址。如果由客户端设置,则必须是唯一的 22 位字母数字字符串。否则,系统会生成一个。
分享网址
字符串
分享网址
展开网址共享网址
字符串
展开后的共享网址
网址
字符串
展开后的网址
query_timezone
字符串
查询时区
has_table_calculations
布尔值
包含表计算
runtime
数值
(已弃用)运行时(已弃用)
查询 ID
整数
查询 ID
刷新间隔时间
字符串
刷新间隔时间
refresh_interval_to_i
整数
刷新间隔(整数)
result_maker
结果生成器的相关数据。
展开 ResultMakerWithIdVisConfigAndDynamicFields 定义...
id
整数
唯一 ID。
动态字段
字符串
动态字段信息的 JSON 字符串。
可过滤
展开 ResultMakerFilterable 定义...
模型
字符串
此可过滤条件来自的模型(用于字段建议)。
视图
字符串
此可过滤数据的来源视图(用于字段建议)。
name
字符串
可过滤对象(查询或合并的结果)的名称。
排序
字符串 []
merge_result_id
字符串
如果是 merge_result,则为合并结果的 ID。
总计
布尔值
组成部分的“查看”、“查询”或“合并查询”总数
查询 ID
整数
如果是查询,则为查询的 ID。
sql_query_id
字符串
SQL 查询的 ID(如果是 SQL Runner 查询)
查询
查询
展开查询定义...
可以
对象
当前用户可以对此对象执行的操作
id
整数
唯一 ID
模型
字符串
模型
视图
字符串
探索名称
字段
字符串 []
数据透视
字符串 []
fill_fields
字符串 []
filters
对象
过滤器
过滤条件表达式
字符串
过滤条件表达式
排序
字符串 []
限制
字符串
限制
列限制
字符串
列数上限
总计
布尔值
总计
总行数
字符串
原始总计
小计
字符串 []
vis_config
对象
可视化配置属性。这些属性通常不透明,因所用的可视化类型而异。没有已指定的一组允许的键。这些值可以是 JSON 支持的任何类型。通常具有存在字符串值的“类型”键,供 Looker 用来确定显示哪个可视化图表。可视化图表会忽略未知 vis_config 属性。
过滤条件配置
对象
filter_config 表示给定查询的探索页面上的过滤条件界面的状态。通过 Looker 界面运行查询时,此参数的优先级高于“过滤器”。创建查询或修改现有查询时,应将“filter_config”设置为 null。将其设置为任何其他值都可能会导致意外的过滤行为。该格式应视为不透明。
visible_ui_sections
字符串
可见界面部分
处理后标题
字符串
Slug
动态字段
字符串
动态字段
client_id
字符串
客户端 ID:用于生成缩短的探索网址。如果由客户端设置,则必须是唯一的 22 位字母数字字符串。否则,系统会生成一个。
分享网址
字符串
分享网址
展开网址共享网址
字符串
展开后的共享网址
网址
字符串
展开后的网址
query_timezone
字符串
查询时区
has_table_calculations
布尔值
包含表计算
runtime
数值
(已弃用)运行时(已弃用)
vis_config
对象
组成查询或合并查询的 Vis 配置。
result_maker_id
整数
ResultMakerLookup 条目的 ID。
副标题
字符串
文本图块字幕文本
title
字符串
信息中心元素的标题
title_hidden
布尔值
标题是否处于隐藏状态
标题文字
字符串
文本图块标题
类型
字符串
类型
提醒数
整数
与信息中心元素相关联的提醒数量
富媒体内容 JSON
字符串
JSON,其中包含富媒体编辑器和按钮元素所需的所有属性
title_text_as_html
字符串
文本图块标题文本(采用 HTML 格式)
subtitle_text_as_html
字符串
文本图块的副标题文本(HTML 格式)

400:错误请求

数据类型
说明
(对象)
消息
字符串
错误详情
文档网址
字符串
文档链接

404:未找到

数据类型
说明
(对象)
消息
字符串
错误详情
文档网址
字符串
文档链接