Version 3.1.23.2
Erstellen Sie eine neue Aufgabe, um ein Dashboard in ein Dokument oder Bild zu rendern.
Gibt ein Rendering-Aufgabenobjekt zurück. Um den Status einer Rendering-Aufgabe zu prüfen, übergeben Sie die „render_task.id“ an die Schaltfläche Render-Aufgabe abrufen. Wenn die Renderingaufgabe abgeschlossen ist, können Sie das resultierende Dokument oder Bild mit der Funktion Ergebnisse der Render-Aufgabe abrufen herunterladen.
Anfrage
POST
/render_tasks/dashboards/{dashboard_id}/{result_format}
Datentyp
Beschreibung
Anfrage
Pfad
HTTPPath-Definition maximieren...
Dashboard-ID
ID des zu rendernden Dashboards
Ergebnisformat
Ausgabetyp: PDF, PNG oder JPG
body
HTTPBody-Definition maximieren...
body
Dashboard-Renderingaufgaben
CreateDashboardRenderTask-Definition maximieren...
Dashboard_Filter
Werte filtern, die auf Dashboard-Abfragen angewendet werden sollen, im URL-Abfrageformat
Dashboard-Stil
Dashboard-Layoutstil: Single_Column oder Tile
Abfrage
HTTPQuery-Definition maximieren...
width
Ausgabebreite in Pixeln
height
Ausgabehöhe in Pixeln
Felder
Angeforderte Felder.
PDF_papiergröße
Papierformat für PDF. Mögliche Werte sind: ["letter","legal","tabloid","a0","a1","a2","a3","a4","a5"]
PDF_Querformat
Gibt an, ob PDF-Dateien im Querformat gerendert werden sollen
Antwort
200: Aufgabe rendern
Datentyp
Beschreibung
(Objekt)
kann
lock
Vorgänge, die der aktuelle Nutzer für dieses Objekt ausführen kann
erstellt am
lock
Rendering-Aufgabe für Datum/Uhrzeit wurde erstellt
Dashboard_Filter
lock
Werte filtern, die auf Dashboard-Abfragen angewendet werden sollen, im URL-Abfrageformat
Dashboard-ID
lock
ID des zu rendernden Dashboards
Dashboard-Stil
lock
Dashboard-Layoutstil: Single_Column oder Tile
Abgeschlossen_um
lock
Rendering-Aufgabe mit Datum/Uhrzeit abgeschlossen
height
lock
Ausgabehöhe in Pixeln Bei Layout-Varianten kann dieser Wert ignoriert werden.
id
lock
ID dieser Rendering-Aufgabe
Look_ID
lock
ID des zu rendernden Looks
Lookml-Dashboard_ID
lock
ID des zu rendernden Lookml-Dashboards
Abfrage-ID
lock
ID der zu rendernden Abfrage
Dashboard_Element_ID
lock
ID des zu rendernden Dashboard-Elements: Das UDD-Dashboard-Element wäre numerisch und das LookML-Dashboard-Element wäre model_name::dashboard_title::lookml_link_id.
Abfragelaufzeit
lock
Anzahl der Sekunden, die für laufende Abfragen verstrichen sind
Renderinglaufzeit
lock
Anzahl der verstrichenen Sekunden zum Rendern von Daten
Ergebnisformat
lock
Ausgabeformat: PDF, PNG oder JPG
runtime
lock
Insgesamt verstrichene Sekunden für die Renderingaufgabe
Status
lock
Status der Renderingaufgabe: enQueued_for_query, Query, enQueued_for_render, Rendering, Erfolg, Fehler
status_detail
lock
Weitere Informationen zum aktuellen Status
user_id
lock
Die Nutzerkontoberechtigungen, in denen die Renderingaufgabe ausgeführt wird
width
lock
Ausgabebreite in Pixeln
400: Ungültige Anfrage
Datentyp
Beschreibung
(Objekt)
nachricht
lock
Fehlerdetails
Dokumentations-URL
lock
Link zur Dokumentation
404: Nicht gefunden
Datentyp
Beschreibung
(Objekt)
nachricht
lock
Fehlerdetails
Dokumentations-URL
lock
Link zur Dokumentation
409: Ressource ist bereits vorhanden
Datentyp
Beschreibung
(Objekt)
nachricht
lock
Fehlerdetails
Dokumentations-URL
lock
Link zur Dokumentation
422: Validierungsfehler
Datentyp
Beschreibung
(Objekt)
nachricht
lock
Fehlerdetails
Fehler
ValidationErrorDetail-Definition maximieren...
Feld
lock
Feld mit Fehler
Code
lock
Fehlercode
nachricht
lock
Fehlermeldung
Dokumentations-URL
lock
Link zur Dokumentation
Dokumentations-URL
lock
Link zur Dokumentation
429: Zu viele Anfragen
Datentyp
Beschreibung
(Objekt)
nachricht
lock
Fehlerdetails
Dokumentations-URL
lock
Link zur Dokumentation
Beispiele
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 |