版本 4.0.23.2
搜索白板
如果指定了多个搜索参数且 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”作为值。
请求
获取/boards/search
数据类型
说明
请求
查询
展开 HTTPQuery 定义...
title
与图版标题一致。
创建时间
与板的创建时间戳相匹配。
first_name(名字)
创建此开发板的用户的名字。
last_name(姓氏)
创建此开发板的用户的姓氏。
字段
请求的字段。
已收藏
值为 true 时返回收藏的图板。
creator_id [创作者 ID]
在特定用户创建的开发板上进行过滤。
排序
结果排序依据的字段
page
要返回的页面。已弃用。请改用偏移。
每页
所返回页面中的商品数量。已弃用。请改用限制。
offset
返回任意一项之前要跳过的项目数量。(与限制一起使用,优先级高于 page 和 per_page)
限制
需要返回的最大项数。 (与偏移值搭配使用,并且优先级高于 page 和 per_page)
过滤条件或
以布尔值 OR 表达式合并指定的搜索条件
权限
根据权限过滤结果(显示(默认)或更新)
响应
200:开发板
数据类型
说明
(数组)
可以
lock
当前用户可以对此对象执行的操作
content_metadata_id
lock
关联的 content_metadata 记录的 ID
创建时间
lock
白板创建日期
已删除
白板删除日期
说明
白板说明
board_sections
展开 BoardSection 定义...
可以
lock
当前用户可以对此对象执行的操作
创建时间
lock
此部分的创建时间。
已删除
此部分的删除时间。
说明
对本部分内容的描述。
board_id
对主板的 ID 引用
board_items
展开 BoardItem 定义...
可以
lock
当前用户可以对此对象执行的操作
content_created_by
lock
创建此内容所基于的内容的用户名称
content_favorite_id
lock
与此内容的基础商品相关联的内容收藏 ID
content_metadata_id
lock
与此内容所依据的内容相关联的内容元数据 ID
content_updated_at
lock
此项内容所基于的内容上次更新的时间
自定义说明
用户输入的自定义说明(如果存在)
自定义商品名
用户输入的自定义标题(如果存在)
自定义网址
用户输入的自定义网址(如果有)
信息中心 ID
此内容所依据的信息中心
说明
lock
要显示的实际说明
收藏次数
lock
内容被收藏的次数(如果存在)
board_section_id
关联董事会版块
id
lock
唯一 ID
image_url
lock
要显示的实际 image_url
位置
lock
内容的容器文件夹名称
Look_id
根据此项设置
Lookml_dashboard_id
此内容的 LookML 信息中心
order
表示部分的排序顺序的任意整数
title
lock
要显示的实际标题
网址
lock
关联内容的相对网址
使用自定义说明
如果该商品与内容相关联,是否应使用该自定义说明(而不是内容说明)
use_custom_title
如果该商品与内容相关联,是否应使用该自定义标题(而不是内容标题)
使用自定义网址
如果该商品与内容相关联,是否应使用该自定义网址(而非内容网址)
观看次数
lock
内容的观看次数(如果有)
custom_image_data_base64
(只写)采用 base64 编码的图片数据
custom_image_url
lock
用户输入的自定义 image_url(如果存在)
使用自定义映像
商品是否应与内容相关联,是否应使用自定义图片(而非内容图片)
id
lock
唯一 ID
item_order [商品订单]
显示商品排序
title
行名称
更新时间
lock
此部分的最后更新时间。
id
lock
唯一 ID
section_order [版块顺序]
title
董事会标题
更新时间
lock
上次开发板更新日期
user_id
lock
董事会创建者用户 ID
主要首页
lock
面板是否为主要首页
400:错误请求
数据类型
说明
(对象)
消息
lock
错误详情
文档网址
lock
文档链接
404:未找到
数据类型
说明
(对象)
消息
lock
错误详情
文档网址
lock
文档链接