Criar tarefa de renderização do painel

Versão 4.0.23.6 (mais recente)

Crie uma nova tarefa para renderizar um painel para um documento ou imagem.

Retorna um objeto de tarefa de renderização. Para verificar o status de uma tarefa de renderização, transmita o render_task.id para Get Render Task. Quando a tarefa de renderização for concluída, você poderá fazer o download do documento ou da imagem resultante usando a opção Obter resultados da tarefa de renderização.

Solicitação

POSTAR /render_tasks/dashboards/{dashboard_id}/{result_format}
Tipo de dados
Descrição
Solicitação
HTTPRequest
path
HTTPPath
Expandir definição HTTPPath...
ID do painel
string
ID do painel a ser renderizado. O ID também pode ser um painel LookML.
formato_do_resultado
string
Tipo de saída: pdf, png ou jpg
body
Corpo HTTP
Expandir definição HTTPBody...
body
Parâmetros da tarefa de renderização do painel
Expandir a definição de CreateDashboardRenderTask...
painéis_filtros
string
Filtrar valores a serem aplicados às consultas do painel, no formato de consulta do URL
painel_style [estilo_do_painel]
string
Estilo do layout do painel: single_column ou em blocos
consulta
Consulta HTTP
Expandir a definição de HTTPQuery...
largura
integer
Largura da saída em pixels
altura
integer
Altura da saída em pixels
campos
string
Campos solicitados.
pdf_paper_size
string
Tamanho do papel para pdf. O valor pode ser: ["letter","legal","tabloid","a0","a1","a2","a3","a4","a5"]
pdf_paisagem
booleano
Se o PDF deve ser renderizado na orientação de papel de paisagem
long_tables
booleano
Se a visualização da tabela deve ou não ser expandida

Resposta

200: tarefa de renderização

Tipo de dados
Descrição
(objeto)
pode
objeto
Operações que o usuário atual pode realizar neste objeto
criado_em
string
A tarefa de renderização de data/hora foi criada
painéis_filtros
string
Filtrar valores a serem aplicados às consultas do painel, no formato de consulta do URL
ID do painel
string
ID do painel a ser renderizado
painel_style [estilo_do_painel]
string
Estilo do layout do painel: single_column ou em blocos
finalizado_em
string
A tarefa de renderização de data/hora foi concluída
altura
integer
Altura da saída em pixels. Os layouts corridos podem ignorar esse valor.
id
string
ID desta tarefa de renderização
look_id
string
ID da aparência a ser renderizada
lookml_dashboard_id
string
ID do painel lookml para renderizar
ID da consulta
string
ID da consulta a ser renderizada
painel_element_id [código_do_elemento_do_painel]
string
ID do elemento do painel a ser renderizado: o elemento do painel UDD seria numérico e o elemento do painel LookML seria model_name::dashboard_title::lookml_link_id
query_runtime
number
Número de segundos decorridos da execução de consultas
tempo de execução de renderização
number
Número de segundos em que os dados de renderização foram decorridos
formato_do_resultado
string
Formato de saída: pdf, png ou jpg
runtime
number
Total de segundos decorridos para a tarefa de renderização
status
string
Status da tarefa de renderização: enqueued_for_query, query, enqueued_for_render, render, success, failed
detalhe_do_status
string
Informações adicionais sobre o status atual
user_id
string
As permissões da conta de usuário em que a tarefa de renderização será executada
largura
integer
Largura da saída em pixels

400: Solicitação inválida

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

404: não encontrado

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

409: recurso já existe

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

422: erro de validação

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
Expandir a definição de ValidationErrorDetail...
campo
string
Campo com erro
código
string
Código do erro
mensagem
string
Mensagem de erro
url_da_documentação
string
Link da documentação
url_da_documentação
string
Link da documentação

429: Solicitações demais

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

Examples