获取所有已安排的方案

版本 4.0.23.2

列出所有已安排的方案

返回属于调用方或指定用户的所有已安排的计划。

如果未提供 user_id，则此函数会返回调用方拥有的预定方案。

要列出所有用户的所有时间表，请传递 all_users=true。

调用者必须拥有 see_schedules 权限才能查看其他用户的已安排方案。

请求

获取 /scheduled_plans

数据类型

说明

请求

HTTP 请求

查询

HTTPQuery

展开 HTTPQuery 定义...

user_id

字符串

返回属于此 user_id 的预定方案。如果未提供，则返回调用方拥有的计划。

字段

字符串

以英文逗号分隔的字段名称列表。如果提供，响应中将仅包含指定的字段

all_users

布尔值

返回属于所有用户的已安排方案（调用方需要 See_schedules 权限）

响应

200：已安排的方案

数据类型

说明

（数组）

预定计划[]

name

字符串

此已安排的方案的名称

user_id

字符串

此安排的方案拥有的用户 ID

run_as_recipient

布尔值

是否以收件人身份运行时间表（仅适用于电子邮件收件人）

已启用

布尔值

是否启用了 SchedulePlan

Look_id

字符串

样式的 ID

信息中心 ID

字符串

信息中心 ID

Lookml_dashboard_id

字符串

LookML 信息中心的 ID

过滤条件_字符串

字符串

用于运行外观或信息中心的查询字符串

信息中心过滤条件

字符串

（已弃用）filter_string 字段的别名

要求结果

布尔值

如果运行信息中心或外观返回结果，则应进行传送

required_no_results

布尔值

如果信息中心外观未返回结果，则应传送消息

要求更改

布尔值

如果自上次运行后数据发生更改，则应发生传送

发送全部结果

布尔值

将运行无限制查询并发送所有结果。

Crontab

字符串

何时运行 Vixie-Style Crontab 规范

数据组

字符串

数据组的名称；如果指定，将在数据组触发时运行（不能与 Cron 字符串配合使用）

timezone

字符串

解读指定 crontab 的时区（默认为 Looker 实例时区）

查询 ID

字符串

查询 ID

已安排的计划目标

SchedulePlanDestination[]

展开 SchedulePlanDestination 定义...

字符串

唯一 ID

已安排计划的 ID

字符串

您拥有的已安排方案的 ID

格式

字符串

要发送到指定目的地的数据格式。支持的格式因目的地而异，但包括：“txt”“csv”“inline_json”“json”“json_detail”“xlsx”“html”“wysiwyg_pdf”“compiled_pdf”“wysiwyg_png”

apply_formatting

布尔值

值的格式是否正确？（包含货币符号、数字分隔符等）。

apply_vis

布尔值

是否对结果应用可视化选项。

地址

字符串

收件人地址。对于电子邮件（例如“user@example.com”）。对于网络钩子，例如“https://examle.domain/path”。对于 Amazon S3，例如“s3://bucket-name/path/”。对于 SFTP，例如“sftp://host-name/path/”。

Looker_recipient

布尔值

收件人是否为当前实例的 Looker 用户（仅适用于电子邮件收件人）

类型

字符串

地址类型（“email”、“webhook”、“s3”或“sftp”）

参数

字符串

包含外部调度参数的 JSON 对象。对于 Amazon S3，这需要 access_key_id 和区域的键和值。对于 SFTP，您需要提供用户名的键和值。

Secret_parameters

字符串

（只写）包含外部调度的 Secret 参数的 JSON 对象。对于 Amazon S3，这需要 secret_access_key 的键和值。对于 SFTP，这需要密码的密码键和值。

消息

字符串

要包含在定期发送的电子邮件中的可选消息

运行一次

布尔值

相关方案是否应该仅运行一次（通常用于测试）

添加链接

布尔值

此 SchedulePlan 中是否应包含返回 Looker 的链接

custom_url_base

字符串

预定实体的自定义网址域名

custom_url_params

字符串

已安排的实体的自定义网址路径和参数

自定义网址标签

字符串

预定实体的自定义网址标签

show_custom_url

布尔值

是否显示自定义链接，而不是标准 Looker 链接

pdf_paper_size

字符串

PDF 应采用适合页面大小的格式。有效值为“letter”、“legal”、“tabloid”、“a0”、“a1”、“a2”、“a3”、“a4”、“a5”。

pdf_landscape

布尔值

PDF 的格式是否为横向格式

嵌入

布尔值

此时间表是否位于嵌入上下文中

color_theme

字符串

信息中心的配色方案（如适用）

long_tables

布尔值

是否将表格展开至完整长度

inline_table_width

整数

渲染内嵌表可视化时的像素宽度

字符串

唯一 ID

创建时间

字符串

SchedulePlan 的创建日期和时间

更新时间

字符串

SchedulePlan 的上次更新日期和时间

title

字符串

职位

位用户

用户公开

此 SchedulePlan 的所有者

展开 UserPublic 定义...

可以

对象

当前用户可以对此对象执行的操作

字符串

唯一 ID

first_name（名字）

字符串

名字

last_name（姓氏）

字符串

姓氏

display_name

字符串

要显示的全名（仅在设置了 first_name 和 last_name 的情况下可用）

头像

字符串

头像图片的网址（可能是通用网址）

网址

字符串

用于获取此商品的链接

next_run_at [下一步运行时间]

字符串

SchedulePlan 的下一次运行时间（如果运行一次，则为 null）

上次运行时间

字符串

SchedulePlan 的上次运行时间

可以

对象

当前用户可以对此对象执行的操作

400：错误请求

数据类型

说明

（对象）

错误

消息

字符串

错误详情

文档网址

字符串

文档链接

404：未找到

数据类型

说明

（对象）

错误

消息

字符串

错误详情

文档网址

字符串

文档链接

422：验证错误

数据类型

说明

（对象）

ValidationError

消息

字符串

错误详情

错误

ValidationErrorDetail[]

展开 ValidationErrorDetail 定义...

字段

字符串

出错的字段

代码

字符串

错误代码

消息

字符串

错误信息消息

文档网址

字符串

文档链接

文档网址

字符串

文档链接

示例

获取所有已安排的方案

列出所有已安排的方案

请求

响应

200：已安排的方案

400：错误请求

404：未找到

422：验证错误

示例

Python

TypeScript

Kotlin

Swift