版本 4.0.23.2
创建新任务,以将信息中心呈现到文档或图片中。
返回渲染任务对象。如需检查渲染任务的状态,请将 render_task.id 传递给获取渲染任务。 渲染任务完成后,您可以使用获取渲染任务结果下载生成的文档或图片。
请求
POST
/render_tasks/dashboards/{dashboard_id}/{result_format}
数据类型
说明
请求
路径
展开 HTTPPath 定义...
信息中心 ID
要呈现的信息中心的 ID。该 ID 也可以是 LookML 信息中心。
result_format
输出类型:pdf、png 或 jpg
body
展开 HTTPBody 定义...
body
信息中心渲染任务参数
展开 Create DashboardRenderTask 定义...
信息中心过滤条件
过滤应用于信息中心查询的值(采用网址查询格式)
信息中心样式
信息中心布局样式:单列或平铺
查询
展开 HTTPQuery 定义...
宽度
输出宽度(以像素为单位)
高度
输出高度(以像素为单位)
字段
请求的字段。
pdf_paper_size
PDF 的纸张大小。值可以是以下其中一项:["letter","legal","tabloid","a0","a1","a2","a3","a4","a5"]
pdf_landscape
是否以横向纸张模式呈现 PDF
long_tables
是否将表格展开至完整长度
响应
200:渲染任务
数据类型
说明
(对象)
可以
lock
当前用户可以对此对象执行的操作
创建时间
lock
创建日期/时间渲染任务
信息中心过滤条件
lock
过滤应用于信息中心查询的值(采用网址查询格式)
信息中心 ID
lock
要呈现的信息中心的 ID
信息中心样式
lock
信息中心布局样式:单列或平铺
最终确定
lock
完成渲染/渲染任务的日期
高度
lock
输出高度(以像素为单位)。流式布局可能会忽略此值。
id
lock
此渲染任务的 ID
Look_id
lock
要呈现的样式的 ID
Lookml_dashboard_id
lock
要呈现的 Lookml 信息中心的 ID
查询 ID
lock
要呈现的查询的 ID
信息中心_元素 ID
lock
要呈现的信息中心元素的 ID:UDD 信息中心元素将为数字,LookML 信息中心元素将为 model_name::dashboard_title::lookml_link_id
query_runtime
lock
运行查询的秒数
render_runtime
lock
呈现数据的秒数
result_format
lock
输出格式:pdf、png 或 jpg
runtime
lock
渲染任务的总时长(秒)
状态
lock
渲染任务状态:enqueued_for_query、query、enqueued_for_render、render、success、fail
status_detail [状态详情]
lock
有关当前状态的更多信息
user_id
lock
执行渲染任务的用户帐号权限
宽度
lock
输出宽度(以像素为单位)
400:错误请求
数据类型
说明
(对象)
消息
lock
错误详情
文档网址
lock
文档链接
404:未找到
数据类型
说明
(对象)
消息
lock
错误详情
文档网址
lock
文档链接
409:资源已存在
数据类型
说明
(对象)
消息
lock
错误详情
文档网址
lock
文档链接
422:验证错误
数据类型
说明
(对象)
消息
lock
错误详情
错误
展开 ValidationErrorDetail 定义...
字段
lock
出错的字段
代码
lock
错误代码
消息
lock
错误信息消息
文档网址
lock
文档链接
文档网址
lock
文档链接
429:请求数过多
数据类型
说明
(对象)
消息
lock
错误详情
文档网址
lock
文档链接
示例
Python
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/python/download_dashboard_pdf.py |
TypeScript
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/typescript/downloadDashboard.ts |