版本 4.0.23.6(最新)
搜索群组
返回符合指定搜索条件的所有组记录。
如果指定了多个搜索参数且 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”作为值。
请求
获取
/groups/search
数据类型
说明
请求
查询
展开 HTTPQuery 定义...
字段
请求的字段。
限制
要返回的结果数(与“offset”搭配使用)。
offset
在返回任何结果(使用“限制”)之前要跳过的结果数。
排序
排序依据。
过滤条件或
以布尔值 OR 表达式合并指定的搜索条件
id
匹配群组 ID。
name
匹配群组名称。
external_group_id [外部群组 ID]
匹配群组 external_group_id。
由外部管理
external_managed 匹配群组。
外部孤立
匹配群组 external_orphaned。
响应
200:群组
数据类型
说明
(数组)
可以
lock
当前用户可以对此对象执行的操作
can_add_to_content_metadata
群组可用于内容访问权限控制
包含当前用户
lock
当前登录的用户是群组成员
external_group_id [外部群组 ID]
lock
外部 ID 组(如果嵌入组)
由外部管理
lock
群组成员资格由 Looker 外部控制
id
lock
唯一 ID
include_by_default
lock
默认情况下,新用户会添加到此群组
name
群组名称
用户计数
lock
此群组中包含的用户数量
400:错误请求
数据类型
说明
(对象)
消息
lock
错误详情
文档网址
lock
文档链接
404:未找到
数据类型
说明
(对象)
消息
lock
错误详情
文档网址
lock
文档链接
示例
Python
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/python/add_users_to_group_from_csv.py |
TypeScript
https://github.com/looker-open-source/sdk-codegen/blob/main/packages/hackathon/src/models/Hacker.ts |