Créer une tâche de rendu du tableau de bord

Version 4.0.23.2

Créez une tâche pour afficher un tableau de bord dans un document ou une image.

Renvoie un objet de tâche de rendu. Pour vérifier l'état d'une tâche de rendu, transmettez le fichier render_task.id à Get Render Task (Obtenir la tâche de rendu). Une fois la tâche de rendu terminée, vous pouvez télécharger le document ou l'image obtenus à l'aide de l'option Afficher les résultats de la tâche de rendu.

Demande

POST /render_tasks/dashboards/{dashboard_id}/{result_format}
Type de données
Description
Demande
HTTPRequest
chemin d'accès
Chemin HTTP
Développer la définition HTTPPath...
id_tableau_de_bord
string
ID du tableau de bord à afficher. L'ID peut également être un tableau de bord LookML.
format_résultats
string
Type de sortie: pdf, png ou jpg
body
Corps HTTP
Développer la définition HTTPBody...
body
Paramètres de la tâche de rendu du tableau de bord
Développer la définition de "CreateDashboardRenderTask"...
tableaux_de_filtres
string
Filtrer les valeurs à appliquer aux requêtes du tableau de bord, au format de requête URL
tableau_de_style
string
Style de mise en page du tableau de bord: colonne unique ou en mosaïque
query
Requête HTTP
Développer la définition de la requête HTTP...
largeur
integer
Largeur de la sortie en pixels
hauteur
integer
Hauteur de la sortie (en pixels)
champs
string
Champs demandés.
Taille du papier au format PDF
string
Format de papier pour le PDF. La valeur peut être l'une des suivantes: ["letter","legal","tabloid","a0","a1","a2","a3","a4","a5"]
paysage PDF
booléen
Afficher ou non le PDF en mode paysage
tables_longues
booléen
Indique si la table doit être affichée en entier

Réponse

200: Tâche de rendu

Type de données
Description
(objet)
peut
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
créé le
string
La tâche de rendu Date/Heure a été créée
tableaux_de_filtres
string
Filtrer les valeurs à appliquer aux requêtes du tableau de bord, au format de requête URL
id_tableau_de_bord
string
ID du tableau de bord à afficher
tableau_de_style
string
Style de mise en page du tableau de bord: colonne unique ou en mosaïque
finalisé_at
string
La tâche de rendu Date/Heure est terminée
hauteur
integer
Hauteur de sortie en pixels. Les mises en page fluides peuvent ignorer cette valeur.
id
string
ID de cette tâche de rendu
id_look
string
ID du rendu à afficher
id_tableaudetableau_de_lookml
string
ID du tableau de bord lookml à afficher
id_requête
string
ID de la requête à afficher
id_élément_tableaudebord
string
ID de l'élément de tableau de bord à afficher: l'élément de tableau de bord UDD serait numérique et l'élément de tableau de bord LookML serait model_name::dashboard_title::lookml_link_id
requête_exécution
nombre
Nombre de secondes de requêtes exécutées
Rendu_exécution
nombre
Durée en secondes des données de rendu
format_résultats
string
Format de sortie: pdf, png ou jpg
runtime
nombre
Nombre total de secondes écoulées pour la tâche de rendu
état
string
État de la tâche de rendu: enqueued_for_query, requête, enqueued_for_render, rendu, réussite, échec
informations_état
string
Informations supplémentaires sur l'état actuel
user_id
string
Autorisations du compte utilisateur dans lesquelles la tâche de rendu sera exécutée
largeur
integer
Largeur de la sortie en pixels

400 Bad Request

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

404: introuvable

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

409: La ressource existe déjà

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

422: Erreur de validation

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
Développer la définition de ValidationErrorDetail...
champ
string
Champ comportant une erreur
code
string
Code d'erreur
Message
string
Message d'information sur l'erreur
documentation_url
string
Lien vers la documentation
documentation_url
string
Lien vers la documentation

429 : Too Many Requests

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

Examples